`WorkplaneCollection`

A collection of workplanes in the model.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Add two saved workplanes to the collection

wp1 = project.Definitions.Workplanes:Add(cf.Point(1, 1, 1), cf.Point(1, 0, 0), cf.Point(0, 0, 1))
wp2 = project.Definitions.Workplanes:Add(cf.Point(0, 0, -1), cf.Point(0, 1, 0), cf.Point(0, 0, 1))

    -- Get the current default workplane

wpDefault = project.Definitions.Workplanes.DefaultWorkplane

Inheritance

The WorkplaneCollection object is derived from the Object object.

Usage locations

The WorkplaneCollection object can be accessed from the following locations:

Collection lists
- ModelDefinitions object has collection Workplanes.

Property List

Count: The number of Workplane 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 workplane using a table of properties. (Returns a Workplane object.)
Add (origin Point, uvector Point, vvector Point): Create a workplane with the given parameters. (Returns a Workplane object.)
Add (label string, origin Point, uvector Point, vvector Point): Create a workplane with the given parameters. (Returns a Workplane 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 Workplane for the given index in the collection. (Returns a Workplane object.)
Item (label string): Returns the Workplane for the given label in the collection. (Returns a Workplane object.)
Items (): Returns a table of Workplane items. (Returns a UnsupportedType(List of Workplane) 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 Workplane 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 workplane using a table of properties.

Input Parameters

properties(table): The table of properties defining the workplane.

Return

Workplane: The new workplane.

Add (origin Point, uvector Point, vvector Point)

Create a workplane with the given parameters.

Input Parameters

origin(Point): Origin coordinate.
uvector(Point): U vector coordinate.
vvector(Point): V vector coordinate.

Return

Workplane: The workplane.

Add (label string, origin Point, uvector Point, vvector Point)

Create a workplane with the given parameters.

Input Parameters

label(string): The label for the workplane.
origin(Point): Origin coordinate.
uvector(Point): U vector direction.
vvector(Point): V vector direction.

Return

Workplane: The workplane.

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 Workplane for the given index in the collection.

Input Parameters

index(number): The index of the Workplane.

Return

Workplane: The item in the collection

Item (label string)

Returns the Workplane for the given label in the collection.

Input Parameters

label(string): The label of the Workplane.

Return

Workplane: The item in the collection

Items ()

Returns a table of Workplane items.

Return

UnsupportedType(List of Workplane): 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.