WorkSurface

A work surface.

Example

app = cf.GetApplication()
project = app:NewProject()
paraboloid = project.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties())

    -- Add a work surface onto the paraboloid face

workSurface = project.WorkSurfaces:Add(paraboloid.Faces["Face1"], 0)

    -- Move the work surface 1m below the paraboloid face

workSurface:Modify(paraboloid.Faces["Face1"], -1)

Usage locations (object properties)

The following objects have properties using the WorkSurface object:

Property List

Label
The object label. (Read/Write string)
MaxU
The maximum U' coordinate of the work surface. (Read only number)
MaxV
The maximum V' coordinate of the work surface. (Read only number)
MinU
The minimum U' coordinate of the work surface. (Read only number)
MinV
The minimum V' coordinate of the work surface. (Read only number)
Offset
The offset expression of the work surface from the reference face. (Read only string)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the work surface.
Modify (referenceface Face, offset Expression)
Modify the work surface to reference the given face with the given offset.

Property Details

Label
The object label.
Type
string
Access
Read/Write
MaxU
The maximum U' coordinate of the work surface.
Type
number
Access
Read only
MaxV
The maximum V' coordinate of the work surface.
Type
number
Access
Read only
MinU
The minimum U' coordinate of the work surface.
Type
number
Access
Read only
MinV
The minimum V' coordinate of the work surface.
Type
number
Access
Read only
Offset
The offset expression of the work surface from the reference face.
Type
string
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the work surface.
Modify (referenceface Face, offset Expression)
Modify the work surface to reference the given face with the given offset.
Input Parameters
referenceface(Face)
The reference face to use.
offset(Expression)
The offset from the reference face.