Class Matrix4

ReadonlyisMatrix4

compose

• compose(position: Vector3, quaternion: Quaternion, scale: Vector3): 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: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

copyPosition

• copyPosition(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

decompose

• decompose(position: Vector3, quaternion: Quaternion, scale: Vector3): 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: Matrix4): boolean

  Parameters

  • matrix: Matrix4

  Returns boolean

extractBasis

• extractBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): this

  Parameters

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

  Returns this

extractRotation

• extractRotation(m: Matrix4): this

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

  Parameters

  • m: Matrix4

  Returns this

fromArray

• fromArray(array: ArrayLike<number>, offset?: number): 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: Vector3, target: Vector3, up: Vector3): this

  Sets the rotation component of the transformation matrix, looking from [eye]Vector3 towards [target]Vector3, and oriented by the up-direction [up]Vector3.

  Parameters

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

  Returns this

makeBasis

• makeBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): this

  Parameters

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

  Returns this

makeOrthographic

• makeOrthographic(
      left: number,
      right: number,
      top: number,
      bottom: number,
      near: number,
      far: number,
      coordinateSystem?: 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: number,
      right: number,
      top: number,
      bottom: number,
      near: number,
      far: number,
      coordinateSystem?: 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: Vector3, angle: number): 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: Euler): this

  Parameters

  • euler: Euler

  Returns this

makeRotationFromQuaternion

• makeRotationFromQuaternion(q: Quaternion): this

  Parameters

  • q: Quaternion

  Returns this

makeRotationX

• makeRotationX(theta: number): 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: number): 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: number): 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: number, y: number, z: number): this

  Sets this matrix as scale transform.

  Parameters

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

  Returns this

makeShear

• makeShear(
      xy: number,
      xz: number,
      yx: number,
      yz: number,
      zx: number,
      zy: number,
  ): 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: Vector3): this

  Sets this matrix as translation transform.

  Parameters

  • v: Vector3

  Returns this

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

  Sets this matrix as translation transform.

  Parameters

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

  Returns this

multiply

• multiply(m: Matrix4): this

  Multiplies this matrix by m.

  Parameters

  • m: Matrix4

  Returns this

multiplyMatrices

• multiplyMatrices(a: Matrix4, b: Matrix4): this

  Sets this matrix to a x b.

  Parameters

  • a: Matrix4
  • b: Matrix4

  Returns this

multiplyScalar

• multiplyScalar(s: number): this

  Multiplies this matrix by s.

  Parameters

  • s: number

  Returns this

premultiply

• premultiply(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

scale

• scale(v: Vector3): this

  Multiplies the columns of this matrix by vector v.

  Parameters

  • v: Vector3

  Returns this

set

• set(
      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,
  ): 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: Matrix3): this

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

  Parameters

  • m: Matrix3

  Returns this

setPosition

• setPosition(v: Vector3): this

  Sets the position component for this matrix from vector v.

  Parameters

  • v: Vector3

  Returns this

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

  Sets the position component for this matrix from vector v.

  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 extends ArrayLike<number>>(
      array: TArray,
      offset?: number,
  ): 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