`Scale`

A scale transform.

Example

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

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

    -- Scale the flare by a factor of 2.5 at the origin

scale = flare.Transforms:AddScale(cf.Point(0, 0, 0), 2.5)

    -- Modify the scale factor
    
scale.ScaleFactor = 1.75

Inheritance

The Scale object is derived from the Transform object.

Property List

Origin: The coordinates of the origin of the scale transform. (Read/Write GlobalCoordinates)
ScaleFactor: The factor to scale by. (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

Origin

The coordinates of the origin of the scale transform.

Type: GlobalCoordinates
Access: Read/Write

ScaleFactor

The factor to scale by.

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.