`class` Transform3

Transform3 handles homogeneous 4x4 transforms, i.e. transformations which can be represented by multiplying a 4x4 matrix with a homogeneous 3D coordinate. Transform3 can either pre-multiply a matrix onto the transformation, which will add a transform around the current transform, or it can post-multiply the matrix, which will add a transform inside the current transform. Post-multiply is the default mode.

Properties

Property	Description
Name	The name of the Transform3 object. (Inherited from Object)

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AddRotation	Concatenates a rotation transform to the current transform.
AddScaling	Concatenates a scaling transform to the current transform.
AddTransformation	Concatenates a generic transform to the current transform.
AddTranslation	Concatenates a translation transform to the current transform.
Clear	Resets the transformation to the identity transform, resets the multiplication mode to PostMultiply, and clears the matrix stack.
GetClass	Get the name of the Transform3 class. (Inherited from Object)
GetMatrix	The matrix that is used to specify the transform.
GetStack	The real array that is used to store the matrix stack.
IsA	Returns true if Transform3 is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the Transform3 object is invalid. (Inherited from Object)
IsPostMultiply	The transform concatenation mode.
IsPreMultiply	The transform concatenation mode.
IsSameObjectAs	Returns true if the Transform3 object is valid. (Inherited from Object)
NonNull	Returns true if the Transform3 object is valid. (Inherited from Object)
Pop	Pops the topmost matrix on the the matrix stack, and replaces the current transform with the popped matrix.
PostMultiply	The transform concatenation mode to post-multiply, any added transform will be concatenated using this mode.
PreMultiply	The transform concatenation mode to pre-multiply, any added transform will be concatenated using this mode.
PrintInfo	Prints the content/info of the Transform3 object to the log. (Inherited from Object)
Push	Pushes the current transform onto the matrix stack.
RemoveObserver	Removes a previously added observer object. (Inherited from Object)

Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spTransform3, and if this is the case, returns the object cast into spTransform3. (Inherited from Object)

Properties details

Name

The name of the Transform3 object. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

AddRotation

Concatenates a rotation transform to the current transform.

Type	Name	Description
`real`	angle	The rotation angle around the axis.
`real`	rx	The x axis rotation component.
`real`	ry	The y axis rotation component.
`real`	rz	The z axis rotation component.

Type	Name	Description
`float`	angle	The rotation angle around the axis.
`float`	rx	The x axis rotation component.
`float`	ry	The y axis rotation component.
`float`	rz	The z axis rotation component.

Name	Type	Description
angle	`float`	The rotation angle around the axis.
rx	`float`	The x axis rotation component.
ry	`float`	The y axis rotation component.
rz	`float`	The z axis rotation component.

AddScaling

Concatenates a scaling transform to the current transform.

Type	Name	Description
`real`	sx	The scaling vector x axis component.
`real`	sy	The scaling vector y axis component.
`real`	sz	The scaling vector z axis component.

Type	Name	Description
`float`	sx	The scaling vector x axis component.
`float`	sy	The scaling vector y axis component.
`float`	sz	The scaling vector z axis component.

Name	Type	Description
sx	`float`	The scaling vector x axis component.
sy	`float`	The scaling vector y axis component.
sz	`float`	The scaling vector z axis component.

AddTransformation

Concatenates a generic transform to the current transform.

Type	Name	Min	Max	Description
Matrix4x4	transform			The input transform matrix.

Type	Name	Min	Max	Description
Matrix4x4	transform			The input transform matrix.

Name	Type	Min	Max	Description
transform	Matrix4x4			The input transform matrix.

AddTranslation

Concatenates a translation transform to the current transform.

Type	Name	Description
`real`	tx	The translation vector x component.
`real`	ty	The translation vector y component.
`real`	tz	The translation vector z component.

Type	Name	Description
`float`	tx	The translation vector x component.
`float`	ty	The translation vector y component.
`float`	tz	The translation vector z component.

Name	Type	Description
tx	`float`	The translation vector x component.
ty	`float`	The translation vector y component.
tz	`float`	The translation vector z component.

Clear

Resets the transformation to the identity transform, resets the multiplication mode to PostMultiply, and clears the matrix stack.

GetClass

Get the name of the Transform3 class. (Inherited from Object)

GetMatrix

The matrix that is used to specify the transform.

GetStack

The real array that is used to store the matrix stack.

IsA

Returns true if Transform3 is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if Transform3 is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if Transform3 is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if Transform3 is, or is a descendant of.

IsNull

Returns true if the Transform3 object is invalid. (Inherited from Object)

IsPostMultiply

The transform concatenation mode.

IsPreMultiply

The transform concatenation mode.

IsSameObjectAs

Returns true if the Transform3 object is valid. (Inherited from Object)

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Name	Type	Min	Max	Description
object	Object			Object to compare with.

NonNull

Returns true if the Transform3 object is valid. (Inherited from Object)

Pop

Pops the topmost matrix on the the matrix stack, and replaces the current transform with the popped matrix.

PostMultiply

The transform concatenation mode to post-multiply, any added transform will be concatenated using this mode.

PreMultiply

The transform concatenation mode to pre-multiply, any added transform will be concatenated using this mode.

PrintInfo

Prints the content/info of the Transform3 object to the log. (Inherited from Object)

Push

Pushes the current transform onto the matrix stack.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Name	Type	Min	Max	Description
observerId	`int`			ObserverId is the id returned by AddObserver when the observer was added.

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spTransform3, and if this is the case, returns the object cast into spTransform3. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class Transform3 ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

Methods details ​

AddObserver ​

AddRotation ​

AddScaling ​

AddTransformation ​

AddTranslation ​

Clear ​

GetClass ​

GetMatrix ​

GetStack ​

IsA ​

IsNull ​