Class Matrix4

Represents a 4x4 mathematical matrix.

Hierarchy

Matrix4

Constructors

constructor

new Matrix4(m11?: number, m12?: number, m13?: number, m14?: number, m21?: number, m22?: number, m23?: number, m24?: number, m31?: number, m32?: number, m33?: number, m34?: number, m41?: number, m42?: number, m43?: number, m44?: number): Matrix4
Constructor of 4x4 Matrix4.
Parameters
- m11: number = 1
  
  default 1, column 1, row 1
- m12: number = 0
  
  default 0, column 1, row 2
- m13: number = 0
  
  default 0, column 1, row 3
- m14: number = 0
  
  default 0, column 1, row 4
- m21: number = 0
  
  default 0, column 2, row 1
- m22: number = 1
  
  default 1, column 2, row 2
- m23: number = 0
  
  default 0, column 2, row 3
- m24: number = 0
  
  default 0, column 2, row 4
- m31: number = 0
  
  default 0, column 3, row 1
- m32: number = 0
  
  default 0, column 3, row 2
- m33: number = 1
  
  default 1, column 3, row 3
- m34: number = 0
  
  default 0, column 3, row 4
- m41: number = 0
  
  default 0, column 4, row 1
- m42: number = 0
  
  default 0, column 4, row 2
- m43: number = 0
  
  default 0, column 4, row 3
- m44: number = 1
  
  default 1, column 4, row 4
Returns Matrix4
- Defined in math/Matrix4.ts:795

Properties

elements

elements: Float32Array = ...

An array containing the elements of the matrix (column matrix).

Remarks

elements[0] first column and first row value m11 elements[1] first column and second row value m12 elements[2] first column and third row value m13 elements[3] first column and fourth row value m14 elements[4] second column and first row value m21 and so on

`Static` `Readonly` `Internal` _identity

_identity: Matrix4 = ...

Identity matrix.

`Static` `Private` `Readonly` _tempMat30

_tempMat30: Matrix3 = ...

`Static` `Private` `Readonly` _tempVec30

_tempVec30: Vector3 = ...

`Static` `Private` `Readonly` _tempVec31

_tempVec31: Vector3 = ...

`Static` `Private` `Readonly` _tempVec32

_tempVec32: Vector3 = ...

Methods

clone

clone(): Matrix4
Creates a clone of this matrix.

Returns
A clone of this matrix

Returns Matrix4
- Defined in math/Matrix4.ts:943

cloneTo

cloneTo(out: Matrix4): Matrix4
Clones this matrix to the specified matrix.

Returns
The specified matrix
Parameters
- out: Matrix4
  
  The specified matrix
Returns Matrix4
- Defined in math/Matrix4.ts:971

decompose

decompose(translation: Vector3, rotation: Quaternion, scale: Vector3): boolean
Decompose this matrix to translation, rotation and scale elements.

Returns
True if this matrix can be decomposed, false otherwise
Parameters
- translation: Vector3
  
  Translation vector as an output parameter
- rotation: Quaternion
  
  Rotation quaternion as an output parameter
- scale: Vector3
  
  Scale vector as an output parameter
Returns boolean
- Defined in math/Matrix4.ts:1056

determinant

determinant(): number
Calculate a determinant of this matrix.

Returns
The determinant of this matrix

Returns number
- Defined in math/Matrix4.ts:1012

getRotation

getRotation(out: Quaternion): Quaternion
Get rotation from this matrix.

Returns
The out
Parameters
- out: Quaternion
  
  Rotation quaternion as an output parameter
Returns Quaternion
- Defined in math/Matrix4.ts:1116

getScaling

getScaling(out: Vector3): Vector3
Get scale from this matrix.

Returns
The out
Parameters
- out: Vector3
  
  Scale vector as an output parameter
Returns Vector3
- Defined in math/Matrix4.ts:1155

getTranslation

