Mat4 Class

Extends ValueType

Module: cc

Representation of 4*4 matrix.

Index

Methods

• constructor Constructor
• clone clone a Mat4 object
• set Sets the matrix with another one's value
• equals Check whether two matrix equal
• fuzzyEquals Check whether two matrix equal with default degree of variance.
• toString Transform to string with matrix informations
• identity Set the matrix to the identity matrix
• transpose Transpose the values of a mat4
• invert Inverts a mat4
• adjoint Calculates the adjugate of a mat4
• determinant Calculates the determinant of a mat4
• add Adds two Mat4
• sub Subtracts the current matrix with another one
• mul Subtracts the current matrix with another one
• mulScalar Multiply each element of the matrix by a scalar.
• translate Translate a mat4 by the given vector
• scale Scales the mat4 by the dimensions in the given vec3
• rotate Rotates a mat4 by the given angle around the given axis
• getTranslation Returns the translation vector component of a transformation matrix.
• getScale Returns the scale factor component of a transformation matrix
• getRotation Returns the rotation factor component of a transformation matrix
• fromRTS Restore the matrix values from a quaternion rotation, vector translation and vector scale
• fromQuat Restore the matrix values from a quaternion rotation
• lerp Linearly interpolates between this value to to value by ratio which is in the range [0, 1].

Details

Methods

constructor

Constructor see cc.mat4

Parameters

• m00 Number Component in column 0, row 0 position (index 0)
• m01 Number Component in column 0, row 1 position (index 1)
• m02 Number Component in column 0, row 2 position (index 2)
• m03 Number Component in column 0, row 3 position (index 3)
• m10 Number Component in column 1, row 0 position (index 4)
• m11 Number Component in column 1, row 1 position (index 5)
• m12 Number Component in column 1, row 2 position (index 6)
• m13 Number Component in column 1, row 3 position (index 7)
• m20 Number Component in column 2, row 0 position (index 8)
• m21 Number Component in column 2, row 1 position (index 9)
• m22 Number Component in column 2, row 2 position (index 10)
• m23 Number Component in column 2, row 3 position (index 11)
• m30 Number Component in column 3, row 0 position (index 12)
• m31 Number Component in column 3, row 1 position (index 13)
• m32 Number Component in column 3, row 2 position (index 14)
• m33 Number Component in column 3, row 3 position (index 15)

clone

clone a Mat4 object

set

Sets the matrix with another one's value

Parameters

• srcObj Mat4

equals

Check whether two matrix equal

Parameters

• other Mat4

fuzzyEquals

Check whether two matrix equal with default degree of variance.

Parameters

• other Mat4

toString

Transform to string with matrix informations

identity

Set the matrix to the identity matrix

transpose

Transpose the values of a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

invert

Inverts a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

adjoint

Calculates the adjugate of a mat4

Parameters

• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

determinant

Calculates the determinant of a mat4

add

Adds two Mat4

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created.

sub

Subtracts the current matrix with another one

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

mul

Subtracts the current matrix with another one

Parameters

• other Mat4 the second operand
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

mulScalar

Multiply each element of the matrix by a scalar.

Parameters

• number Number amount to scale the matrix's elements by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

translate

Translate a mat4 by the given vector

Parameters

• v Vec3 vector to translate by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

scale

Scales the mat4 by the dimensions in the given vec3

Parameters

• v Vec3 vector to scale by
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

rotate

Rotates a mat4 by the given angle around the given axis

Parameters

• rad Number the angle to rotate the matrix by
• axis Vec3 the axis to rotate around
• out Mat4 the receiving matrix, you can pass the same matrix to save result to itself, if not provided, a new matrix will be created

getTranslation

Returns the translation vector component of a transformation matrix.

Parameters

• out Vec3 Vector to receive translation component, if not provided, a new vec3 will be created

getScale

Returns the scale factor component of a transformation matrix

Parameters

• out Vec3 Vector to receive scale component, if not provided, a new vec3 will be created

getRotation

Returns the rotation factor component of a transformation matrix

Parameters

• out Quat Vector to receive rotation component, if not provided, a new quaternion object will be created

fromRTS

Restore the matrix values from a quaternion rotation, vector translation and vector scale

Parameters

• q Quat Rotation quaternion
• v Vec3 Translation vector
• s Vec3 Scaling vector

fromQuat

Restore the matrix values from a quaternion rotation

Parameters

• q Quat Rotation quaternion

lerp

Linearly interpolates between this value to to value by ratio which is in the range [0, 1]. When ratio = 0 returns this. When ratio = 1 return to. When ratio = 0.5 returns the average of this and to.

Parameters

• to ValueType the to value
• ratio number the interpolation coefficient