WorkSurfaceCollection

A collection of work surfaces in the model.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
cylinder = project.Contents.Geometry:AddCylinder(cf.Cylinder.GetDefaultProperties())

    -- Add work surfaces around the cylinder at three intervals

project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 0)
project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 0.5)
project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 1)

    -- Remove the first work surface from the collection of work surfaces

project.Definitions.WorkSurfaces[1]:Delete()

Inheritance

The WorkSurfaceCollection object is derived from the Object object.

Usage locations

The WorkSurfaceCollection object can be accessed from the following locations:

Property List

Count
The number of WorkSurface items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Add (properties table)
Create a work surface using the table of properties. (Returns a WorkSurface object.)
Add (referenceface Face, offset Expression)
Create a work surface with the specified face. (Returns a WorkSurface object.)
Add (label string, referenceface Face, offset Expression)
Create a work surface with the specified label. (Returns a WorkSurface object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number)
Returns the WorkSurface for the given index in the collection. (Returns a WorkSurface object.)
Item (label string)
Returns the WorkSurface for the given label in the collection. (Returns a WorkSurface object.)
Items ()
Returns a table of WorkSurface items. (Returns a UnsupportedType(List of WorkSurface) 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.
UniqueName (label string)
Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)

Static Function List

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

Property Details

Count
The number of WorkSurface items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (properties table)
Create a work surface using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
WorkSurface
The work surface.
Add (referenceface Face, offset Expression)
Create a work surface with the specified face.
Input Parameters
referenceface(Face)
The reference face to use.
offset(Expression)
The offset from the reference face.
Return
WorkSurface
The work surface.
Add (label string, referenceface Face, offset Expression)
Create a work surface with the specified label.
Input Parameters
label(string)
The label for the work surface.
referenceface(Face)
The reference face to use.
offset(Expression)
The offset from the reference face.
Return
WorkSurface
The work surface.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the item.
Return
boolean
The success of the check.
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.
Item (index number)
Returns the WorkSurface for the given index in the collection.
Input Parameters
index(number)
The index of the WorkSurface.
Return
WorkSurface
The item in the collection
Item (label string)
Returns the WorkSurface for the given label in the collection.
Input Parameters
label(string)
The label of the WorkSurface.
Return
WorkSurface
The item in the collection
Items ()
Returns a table of WorkSurface items.
Return
UnsupportedType(List of WorkSurface)
The list of items in the collection
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.
UniqueName (label string)
Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
string
The generated unique name label for the item.

Static Function Details

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