Class Matrix4

constructor

• new Matrix4(): Matrix4

• Creates an identity matrix.

  Returns Matrix4
• new Matrix4(n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44): Matrix4

• Creates a 4x4 matrix with the given arguments in row-major order.

  Parameters

  • n11: number
  • n12: number
  • n13: number
  • n14: number
  • n21: number
  • n22: number
  • n23: number
  • n24: number
  • n31: number
  • n32: number
  • n33: number
  • n34: number
  • n41: number
  • n42: number
  • n43: number
  • n44: number

  Returns Matrix4

elements

[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
Copy

ReadonlyisMatrix4

clone

• clone(): Matrix4

• Returns Matrix4

compose

• compose(position, quaternion, scale): this

• Sets this matrix to the transformation composed of translation, rotation and scale.

  Parameters

  • position: Vector3
  • quaternion: Quaternion
  • scale: Vector3

  Returns this

copy

• copy(m): this

• Parameters

  • m: Matrix4

  Returns this

copyPosition

• copyPosition(m): this

• Parameters

  • m: Matrix4

  Returns this

decompose

• decompose(position, quaternion, scale): this

• Decomposes this matrix into it's position, quaternion and scale components.

  Parameters

  • position: Vector3
  • quaternion: Quaternion
  • scale: Vector3

  Returns this

determinant

• determinant(): number

• Computes determinant of this matrix. Based on http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.htm

  Returns number

equals

• equals(matrix): boolean

• Parameters

  • matrix: Matrix4

  Returns boolean

extractBasis

• extractBasis(xAxis, yAxis, zAxis): this

• Parameters

  • xAxis: Vector3
  • yAxis: Vector3
  • zAxis: Vector3

  Returns this

extractRotation

• extractRotation(m): this

• Copies the rotation component of the supplied matrix m into this matrix rotation component.

  Parameters

  • m: Matrix4

  Returns this

fromArray

• fromArray(array, offset?): this

• Sets the values of this matrix from the provided array or array-like.

  Parameters

  • array: ArrayLike<number>

    the source array or array-like.
  • Optionaloffset: number

    (optional) offset into the array-like. Default is 0.

  Returns this

getMaxScaleOnAxis

• getMaxScaleOnAxis(): number

• Returns number

identity

• identity(): this

• Resets this matrix to identity.

  Returns this

invert

• invert(): this

• Inverts this matrix.

  Returns this

lookAt

• lookAt(eye, target, up): this

• Constructs a rotation matrix, looking from eye towards center with defined up vector.

  Parameters

  • eye: Vector3
  • target: Vector3
  • up: Vector3

  Returns this

makeBasis

• makeBasis(xAxis, yAxis, zAxis): this

• Parameters

  • xAxis: Vector3
  • yAxis: Vector3
  • zAxis: Vector3

  Returns this

makeOrthographic

• makeOrthographic(left, right, top, bottom, near, far, coordinateSystem?): this

• Creates an orthographic projection matrix.

  Parameters

  • left: number
  • right: number
  • top: number
  • bottom: number
  • near: number
  • far: number
  • OptionalcoordinateSystem: CoordinateSystem

  Returns this

makePerspective

• makePerspective(left, right, top, bottom, near, far, coordinateSystem?): this

• Creates a perspective projection matrix.

  Parameters

  • left: number
  • right: number
  • top: number
  • bottom: number
  • near: number
  • far: number
  • OptionalcoordinateSystem: CoordinateSystem

  Returns this

makeRotationAxis

• makeRotationAxis(axis, angle): this

• Sets this matrix as rotation transform around axis by angle radians. Based on http://www.gamedev.net/reference/articles/article1199.asp.

  Parameters

  • axis: Vector3

    Rotation axis.
  • angle: number

    Rotation angle in radians.

  Returns this

makeRotationFromEuler

• makeRotationFromEuler(euler): this

• Parameters

  • euler: Euler

  Returns this

makeRotationFromQuaternion

• makeRotationFromQuaternion(q): this

• Parameters

  • q: Quaternion

  Returns this

makeRotationX

• makeRotationX(theta): this

• Sets this matrix as rotation transform around x axis by theta radians.

  Parameters

  • theta: number

    Rotation angle in radians.

  Returns this

makeRotationY

• makeRotationY(theta): this

• Sets this matrix as rotation transform around y axis by theta radians.

  Parameters

  • theta: number

    Rotation angle in radians.

  Returns this

makeRotationZ

• makeRotationZ(theta): this

• Sets this matrix as rotation transform around z axis by theta radians.

  Parameters

  • theta: number

    Rotation angle in radians.

  Returns this

makeScale

• makeScale(x, y, z): this

• Sets this matrix as scale transform.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns this

makeShear

• makeShear(xy, xz, yx, yz, zx, zy): this

• Sets this matrix as shear transform.

  Parameters

  • xy: number
  • xz: number
  • yx: number
  • yz: number
  • zx: number
  • zy: number

  Returns this

makeTranslation

• makeTranslation(v): this

• Sets this matrix as translation transform.

  Parameters

  • v: Vector3

  Returns this
• makeTranslation(x, y, z): this

• Parameters

  • x: number
  • y: number
  • z: number

  Returns this

multiply

• multiply(m): this

• Multiplies this matrix by m.

  Parameters

  • m: Matrix4

  Returns this

multiplyMatrices

• multiplyMatrices(a, b): this

• Sets this matrix to a x b.

  Parameters

  • a: Matrix4
  • b: Matrix4

  Returns this

multiplyScalar

• multiplyScalar(s): this

• Multiplies this matrix by s.

  Parameters

  • s: number

  Returns this

premultiply

• premultiply(m): this

• Parameters

  • m: Matrix4

  Returns this

scale

• scale(v): this

• Multiplies the columns of this matrix by vector v.

  Parameters

  • v: Vector3

  Returns this

set

• set(n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44): this

• Sets all fields of this matrix.

  Parameters

  • n11: number
  • n12: number
  • n13: number
  • n14: number
  • n21: number
  • n22: number
  • n23: number
  • n24: number
  • n31: number
  • n32: number
  • n33: number
  • n34: number
  • n41: number
  • n42: number
  • n43: number
  • n44: number

  Returns this

setFromMatrix3

• setFromMatrix3(m): this

• Set the upper 3x3 elements of this matrix to the values of the Matrix3 m.

  Parameters

  • m: Matrix3

  Returns this

setPosition

• setPosition(v): this

• Sets the position component for this matrix from vector v.

  Parameters

  • v: Vector3

  Returns this
• setPosition(x, y, z): this

• Parameters

  • x: number
  • y: number
  • z: number

  Returns this

toArray

• toArray(): Matrix4Tuple

• Writes the elements of this matrix to an array in column-major format.

  Returns Matrix4Tuple
• toArray<TArray>(array, offset?): TArray

• Writes the elements of this matrix to an array in column-major format.

  Type Parameters

  • TArray extends ArrayLike<number>

  Parameters

  • array: TArray

    array to store the resulting vector in.
  • Optionaloffset: number

    (optional) offset in the array at which to put the result.

  Returns TArray

transpose

• transpose(): this

• Transposes this matrix.

  Returns this