`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:

Collection lists
- ModelDefinitions object has collection WorkSurfaces.

Property List

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.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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

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.

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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.