`Rotate`

A rotate transform.

Example

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

    -- Create a flare to rotate
    
flare = project.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5)

    -- Set up the origin and axis of rotation

rotationOrigin = cf.Point(3, 1, 1)
rotationAxis = cf.Point(1, 2, 0)

    -- Rotate the flare by 25 degrees

rotate = flare.Transforms:AddRotate(rotationOrigin, rotationAxis, 25)

    -- Modify the rotation angle
    
rotate.Angle = 65

Inheritance

The Rotate object is derived from the Transform object.

Property List

Angle: The rotation angle (degrees). (Read/Write Expression)
Axis: The axis of rotation. (Read/Write LocalCoordinates)
LocalWorkplane: The rotation transformation workplane. (Read only LocalWorkplane)
Origin: The coordinates of the origin of the rotation. (Read/Write LocalCoordinates)
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

Angle

The rotation angle (degrees).

Type: Expression
Access: Read/Write

Axis

The axis of rotation.

Type: LocalCoordinates
Access: Read/Write

LocalWorkplane

The rotation transformation workplane.

Type: LocalWorkplane
Access: Read only

Origin

The coordinates of the origin of the rotation.

Type: LocalCoordinates
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.