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 );

Constructors

constructor

new Matrix4(): Matrix4
Creates an identity matrix.

Returns Matrix4
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:56
new Matrix4(
    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,
): 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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:60

Properties

elements

elements: Matrix4Tuple

Array with matrix values.

Default

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

`Readonly`isMatrix4

isMatrix4: true

Methods

clone

clone(): Matrix4
Returns Matrix4
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:106

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:231

copy

copy(m: Matrix4): this
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:108

copyPosition

copyPosition(m: Matrix4): this
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:110

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:236

determinant

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

Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:157

equals

equals(matrix: Matrix4): boolean
Parameters
- matrix: Matrix4
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:266

extractBasis

extractBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): this
Parameters
- xAxis: Vector3
- yAxis: Vector3
- zAxis: Vector3
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:117

extractRotation

extractRotation(m: Matrix4): this
Copies the rotation component of the supplied matrix m into this matrix rotation component.
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:124

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:273

getMaxScaleOnAxis

getMaxScaleOnAxis(): number
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:180

identity

identity(): this
Resets this matrix to identity.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:104

invert

invert(): this
Inverts this matrix.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:173

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:134

makeBasis

makeBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): this
Parameters
- xAxis: Vector3
- yAxis: Vector3
- zAxis: Vector3
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:119

makeOrthographic

makeOrthographic(
    left: number,
    right: number,
    top: number,
    bottom: number,
    near: number,
    far: number,
    coordinateSystem?: CoordinateSystem,
    reversedDepth?: boolean,
): this
Creates an orthographic projection matrix.
Parameters
- left: number
- right: number
- top: number
- bottom: number
- near: number
- far: number
- OptionalcoordinateSystem: CoordinateSystem
- OptionalreversedDepth: boolean
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:255

makePerspective

makePerspective(
    left: number,
    right: number,
    top: number,
    bottom: number,
    near: number,
    far: number,
    coordinateSystem?: CoordinateSystem,
    reversedDepth?: boolean,
): this
Creates a perspective projection matrix.
Parameters
- left: number
- right: number
- top: number
- bottom: number
- near: number
- far: number
- OptionalcoordinateSystem: CoordinateSystem
- OptionalreversedDepth: boolean
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:241

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:216

makeRotationFromEuler

makeRotationFromEuler(euler: Euler): this
Parameters
- euler: Euler
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:126

makeRotationFromQuaternion

makeRotationFromQuaternion(q: Quaternion): this
Parameters
- q: Quaternion
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:128

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:193

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:200

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:207

makeScale

makeScale(x: number, y: number, z: number): this
Sets this matrix as scale transform.
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:221

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:226

makeTranslation

makeTranslation(v: Vector3): this
Sets this matrix as translation transform.
Parameters
- v: Vector3
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:185
makeTranslation(x: number, y: number, z: number): this
Sets this matrix as translation transform.
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:186

multiply

multiply(m: Matrix4): this
Multiplies this matrix by m.
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:139

multiplyMatrices

multiplyMatrices(a: Matrix4, b: Matrix4): this
Sets this matrix to a x b.
Parameters
- a: Matrix4
- b: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:146

multiplyScalar

multiplyScalar(s: number): this
Multiplies this matrix by s.
Parameters
- s: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:151

premultiply

premultiply(m: Matrix4): this
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:141

scale

scale(v: Vector3): this
Multiplies the columns of this matrix by vector v.
Parameters
- v: Vector3
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:178

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:82

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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:115

setPosition

setPosition(v: Vector3): this
Sets the position component for this matrix from vector v.
Parameters
- v: Vector3
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:167
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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:168

toArray

toArray(): Matrix4Tuple
Writes the elements of this matrix to an array in column-major format.

Returns Matrix4Tuple
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:279
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
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:286

transpose

transpose(): this
Transposes this matrix.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Matrix4.d.ts:162

Class Matrix4

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Matrix4

Parameters

Returns Matrix4

Properties

elements

Default

ReadonlyisMatrix4

Methods

clone

Returns Matrix4

compose

Parameters

Returns this

copy

Parameters

Returns this

copyPosition

Parameters

Returns this

decompose

Parameters

Returns this

determinant

Returns number

equals

Parameters

Returns boolean

extractBasis

Parameters

Returns this

extractRotation

Parameters

Returns this

fromArray

Parameters

Returns this

getMaxScaleOnAxis

Returns number

identity

Returns this

invert

Returns this

lookAt

Parameters

Returns this

makeBasis

Parameters

Returns this

makeOrthographic

Parameters

Returns this

makePerspective

Parameters

Returns this

makeRotationAxis

Parameters

Returns this

makeRotationFromEuler

Parameters

Returns this

makeRotationFromQuaternion

Parameters

Returns this

makeRotationX

Parameters

Returns this

makeRotationY

Parameters

Returns this

makeRotationZ

Parameters

Returns this

`Readonly`isMatrix4