getTranslation(out: Vector3): Vector3
Get translation from this matrix.

Returns
The out
Parameters
- out: Vector3
  
  Translation vector as an output parameter
Returns Vector3
- Defined in math/Matrix4.ts:1182

identity

identity(): Matrix4
Identity this matrix.

Returns
This matrix after identity

Returns Matrix4
- Defined in math/Matrix4.ts:1192

invert

invert(): Matrix4
Invert the matrix.

Returns
The matrix after invert

Returns Matrix4
- Defined in math/Matrix4.ts:1222

multiply

multiply(right: Matrix4): Matrix4
Determines the product of this matrix and the specified matrix.

Returns
This matrix that store the product of the two matrices
Parameters
- right: Matrix4
  
  The specified matrix
Returns Matrix4
- Defined in math/Matrix4.ts:1003

rotateAxisAngle

rotateAxisAngle(axis: Vector3, r: number): Matrix4
This matrix rotates around an arbitrary axis.

Returns
This matrix after rotate
Parameters
- axis: Vector3
  
  The axis
- r: number
  
  The rotation angle in radians
Returns Matrix4
- Defined in math/Matrix4.ts:1233

scale

scale(s: Vector3): Matrix4
Scale this matrix by a given vector.

Returns
This matrix after scale
Parameters
- s: Vector3
  
  The given vector
Returns Matrix4
- Defined in math/Matrix4.ts:1243

setValue

setValue(m11: number, m12: number, m13: number, m14: number, m21: number, m22: number, m23: number, m24: number, m31: number, m32: number, m33: number, m34: number, m41: number, m42: number, m43: number, m44: number): Matrix4
Set the value of this matrix, and return this matrix.

Returns
This matrix
Parameters
- m11: number
  
  column 1, row 1
- m12: number
  
  column 1, row 2
- m13: number
  
  column 1, row 3
- m14: number
  
  column 1, row 4
- m21: number
  
  column 2, row 1
- m22: number
  
  column 2, row 2
- m23: number
  
  column 2, row 3
- m24: number
  
  column 2, row 4
- m31: number
  
  column 3, row 1
- m32: number
  
  column 3, row 2
- m33: number
  
  column 3, row 3
- m34: number
  
  column 3, row 4
- m41: number
  
  column 4, row 1
- m42: number
  
  column 4, row 2
- m43: number
  
  column 4, row 3
- m44: number
  
  column 4, row 4
Returns Matrix4
- Defined in math/Matrix4.ts:856

setValueByArray

setValueByArray(array: ArrayLike<number>, offset?: number): Matrix4
Set the value of this matrix by an array.

Returns
This matrix
Parameters
- array: ArrayLike<number>
  
  The array
- offset: number = 0
  
  The start offset of the array
Returns Matrix4
- Defined in math/Matrix4.ts:905

toArray

toArray(out: Float32Array | Float64Array | number[], outOffset?: number): void
Clone the value of this matrix to an array.
Parameters
- out: Float32Array | Float64Array | number[]
  
  The array
- outOffset: number = 0
  
  The start offset of the array
Returns void
- Defined in math/Matrix4.ts:918

translate

translate(v: Vector3): Matrix4
Translate this matrix by a given vector.

Returns
This matrix after translate
Parameters
- v: Vector3
  
  The given vector
Returns Matrix4
- Defined in math/Matrix4.ts:1253

transpose

transpose(): Matrix4
Calculate the transpose of this matrix.

Returns
This matrix after transpose

Returns Matrix4
- Defined in math/Matrix4.ts:1262

`Static` affineTransformation

affineTransformation(scale: Vector3, rotation: Quaternion, translation: Vector3, out: Matrix4): void
Calculate an affine matrix.
Parameters
- scale: Vector3
  
  The scale used to calculate matrix
- rotation: Quaternion
  
  The rotation used to calculate matrix
- translation: Vector3
  
  The translation used to calculate matrix
