Class Matrix4

A 4x4 Matrix.

Example

// Simple rig for rotating around 3 axes
const m = new THREE.Matrix4();
const m1 = new THREE.Matrix4();
const m2 = new THREE.Matrix4();
const m3 = new THREE.Matrix4();
const alpha = 0;
const beta = Math.PI;
const gamma = Math.PI/2;
m1.makeRotationX( alpha );
m2.makeRotationY( beta );
m3.makeRotationZ( gamma );
m.multiplyMatrices( m1, m2 );
m.multiply( m3 );

Implements

Constructors

constructor

Properties

elements

Methods

clone compose copy copyPosition crossVector decompose determinant equals extractBasis extractPosition extractRotation flattenToArrayOffset fromArray getInverse getMaxScaleOnAxis identity invert lookAt makeBasis makeOrthographic makePerspective makeRotationAxis makeRotationFromEuler makeRotationFromQuaternion makeRotationX makeRotationY makeRotationZ makeScale makeShear makeTranslation multiply multiplyMatrices multiplyScalar multiplyToArray multiplyVector3 multiplyVector3Array multiplyVector4 premultiply rotateAxis scale set setFromMatrix3 setPosition setRotationFromQuaternion toArray transpose

Constructors

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

Properties

elements

elements: number[]

Array with matrix values.

Default

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

Methods

clone

  • clone(): Matrix4

  • clone():T;

    Returns Matrix4

compose

  • compose(translation, rotation, scale): this

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

    Parameters

    Returns this

copy

  • copy(m): this

  • copy(m:T):T;

    Parameters

    Returns this

copyPosition

  • copyPosition(m): this

  • Parameters

    Returns this

crossVector

  • crossVector(v): void

  • Parameters

    • v: any

    Returns void

    Deprecated

    Use vector.applyMatrix4( matrix ) instead.

decompose

  • decompose(translation, rotation, scale): this

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

    Parameters

    Returns this

determinant

equals

  • equals(matrix): boolean

  • Parameters

    Returns boolean

extractBasis

  • extractBasis(xAxis, yAxis, zAxis): this

  • Parameters

    Returns this

extractPosition

extractRotation

  • extractRotation(m): this

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

    Parameters

    Returns this

flattenToArrayOffset

  • flattenToArrayOffset(array, offset): number[]

  • Parameters

    • array: number[]
    • offset: number

    Returns number[]

    Deprecated

    Use .toArray() instead.

fromArray

  • fromArray(array, offset?): this

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

    Parameters

    • array: ArrayLike<number> | number[]

      the source array or array-like.

    • Optional offset: number

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

    Returns this

getInverse

  • getInverse(matrix): Matrix

  • Parameters

    Returns Matrix

    Deprecated

    Use .invert() instead.

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

    Returns this

makeBasis

  • makeBasis(xAxis, yAxis, zAxis): this

  • Parameters

    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
    • Optional coordinateSystem: 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
    • Optional coordinateSystem: CoordinateSystem

    Returns this

makeRotationAxis

makeRotationFromEuler

  • makeRotationFromEuler(euler): this

  • Parameters

    Returns this

makeRotationFromQuaternion

  • makeRotationFromQuaternion(q): this

  • Parameters

    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

    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

    Returns this

multiplyMatrices

  • multiplyMatrices(a, b): this

  • Sets this matrix to a x b.

    Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s): this

  • Multiplies this matrix by s.

    Parameters

    • s: number

    Returns this

multiplyToArray

  • multiplyToArray(a, b, r): Matrix4

  • Sets this matrix to a x b and stores the result into the flat array r. r can be either a regular Array or a TypedArray.

    Parameters

    Returns Matrix4

    Deprecated

    This method has been removed completely.

multiplyVector3

  • multiplyVector3(v): any

  • Parameters

    • v: any

    Returns any

    Deprecated

    Use vector.applyMatrix4( matrix ) instead.

multiplyVector3Array

  • multiplyVector3Array(array): number[]

  • Parameters

    • array: number[]

    Returns number[]

    Deprecated

    This method has been removed completely.

multiplyVector4

  • multiplyVector4(v): any

  • Parameters

    • v: any

    Returns any

    Deprecated

    Use vector.applyMatrix4( matrix ) instead.

premultiply

  • premultiply(m): this

  • Parameters

    Returns this

rotateAxis

scale

  • scale(v): this

  • Multiplies the columns of this matrix by vector v.

    Parameters

    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

    Returns this

setPosition

  • setPosition(v): this

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

    Parameters

    Returns this

  • setPosition(x, y, z): this

  • Parameters

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

    Returns this

setRotationFromQuaternion

toArray

  • toArray(array?, offset?): number[]

  • Returns an array with the values of this matrix, or copies them into the provided array.

    Parameters

    • Optional array: number[]

      (optional) array to store the matrix to. If this is not provided, a new array will be created.

    • Optional offset: number

      (optional) optional offset into the array.

    Returns number[]

    The created or provided array.

  • toArray(array?, offset?): Matrix4Tuple

  • Parameters

    Returns Matrix4Tuple

  • toArray(array?, offset?): ArrayLike<number>

  • Copies he values of this matrix into the provided array-like.

    Parameters

    • Optional array: ArrayLike<number>

      array-like to store the matrix to.

    • Optional offset: number

      (optional) optional offset into the array-like.

    Returns ArrayLike<number>

    The provided array-like.

transpose

  • transpose(): this

  • Transposes this matrix.

    Returns this

Settings

Member Visibility

On This Page

constructorelementsclonecomposecopycopyPositioncrossVectordecomposedeterminantequalsextractBasisextractPositionextractRotationflattenToArrayOffsetfromArraygetInversegetMaxScaleOnAxisidentityinvertlookAtmakeBasismakeOrthographicmakePerspectivemakeRotationAxismakeRotationFromEulermakeRotationFromQuaternionmakeRotationXmakeRotationYmakeRotationZmakeScalemakeShearmakeTranslationmultiplymultiplyMatricesmultiplyScalarmultiplyToArraymultiplyVector3multiplyVector3ArraymultiplyVector4premultiplyrotateAxisscalesetsetFromMatrix3setPositionsetRotationFromQuaterniontoArraytranspose