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.
See also: Matrix4x4
Methods
Method | Description |
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. |
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. |
IsNull | Returns true if the Transform3 object is invalid. |
IsPostMultiply | The transform concatenation mode. |
IsPreMultiply | The transform concatenation mode. |
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. |
Push | Pushes the current transform onto the matrix stack. |
Static methods
Method | Description |
IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. |
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. |
Methods details
AddRotation
Concatenates a rotation transform to the current transform.
Syntax
Parameters
Type | Name | Min | Max | 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. |
Syntax
Parameters
Type | Name | Min | Max | 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. |
Syntax
Parameters
Name | Type | Min | Max | 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.
Syntax
Parameters
Type | Name | Min | Max | 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. |
Syntax
Parameters
Type | Name | Min | Max | 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. |
Syntax
Parameters
Name | Type | Min | Max | 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. |
Concatenates a generic transform to the current transform.
Syntax
Parameters
Type | Name | Min | Max | Description |
Matrix4x4 | transform | | | The input transform matrix. |
Syntax
Parameters
Type | Name | Min | Max | Description |
Matrix4x4 | transform | | | The input transform matrix. |
Syntax
Parameters
Name | Type | Min | Max | Description |
transform | Matrix4x4 | | | The input transform matrix. |
AddTranslation
Concatenates a translation transform to the current transform.
Syntax
Parameters
Type | Name | Min | Max | Description |
real | tx | | | The translation vector x component. |
real | ty | | | The translation vector y component. |
real | tz | | | The translation vector z component. |
Syntax
Parameters
Type | Name | Min | Max | Description |
float | tx | | | The translation vector x component. |
float | ty | | | The translation vector y component. |
float | tz | | | The translation vector z component. |
Syntax
Parameters
Name | Type | Min | Max | 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.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the Transform3 class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetMatrix
The matrix that is used to specify the transform.
Syntax
Parameters
GetMatrix takes no parameters.
Return value
Type: Matrix4x4
Syntax
Parameters
GetMatrix takes no parameters.
Return value
Type: Matrix4x4
Syntax
Parameters
GetMatrix takes no parameters.
Return value
Type: Matrix4x4
GetStack
The real array that is used to store the matrix stack.
Syntax
Parameters
GetStack takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetStack takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetStack takes no parameters.
Return value
Type: RealArray
IsA
Returns true if Transform3 is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if Transform3 is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if Transform3 is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
type | str | | | Name of the class to check if Transform3 is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the Transform3 object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsPostMultiply
The transform concatenation mode.
Syntax
Parameters
IsPostMultiply takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsPostMultiply takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsPostMultiply takes no parameters.
Return value
Type: bool
IsPreMultiply
The transform concatenation mode.
Syntax
Parameters
IsPreMultiply takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsPreMultiply takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsPreMultiply takes no parameters.
Return value
Type: bool
Pop
Pops the topmost matrix on the the matrix stack, and replaces the current transform with the popped matrix.
Syntax
Parameters
Pop takes no parameters.
Syntax
Parameters
Pop takes no parameters.
Syntax
Parameters
Pop takes no parameters.
PostMultiply
The transform concatenation mode to post-multiply, any added transform will be concatenated using this mode.
Syntax
Parameters
PostMultiply takes no parameters.
Syntax
Parameters
PostMultiply takes no parameters.
Syntax
Parameters
PostMultiply takes no parameters.
PreMultiply
The transform concatenation mode to pre-multiply, any added transform will be concatenated using this mode.
Syntax
Parameters
PreMultiply takes no parameters.
Syntax
Parameters
PreMultiply takes no parameters.
Syntax
Parameters
PreMultiply takes no parameters.
Push
Pushes the current transform onto the matrix stack.
Syntax
Parameters
Push takes no parameters.
Syntax
Parameters
Push takes no parameters.
Syntax
Parameters
Push takes no parameters.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: Transform3
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: Transform3
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: Transform3