- out: Matrix4
  
  The calculated matrix
Returns void
- Defined in math/Matrix4.ts:277

`Static` equals

equals(left: Matrix4, right: Matrix4): boolean
Determines whether the specified matrices are equals.

Returns
True if the specified matrices are equals, false otherwise
Parameters
- left: Matrix4
  
  The first matrix to compare
- right: Matrix4
  
  The second matrix to compare
Returns boolean
- Defined in math/Matrix4.ts:107

`Static` invert

invert(a: Matrix4, out: Matrix4): void
Calculate the inverse of the specified matrix.
Parameters
- a: Matrix4
  
  The matrix whose inverse is to be calculated
- out: Matrix4
  
  The inverse of the specified matrix
Returns void
- Defined in math/Matrix4.ts:379

`Static` lerp

lerp(start: Matrix4, end: Matrix4, t: number, out: Matrix4): void
Performs a linear interpolation between two matrices.
Parameters
- start: Matrix4
  
  The first matrix
- end: Matrix4
  
  The second matrix
- t: number
  
  The blend amount where 0 returns start and 1 end
- out: Matrix4
  
  The result of linear blending between two matrices
Returns void
- Defined in math/Matrix4.ts:138

`Static` lookAt

lookAt(eye: Vector3, target: Vector3, up: Vector3, out: Matrix4): void
Calculate a right-handed look-at matrix.
Parameters
- eye: Vector3
  
  The position of the viewer's eye
- target: Vector3
  
  The camera look-at target
- up: Vector3
  
  The camera's up vector
- out: Matrix4
  
  The calculated look-at matrix
Returns void
- Defined in math/Matrix4.ts:447

`Static` multiply

multiply(left: Matrix4, right: Matrix4, out: Matrix4): void
Determines the product of two matrices.
Parameters
- left: Matrix4
  
  The first matrix to multiply
- right: Matrix4
  
  The second matrix to multiply
- out: Matrix4
  
  The product of the two matrices
Returns void
- Defined in math/Matrix4.ts:41

`Static` ortho

ortho(left: number, right: number, bottom: number, top: number, near: number, far: number, out: Matrix4): void
Calculate an orthographic projection matrix.
Parameters
- left: number
  
  The left edge of the viewing
- right: number
  
  The right edge of the viewing
- bottom: number
  
  The bottom edge of the viewing
- top: number
  
  The top edge of the viewing
- near: number
  
  The depth of the near plane
- far: number
  
  The depth of the far plane
- out: Matrix4
  
  The calculated orthographic projection matrix
Returns void
- Defined in math/Matrix4.ts:490

`Static` perspective

perspective(fovY: number, aspect: number, near: number, far: number, out: Matrix4): void
Calculate a perspective projection matrix.
Parameters
- fovY: number
  
  Field of view in the y direction, in radians
- aspect: number
  
  Aspect ratio, defined as view space width divided by height
- near: number
  
  The depth of the near plane
- far: number
  
  The depth of the far plane
- out: Matrix4
  
  The calculated perspective projection matrix
Returns void
- Defined in math/Matrix4.ts:533

`Static` rotateAxisAngle

rotateAxisAngle(m: Matrix4, axis: Vector3, r: number, out: Matrix4): void
The specified matrix rotates around an arbitrary axis.
Parameters
- m: Matrix4
  
  The specified matrix
- axis: Vector3
  
  The axis
- r: number
  
  The rotation angle in radians
- out: Matrix4
  
  The rotated matrix
Returns void
- Defined in math/Matrix4.ts:566

`Static` rotationAxisAngle

rotationAxisAngle(axis: Vector3, r: number, out: Matrix4): void
Calculate a matrix rotates around an arbitrary axis.
Parameters
- axis: Vector3
  
  The axis
- r: number
  
  The rotation angle in radians
- out: Matrix4
  
  The matrix after rotate
Returns void
- Defined in math/Matrix4.ts:214

