Class Matrix4

Serializable THREE.js Matrix4

Hierarchy (view full)

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 fromArray rotationFromAxisAngle rotationFromEuler rotationFromQuaternion round

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[]

Methods

clone

compose

  • compose(translation, rotation, scale): this

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

    Parameters

    • translation: Vector3
    • rotation: Quaternion
    • scale: Vector3

    Returns this

copy

  • copy(m): this

  • Parameters

    • m: Matrix4

    Returns this

copyPosition

  • copyPosition(m): this

  • Parameters

    • m: Matrix4

    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

    • translation: Vector3
    • rotation: Quaternion
    • scale: Vector3

    Returns this

determinant

equals

  • equals(matrix): boolean

  • Parameters

    • matrix: Matrix4

    Returns boolean

extractBasis

  • extractBasis(xAxis, yAxis, zAxis): this

  • Parameters

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

    Returns this

extractPosition

  • extractPosition(m): Matrix4

  • Parameters

    • m: Matrix4

    Returns Matrix4

    Deprecated

    Use .copyPosition() instead.

extractRotation

  • extractRotation(m): this

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

    Parameters

    • m: Matrix4

    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: number[] | ArrayLike<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

    • matrix: Matrix

    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

    • 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
    • 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

  • 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

    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

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

    • a: Matrix4
    • b: Matrix4
    • r: number[]

    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

    • m: Matrix4

    Returns this

rotateAxis

  • rotateAxis(v): void

  • Parameters

    • v: any

    Returns void

    Deprecated

    Use Vector3.transformDirection( matrix ) instead.

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

setRotationFromQuaternion

  • setRotationFromQuaternion(q): Matrix4

  • Parameters

    • q: Quaternion

    Returns Matrix4

    Deprecated

    Use .makeRotationFromQuaternion() instead.

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

    • Optional array: Matrix4Tuple
    • Optional offset: 0

    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

Static fromArray

Static rotationFromAxisAngle

  • rotationFromAxisAngle<T>(vector, angle): T

  • Create a rotation matrix from euler angles

    Type Parameters

    Parameters

    • vector: Vector3

      Vector

    • angle: number

      Angle

    Returns T

    Rotation matrix

Static rotationFromEuler

  • rotationFromEuler<T>(euler): T

  • Create a rotation matrix from euler angles

    Type Parameters

    Parameters

    • euler: Euler

      Euler angles

    Returns T

    Rotation matrix

Static rotationFromQuaternion

  • rotationFromQuaternion<T>(quat): T

  • Create a rotation matrix from quaternion

    Type Parameters

    Parameters

    • quat: Quaternion

      Quaternion

    Returns T

    Rotation matrix

Static round

Settings

Member Visibility

Theme

On This Page

constructorelementsclonecomposecopycopyPositioncrossVectordecomposedeterminantequalsextractBasisextractPositionextractRotationflattenToArrayOffsetfromArraygetInversegetMaxScaleOnAxisidentityinvertlookAtmakeBasismakeOrthographicmakePerspectivemakeRotationAxismakeRotationFromEulermakeRotationFromQuaternionmakeRotationXmakeRotationYmakeRotationZmakeScalemakeShearmakeTranslationmultiplymultiplyMatricesmultiplyScalarmultiplyToArraymultiplyVector3multiplyVector3ArraymultiplyVector4premultiplyrotateAxisscalesetsetFromMatrix3setPositionsetRotationFromQuaterniontoArraytransposefromArrayrotationFromAxisAnglerotationFromEulerrotationFromQuaternionround