`Translate`

A translate transform.

Example

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

    -- Use 'Point' to translate a cone

cone = project.Geometry:AddCone(cf.Point(0, 0, 0), 1, 0.2, 1)
translate1 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 0, 0))
translate2 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 0, 1))
translate3 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 2, 1))

    -- Remove the first translate
    
translate1:Delete()

Inheritance

The Translate object is derived from the Transform object.

Property List

From: The translate transform start coordinates. (Read/Write LocalCoordinates)
LocalWorkplane: The translate workplane. (Read only LocalWorkplane)
To: The translate transform end coordinates. (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

From

The translate transform start coordinates.

Type: LocalCoordinates
Access: Read/Write

LocalWorkplane

The translate workplane.

Type: LocalWorkplane
Access: Read only

To

The translate transform end coordinates.

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.