`Workplane`

A workplane.

Example

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

    -- Add a new workplane definition to the project

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

Inheritance

The Workplane object is derived from the Object object.

Usage locations

The Workplane object can be accessed from the following locations:

Properties
- MeshTetrahedronRegion object has property ReferenceWorkplane.
- Region object has property ReferenceWorkplane.
- UnprotectedInformation object has property OrientationWorkplane.
- LocalWorkplane object has property ReferencedWorkplane.
Methods
- WorkplaneCollection collection has method Add(table).
- WorkplaneCollection collection has method Add(Point, Point, Point).
- WorkplaneCollection collection has method Add(string, Point, Point, Point).
- WorkplaneCollection collection has method Item(number).
- WorkplaneCollection collection has method Item(string).

Property List

Label: The object label. (Read/Write string)
LocalWorkplane: The source workplane. (Read/Write LocalWorkplane)
Origin: The workplane origin. (Read only Point)
Type: The object type string. (Read only string)
UVector: The workplane U vector orientation. (Read only Vector)
VVector: The workplane V vector orientation. (Read only Vector)

Collection List

Transforms: The collection of transforms on the operator. (TransformCollection of Transform.)

Method List

CopyAndMirror (properties table): Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number): Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number): Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number): Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number): Copy and translate the geometry. (Returns a List of Object 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.)
SetAsDefault (): Set the workplane as the default.
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

LocalWorkplane

The source workplane.

Type: LocalWorkplane
Access: Read/Write

Origin

The workplane origin.

Type: Point
Access: Read only

Type

The object type string.

Type: string
Access: Read only

UVector

The workplane U vector orientation.

Type: Vector
Access: Read only

VVector

The workplane V vector orientation.

Type: Vector
Access: Read only

Collection Details

Transforms

The collection of transforms on the operator.

Type: TransformCollection

Method Details

CopyAndMirror (properties table)

Apply a copy and mirror using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the mirror transform.

Return

Object: The mirrored geometry.

CopyAndRotate (properties table, count number)

Apply a copy and rotate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the rotate transform.
count(number): The number of transform copies.

Return

List of Object: The list of rotated geometry.

CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)

Copy and rotate the geometry.

Input Parameters

origin(Point): The coordinates of the origin of the rotation.
rotationaxis(Vector): The axis of rotation.
angle(number): The angle of rotation (degrees).
count(number): The number of copies.

Return

List of Object: The list of rotated geometry.

CopyAndTranslate (properties table, count number)

Apply a copy and translate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the translate transform.
count(number): The number of transform copies.

Return

List of Object: The list of translated geometry.

CopyAndTranslate (from Point, to Point, count number)

Copy and translate the geometry.

Input Parameters

from(Point): Translate from coordinate.
to(Point): Translate to coordinate.
count(number): The number of copies.

Return

List of Object: The list of translated geometry.

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.

SetAsDefault ()

Set the workplane as the default.

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.