Workplane
A workplane.
Example
app = cf.GetApplication() project = app:NewProject() -- Add a new workplane definition to the project wp = project.Workplanes:Add(cf.Point(1, 1, 1), cf.Point(0, -1, -1), cf.Point(1, 1, 0))
Usage locations (object properties)
The following objects have properties using the Workplane object:
Property List
- Label
- The object label. (Read/Write string)
- Origin
- The workplane origin. (Read/Write GlobalCoordinates)
- Type
- The object type string. (Read only string)
- UVector
- The workplane U vector orientation. (Read/Write GlobalCoordinates)
- VVector
- The workplane V vector orientation. (Read/Write GlobalCoordinates)
Method List
- Delete ()
- Delete the workplane.
- Duplicate ()
- Duplicates the workplane. (Returns a Workplane 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.)
- SetAsDefault ()
- Set the workplane as the default.
- SetProperties (properties table)
- 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
- Origin
- The workplane origin.
- Type
- GlobalCoordinates
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- UVector
- The workplane U vector orientation.
- Type
- GlobalCoordinates
- Access
- Read/Write
- VVector
- The workplane V vector orientation.
- Type
- GlobalCoordinates
- Access
- Read/Write
Method Details
- Delete ()
- Delete the workplane.
- Duplicate ()
- Duplicates the workplane.
- Return
- Workplane
- The duplicated workplane.
- 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 properties table.
- SetAsDefault ()
- Set the workplane as the default.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.