Align
An align transform.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Create a flare to align flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5) -- Create variables to define the source workplane srcOrigin = cf.Point(0, 0, 0) srcUVec = cf.Point(1, 0, 0) srcVVec = cf.Point(0, 1, 0) -- Create variables to define the destination workplane destOrigin = cf.Point(0, 0, 2) destUVec = cf.Point(0, 0, 1) destVVec = cf.Point(-1, -1, 0) -- Align the flare alignOne = flare.Transforms:AddAlign(destOrigin, destUVec, destVVec, srcOrigin, srcUVec, srcVVec) alignTwo = flare.Transforms:AddAlign(srcOrigin, srcUVec, srcVVec, destOrigin, destUVec, destVVec) -- Remove the first align transform alignOne:Delete()
Inheritance
Usage locations
The Align object can be accessed from the following locations:
Property List
- DestinationWorkplane
- The destination workplane. (Read/Write LocalWorkplane)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- SourceWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- Type
- The object type string. (Read only string)
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 List of 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.)
- 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
- DestinationWorkplane
- The destination workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- SourceWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- 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.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the 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.
- 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.