`class` Matrix4x4

Matrix4x4 is used to represent and manipulate 4x4 transformation matrices, which can be either standard matrices, or homogeneous 4x4 matrices used to transform 3D homogeneous coordinates [x y z w]. The transformations are defined in row-major order.

Properties

Property	Description
Name	The name of the Matrix4x4 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)
DeepCopy	Copies the contents of an input matrix to the current matrix.
Determinant3x3	Returns the top 3x3 determinant.
Direction3ArrayMultiply	Multiply in-place an array with 3D direction vectors [x y z 0].
GetClass	Get the name of the Matrix4x4 class. (Inherited from Object)
GetElement	Get a matrix element.
GetElements	The elements of the matrix.
Identity	Set the matrix to the identity matrix.
Invert	Invert the current matrix.
IsA	Returns true if Matrix4x4 is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the Matrix4x4 object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the Matrix4x4 object is valid. (Inherited from Object)
NonNull	Returns true if the Matrix4x4 object is valid. (Inherited from Object)
Point3ArrayMultiply	Multiply in-place an array with 3D points [x y z 1].
PrintInfo	Prints the content/info of the Matrix4x4 object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetElement	Set a matrix element.
SetElements	Set matrix elements.
SetToInvert	The matrix to the invert of the input matrix.
SetToRotationTransform	Creates a 3D rotation in a homogeneous transformation 4x4 matrix around the specified axis.
SetToScalingTransform	Creates a 3D scaling in a homogeneous transformation 4x4 matrix.
SetToTranslationTransform	Creates a 3D translation in a homogeneous 4x4 matrix.
SetToTranspose	The matrix to the transpose of the input matrix.
Transpose	Transpose the current matrix.
Vector4ArrayMultiply	Multiply in-place an array with full 4D vectors [x y z w].
Zero	Set the matrix to the zero matrix (all zeros).

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 spMatrix4x4, and if this is the case, returns the object cast into spMatrix4x4. (Inherited from Object)

Properties details

Name

The name of the Matrix4x4 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.

DeepCopy

Copies the contents of an input matrix to the current matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The source matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The source matrix.

Name	Type	Min	Max	Description
mtxin	Matrix4x4			The source matrix.

Determinant3x3

Returns the top 3x3 determinant.

Direction3ArrayMultiply

Multiply in-place an array with 3D direction vectors [x y z 0].

Type	Name	Min	Max	Description
RealArray	vecarray			The vectors to be multiplied and written to.

Type	Name	Min	Max	Description
RealArray	vecarray			The vectors to be multiplied and written to.

Name	Type	Min	Max	Description
vecarray	RealArray			The vectors to be multiplied and written to.

GetClass

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

GetElement

Get a matrix element.

Type	Name	Min	Max	Description
`unsigned int`	column			The column index.
`unsigned int`	row			The row index.

Type	Name	Min	Max	Description
`uint`	column			The column index.
`uint`	row			The row index.

Name	Type	Min	Max	Description
column	`int`			The column index.
row	`int`			The row index.

GetElements

The elements of the matrix.

Identity

Set the matrix to the identity matrix.

Invert

Invert the current matrix.

IsA

Returns true if Matrix4x4 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 Matrix4x4 is, or is a descendant of.

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

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

IsNull

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

IsSameObjectAs

Returns true if the Matrix4x4 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 Matrix4x4 object is valid. (Inherited from Object)

Point3ArrayMultiply

Multiply in-place an array with 3D points [x y z 1].

Type	Name	Min	Max	Description
RealArray	vecarray			The vectors to be multiplied and written to.

Type	Name	Min	Max	Description
RealArray	vecarray			The vectors to be multiplied and written to.

Name	Type	Min	Max	Description
vecarray	RealArray			The vectors to be multiplied and written to.

PrintInfo

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

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.

SetElement

Set a matrix element.

Type	Name	Description
`unsigned int`	column	The column index.
`unsigned int`	row	The row index.
`real`	value	The value to which the element will be set.

Type	Name	Description
`uint`	column	The column index.
`uint`	row	The row index.
`float`	value	The value to which the element will be set.

Name	Type	Description
column	`int`	The column index.
row	`int`	The row index.
value	`float`	The value to which the element will be set.

SetElements

Set matrix elements.

Type	Name	Description
`RealData`	source_data	The source array.
`unsigned int`	start_index	The index to start from.
`unsigned int`	items_to_copy_count	The number of items to copy.

Type	Name	Description
`float[]`	source_data	The source array.
`uint`	start_index	The index to start from.
`uint`	items_to_copy_count	The number of items to copy.

Name	Type	Description
source_data	`float`	The source array.
start_index	`int`	The index to start from.
items_to_copy_count	`int`	The number of items to copy.

SetToInvert

The matrix to the invert of the input matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The input matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The input matrix.

Name	Type	Min	Max	Description
mtxin	Matrix4x4			The input matrix.

SetToRotationTransform

Creates a 3D rotation in a homogeneous transformation 4x4 matrix around the specified axis.

Type	Name	Description
`real`	angle	The angle.
`real`	ax	The x component of the rotation axis.
`real`	ay	The y component of the rotation axis.
`real`	az	The z component of the rotation axis.

Type	Name	Description
`float`	angle	The angle.
`float`	ax	The x component of the rotation axis.
`float`	ay	The y component of the rotation axis.
`float`	az	The z component of the rotation axis.

Name	Type	Description
angle	`float`	The angle.
ax	`float`	The x component of the rotation axis.
ay	`float`	The y component of the rotation axis.
az	`float`	The z component of the rotation axis.

SetToScalingTransform

Creates a 3D scaling in a homogeneous transformation 4x4 matrix.

Type	Name	Description
`real`	sx	The x component of the scaling.
`real`	sy	The y component of the scaling.
`real`	sz	The z component of the scaling.

Type	Name	Description
`float`	sx	The x component of the scaling.
`float`	sy	The y component of the scaling.
`float`	sz	The z component of the scaling.

Name	Type	Description
sx	`float`	The x component of the scaling.
sy	`float`	The y component of the scaling.
sz	`float`	The z component of the scaling.

SetToTranslationTransform

Creates a 3D translation in a homogeneous 4x4 matrix.

Type	Name	Description
`real`	tx	The x component of the scaling.
`real`	ty	The y component of the scaling.
`real`	tz	The z component of the scaling.

Type	Name	Description
`float`	tx	The x component of the scaling.
`float`	ty	The y component of the scaling.
`float`	tz	The z component of the scaling.

Name	Type	Description
tx	`float`	The x component of the scaling.
ty	`float`	The y component of the scaling.
tz	`float`	The z component of the scaling.

SetToTranspose

The matrix to the transpose of the input matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The input matrix.

Type	Name	Min	Max	Description
Matrix4x4	mtxin			The input matrix.

Transpose

Transpose the current matrix.

Vector4ArrayMultiply

Multiply in-place an array with full 4D vectors [x y z w].

Zero

Set the matrix to the zero matrix (all zeros).

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)

SafeCast

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

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class Matrix4x4 ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

Methods details ​

AddObserver ​

DeepCopy ​

Determinant3x3 ​

Direction3ArrayMultiply ​

GetClass ​

GetElement ​

GetElements ​

Identity ​

Invert ​

IsA ​

IsNull ​