Mirror

The mirror transform.

Example

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

    -- Create a flare to mirror
    
flare = project.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.

Property List

LocalWorkplane
The mirror transform workplane. (Read only LocalWorkplane)
Origin
The coordinates of the origin of the mirror plane. (Read/Write LocalCoordinates)
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 Expression)
RotationU
The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. (Read/Write Expression)
RotationV
The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. (Read/Write Expression)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the transform.
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 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

LocalWorkplane
The mirror transform workplane.
Type
LocalWorkplane
Access
Read only
Origin
The coordinates of the origin of the mirror plane.
Type
LocalCoordinates
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
Expression
Access
Read/Write
RotationU
The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN.
Type
Expression
Access
Read/Write
RotationV
The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN.
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the transform.
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.
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.