TransformGeometryCollection

A collection of transforms applied to the geometry.

Example

app = cf.GetApplication()
project = app:NewProject()

cuboid = project.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1)

    -- Use the TransformGeometryCollection to add a geometry transform

transformGeometryCollection = cuboid.Transforms
transformGeometryCollection:AddTranslate(cf.Point(0,0,0),cf.Point(1,1,1))

    -- Retrieve and delete the transform
    
transformGeometryCollection:Item(1):Delete()

Usage locations (collections)

The following objects contain the TransformGeometryCollection collection:

Property List

Count
The number of Transform items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

AddAlign (sourceorigin Coordinate, sourceuvector Coordinate, sourcevvector Coordinate, destinationorigin Coordinate, destinationuvector Coordinate, destinationvvector Coordinate)
Apply an align. (Returns a Align object.)
AddAlign (properties table)
Apply a align using a table defining the properties. (Returns a Align object.)
AddMirror (properties table)
Apply a mirror using a table defining the properties. (Returns a Mirror object.)
AddMirrorInUNPlane (origin Coordinate, rotationu Expression, rotationn Expression)
Apply a mirror around the UN Plane. (Returns a Mirror object.)
AddMirrorInUVPlane (origin Coordinate, rotationu Expression, rotationv Expression)
Apply a mirror around the UV Plane. (Returns a Mirror object.)
AddMirrorInVNPlane (origin Coordinate, rotationv Expression, rotationn Expression)
Apply a mirror around the VN Plane. (Returns a Mirror object.)
AddRotate (origin Coordinate, rotationaxis Coordinate, angle Expression)
Apply a rotation. (Returns a Rotate object.)
AddRotate (properties table)
Apply a rotation using a table defining the properties. (Returns a Rotate object.)
AddScale (origin Coordinate, factor Expression)
Apply a scale. (Returns a Scale object.)
AddScale (properties table)
Apply a scale using a table defining the properties. (Returns a Scale object.)
AddTranslate (from Coordinate, to Coordinate)
Apply a translate between the given coordinates. (Returns a Translate object.)
AddTranslate (properties table)
Apply a translate using a table defining the properties. (Returns a Translate object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the Transform at the given index. (Returns a Transform object.)
Item (label string)
Returns the Transform with the given label. (Returns a Transform object.)
Items ()
Returns a table of Transform. (Returns a List of Transform object.)
UniqueName (label string)
Generates a unique name base of 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 boolean object.)

Index List

[number]
Returns the Transform at the given index in the collection. (Read Transform)
[string]
Returns the Transform with the given name in the collection. (Read Transform)

Property Details

Count
The number of Transform items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddAlign (sourceorigin Coordinate, sourceuvector Coordinate, sourcevvector Coordinate, destinationorigin Coordinate, destinationuvector Coordinate, destinationvvector Coordinate)
Apply an align.
Input Parameters
sourceorigin(Coordinate)
Source origin coordinate.
sourceuvector(Coordinate)
Source U vector direction.
sourcevvector(Coordinate)
Source V vector direction.
destinationorigin(Coordinate)
Destination origin coordinate.
destinationuvector(Coordinate)
Destination U vector direction.
destinationvvector(Coordinate)
Destination V vector direction.
Return
Align
The align transform.
AddAlign (properties table)
Apply a align using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the align transform.
Return
Align
The align transform.
AddMirror (properties table)
Apply a mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Mirror
The mirror transform.
AddMirrorInUNPlane (origin Coordinate, rotationu Expression, rotationn Expression)
Apply a mirror around the UN Plane.
Input Parameters
origin(Coordinate)
The mirror plane origin coordinate.
rotationu(Expression)
U rotation of the mirror plane (degrees).
rotationn(Expression)
N rotation of the mirror plane (degrees).
Return
Mirror
The mirror transform.
AddMirrorInUVPlane (origin Coordinate, rotationu Expression, rotationv Expression)
Apply a mirror around the UV Plane.
Input Parameters
origin(Coordinate)
The mirror plane origin coordinate.
rotationu(Expression)
U rotation of the mirror plane (degrees).
rotationv(Expression)
V rotation of the mirror plane (degrees).
Return
Mirror
The mirror transform.
AddMirrorInVNPlane (origin Coordinate, rotationv Expression, rotationn Expression)
Apply a mirror around the VN Plane.
Input Parameters
origin(Coordinate)
The mirror plane origin coordinate.
rotationv(Expression)
V rotation of the mirror plane (degrees).
rotationn(Expression)
N rotation of the mirror plane (degrees).
Return
Mirror
The mirror transform.
AddRotate (origin Coordinate, rotationaxis Coordinate, angle Expression)
Apply a rotation.
Input Parameters
origin(Coordinate)
The coordinates of the origin of the rotation.
rotationaxis(Coordinate)
The axis of rotation.
angle(Expression)
The angle of rotation (degrees).
Return
Rotate
The rotate transform.
AddRotate (properties table)
Apply a rotation using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
Return
Rotate
The rotate transform.
AddScale (origin Coordinate, factor Expression)
Apply a scale.
Input Parameters
origin(Coordinate)
The coordinates of the origin of the scale transformation.
factor(Expression)
The factor to scale by.
Return
Scale
The scale transform.
AddScale (properties table)
Apply a scale using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the scale transform.
Return
Scale
The scale transform.
AddTranslate (from Coordinate, to Coordinate)
Apply a translate between the given coordinates.
Input Parameters
from(Coordinate)
Translate from coordinate.
to(Coordinate)
Translate to coordinate.
Return
Translate
The translate transform.
AddTranslate (properties table)
Apply a translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
Return
Translate
The translate transform.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Transform.
Return
boolean
The success of the check.
Item (index number)
Returns the Transform at the given index.
Input Parameters
index(number)
The index of the Transform.
Return
Transform
The Transform at the given index.
Item (label string)
Returns the Transform with the given label.
Input Parameters
label(string)
The label of the Transform.
Return
Transform
The Transform with the given label.
Items ()
Returns a table of Transform.
Return
List of Transform
A table of Transform.
UniqueName (label string)
Generates a unique name base of 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
boolean
The generated unique name label for Transform.