Class Mat4

constructor

• new Mat4(values?: ArrayLike<number>): Mat4

  Parameters

  • Optionalvalues: ArrayLike<number>

    16 values in column-major order; identity if omitted

  Returns Mat4

Readonlydimension

clone

• clone(): Mat4

  Returns Mat4

compose

• compose(position: Vector, rotation: Vector | Quaternion, scale: Vector): this

  Set this to translation × rotation × scale.

  Parameters

  • position: Vector

    translation

  • rotation: Vector | Quaternion

    the rotation as a unit Quaternion, or as Euler angles in radians applied in XYZ order

  • scale: Vector

    scale factors per axis

  Returns this

determinant

• determinant(): number

  Returns number

getPosition

• getPosition(target: Vector): Vector

  the translation part as a vector

  Parameters

  • target: Vector

  Returns Vector

invert

• invert(): this

  Invert in place. A singular matrix becomes the zero matrix.

  Returns this

multiply

• multiply(other: Mat4): this

  this = this × other

  Parameters

  • other: Mat4

  Returns this

multiplyMatrices

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

  this = a × b

  Parameters

  • a: Mat4
  • b: Mat4

  Returns this

premultiply

• premultiply(other: Mat4): this

  this = other × this

  Parameters

  • other: Mat4

  Returns this

setFrustum

• setFrustum(
      left: number,
      right: number,
      bottom: number,
      top: number,
      zNear: number,
      zFar: number,
  ): this

  Parameters

  • left: number
  • right: number
  • bottom: number
  • top: number
  • zNear: number
  • zFar: number

  Returns this

  See

  Mat4.frustum

setLookAt

• setLookAt(position: Vector, target: Vector, up: Vector): this

  Parameters

  • position: Vector
  • target: Vector
  • up: Vector

  Returns this

  See

  Mat4.lookAt

setOrtho

• setOrtho(
      left: number,
      right: number,
      bottom: number,
      top: number,
      zNear: number,
      zFar: number,
  ): this

  Parameters

  • left: number
  • right: number
  • bottom: number
  • top: number
  • zNear: number
  • zFar: number

  Returns this

  See

  Mat4.ortho

setPerspective

• setPerspective(
      fieldOfView: number,
      aspectRatio: number,
      zNear: number,
      zFar: number,
  ): this

  Parameters

  • fieldOfView: number
  • aspectRatio: number
  • zNear: number
  • zFar: number

  Returns this

  See

  Mat4.perspective

setRotationFromQuaternion

• setRotationFromQuaternion(quaternion: Quaternion): this

  Parameters

  • quaternion: Quaternion

  Returns this

  See

  Mat4.rotationFromQuaternion

setRotationX

• setRotationX(angle: number): this

  Parameters

  • angle: number

  Returns this

setRotationY

• setRotationY(angle: number): this

  Parameters

  • angle: number

  Returns this

setRotationZ

• setRotationZ(angle: number): this

  Parameters

  • angle: number

  Returns this

setScaling

• setScaling(sx: number, sy: number, sz: number): this

  Parameters

  • sx: number
  • sy: number
  • sz: number

  Returns this

setTranslation

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

  Parameters

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

  Returns this

transpose

• transpose(): this

  Returns this

StaticfromMatrix

• fromMatrix(matrix: Matrix): Mat4

  copy a 4x4 Matrix

  Parameters

  • matrix: Matrix

  Returns Mat4

Staticfrustum

• frustum(
      left: number,
      right: number,
      bottom: number,
      top: number,
      zNear: number,
      zFar: number,
  ): Mat4

  create a perspective projection matrix from a viewing frustum

  Parameters

  • left: number
  • right: number
  • bottom: number
  • top: number
  • zNear: number
  • zFar: number

  Returns Mat4

  See

  https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/glFrustum.xml

Staticidentity

• identity(): Mat4

  Returns Mat4

StaticlookAt

• lookAt(position: Vector, target: Vector, up: Vector): Mat4

  Create a camera matrix: the transform of an object at position whose -Z axis points at target. Its inverse is the view matrix.

  Parameters

  • position: Vector
  • target: Vector
  • up: Vector

  Returns Mat4

Staticortho

• ortho(
      left: number,
      right: number,
      bottom: number,
      top: number,
      zNear: number,
      zFar: number,
  ): Mat4

  create an orthographic projection matrix

  Parameters

  • left: number
  • right: number
  • bottom: number
  • top: number
  • zNear: number
  • zFar: number

  Returns Mat4

  See

  https://www.khronos.org/registry/OpenGL-Refpages/gl2.1/xhtml/glOrtho.xml

Staticperspective

• perspective(
      fieldOfView: number,
      aspectRatio: number,
      zNear: number,
      zFar: number,
  ): Mat4

  create a perspective projection matrix

  Parameters

  • fieldOfView: number

    vertical field of view in degrees

  • aspectRatio: number

    width / height

  • zNear: number

    distance to the near clipping plane (positive)

  • zFar: number

    distance to the far clipping plane (positive)

  Returns Mat4

StaticrotationFromQuaternion

• rotationFromQuaternion(quaternion: Quaternion): Mat4

  create a rotation matrix from a unit quaternion

  Parameters

  • quaternion: Quaternion

  Returns Mat4

StaticrotX

• rotX(angle: number): Mat4

  create x-rotation matrix

  Parameters

  • angle: number

    angle in radians

  Returns Mat4

StaticrotY

• rotY(angle: number): Mat4

  create y-rotation matrix

  Parameters

  • angle: number

    angle in radians

  Returns Mat4

StaticrotZ

• rotZ(angle: number): Mat4

  create z-rotation matrix

  Parameters

  • angle: number

    angle in radians

  Returns Mat4

Staticscaling

• scaling(sx: number, sy: number, sz: number): Mat4

  create scaling matrix

  Parameters

  • sx: number

    X-scale factor

  • sy: number

    Y-scale factor

  • sz: number

    Z-scale factor

  Returns Mat4

Statictranslation

• translation(x: number, y: number, z: number): Mat4

  create translation matrix

  Parameters

  • x: number

    translation in X direction

  • y: number

    translation in Y direction

  • z: number

    translation in Z direction

  Returns Mat4