WorkSurface

A work surface.

Example

application = cf.Application.getInstance()
project = application:NewProject()
paraboloid = project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties())

    -- Add a work surface onto the paraboloid face

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

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

workSurface.Offset = -1

Inheritance

The WorkSurface object is derived from the Object object.

Usage locations

The WorkSurface object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
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/Write ParametricExpression)
ReferenceFace
The face that the work surface references. (Read/Write Face)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
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
ParametricExpression
Access
Read/Write
ReferenceFace
The face that the work surface references.
Type
Face
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.