CutplaneCollection

A collection of cutplanes.

Example

    -- Script recorded on Tue 13. Nov 16:17:10 2018
application = cf.Application.GetInstance()
project = application:NewProject()

    -- Add
properties = cf.Cutplane.GetDefaultProperties()
properties.Label = "Cutplane1"
cutplane1 = project.Contents.Cutplanes:Add(properties)

Inheritance

The CutplaneCollection object is derived from the Object object.

Usage locations

The CutplaneCollection object can be accessed from the following locations:

Property List

Count
The number of Cutplane 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 Cutplane 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 Cutplane for the given index in the collection. (Returns a Cutplane object.)
Item (label string)
Returns the Cutplane for the given label in the collection. (Returns a Cutplane object.)
Items ()
Returns a table of Cutplane items. (Returns a UnsupportedType(List of Cutplane) 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 Cutplane 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
Cutplane
The new cutplane.
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 Cutplane for the given index in the collection.
Input Parameters
index(number)
The index of the Cutplane.
Return
Cutplane
The item in the collection
Item (label string)
Returns the Cutplane for the given label in the collection.
Input Parameters
label(string)
The label of the Cutplane.
Return
Cutplane
The item in the collection
Items ()
Returns a table of Cutplane items.
Return
UnsupportedType(List of Cutplane)
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.