`Static` rotationQuaternion

rotationQuaternion(quaternion: Quaternion, out: Matrix4): void
Calculate a rotation matrix from a quaternion.
Parameters
- quaternion: Quaternion
  
  The quaternion used to calculate the matrix
- out: Matrix4
  
  The calculated rotation matrix
Returns void
- Defined in math/Matrix4.ts:170

`Static` rotationTranslation

rotationTranslation(quaternion: Quaternion, translation: Vector3, out: Matrix4): void
Calculate a matrix from a quaternion and a translation.
Parameters
- quaternion: Quaternion
  
  The quaternion used to calculate the matrix
- translation: Vector3
  
  The translation used to calculate the matrix
- out: Matrix4
  
  The calculated matrix
Returns void
- Defined in math/Matrix4.ts:261

`Static` scale

scale(m: Matrix4, s: Vector3, out: Matrix4): void
Scale a matrix by a given vector.
Parameters
- m: Matrix4
  
  The matrix
- s: Vector3
  
  The given vector
- out: Matrix4
  
  The scaled matrix
Returns void
- Defined in math/Matrix4.ts:642

`Static` scaling

scaling(s: Vector3, out: Matrix4): void
Calculate a matrix from scale vector.
Parameters
- s: Vector3
  
  The scale vector
- out: Matrix4
  
  The calculated matrix
Returns void
- Defined in math/Matrix4.ts:323

`Static` translate

translate(m: Matrix4, v: Vector3, out: Matrix4): void
Translate a matrix by a given vector.
Parameters
- m: Matrix4
  
  The matrix
- v: Vector3
  
  The given vector
- out: Matrix4
  
  The translated matrix
Returns void
- Defined in math/Matrix4.ts:674

`Static` translation

translation(translation: Vector3, out: Matrix4): void
Calculate a matrix from translation vector.
Parameters
- translation: Vector3
  
  The translation vector
- out: Matrix4
  
  The calculated matrix
Returns void
- Defined in math/Matrix4.ts:351

`Static` transpose

transpose(a: Matrix4, out: Matrix4): void
Calculate the transpose of the specified matrix.
Parameters
- a: Matrix4
  
  The specified matrix
- out: Matrix4
  
  The transpose of the specified matrix
Returns void
- Defined in math/Matrix4.ts:714

Class Matrix4

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

m11: number = 1

m12: number = 0

m13: number = 0

m14: number = 0

m21: number = 0

m22: number = 1

m23: number = 0

m24: number = 0

m31: number = 0

m32: number = 0

m33: number = 1

m34: number = 0

m41: number = 0

m42: number = 0

m43: number = 0

m44: number = 1

Returns Matrix4

Properties

elements

Remarks

Static Readonly Internal _identity

Static Private Readonly _tempMat30

Static Private Readonly _tempVec30

Static Private Readonly _tempVec31

Static Private Readonly _tempVec32

Methods

clone

Returns

Returns Matrix4

cloneTo

Returns

Parameters

out: Matrix4

Returns Matrix4

decompose

Returns

Parameters

translation: Vector3

rotation: Quaternion

scale: Vector3

Returns boolean

determinant

Returns

Returns number

getRotation

Returns

Parameters

out: Quaternion

Returns Quaternion

getScaling

Returns

Parameters

out: Vector3

Returns Vector3

getTranslation

Returns

Parameters

out: Vector3

Returns Vector3

identity

Returns

Returns Matrix4

invert

Returns

Returns Matrix4

multiply

Returns

Parameters

right: Matrix4

Returns Matrix4

rotateAxisAngle

`Static` `Readonly` `Internal` _identity

`Static` `Private` `Readonly` _tempMat30

`Static` `Private` `Readonly` _tempVec30

`Static` `Private` `Readonly` _tempVec31

`Static` `Private` `Readonly` _tempVec32

`Static` affineTransformation

`Static` equals

`Static` invert

`Static` lerp