Mirror

The mirror transform.

Example

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

    -- Create a flare to mirror

flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5)

    -- Mirror the flare in the UV plane with a 10 degree U plane rotation

mirrorUV = flare.Transforms:AddMirrorInUVPlane(cf.Point(0, 0, 1.2), 10, 0)

    -- Modify the mirror transform

mirrorUV.Plane = cf.Enums.MirrorPlaneEnum.UN
mirrorUV.RotationN = 15

Inheritance

The Mirror object is derived from the Transform object.

Usage locations

The Mirror object can be accessed from the following locations:

  • Methods

Property List

Label
The object label. (Read/Write string)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
Origin
The coordinates of the origin of the mirror plane. (Read/Write LocalCoordinate)
Plane
The mirror plane specified by the MirrorPlaneEnum, e.g. UV or VN or UN. (Read/Write MirrorPlaneEnum)
RotationN
The mirror plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN. (Read/Write ParametricExpression)
RotationU
The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. (Read/Write ParametricExpression)
RotationV
The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. (Read/Write ParametricExpression)
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

Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
Origin
The coordinates of the origin of the mirror plane.
Type
LocalCoordinate
Access
Read/Write
Plane
The mirror plane specified by the MirrorPlaneEnum, e.g. UV or VN or UN.
Type
MirrorPlaneEnum
Access
Read/Write
RotationN
The mirror plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN.
Type
ParametricExpression
Access
Read/Write
RotationU
The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN.
Type
ParametricExpression
Access
Read/Write
RotationV
The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN.
Type
ParametricExpression
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.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
List of 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.
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.