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

Matrix

Constructors

constructor

new Matrix4(): Matrix4
Creates an identity matrix.

Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:50
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
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:54

Properties

`Readonly`isMatrix4

isMatrix4: true

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

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

identity

identity(): this
Resets this matrix to identity.

Returns this
Implementation of Matrix.identity
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:104

clone

clone(): Matrix4
clone():T;

Returns Matrix4
Implementation of Matrix.clone
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:105

copy

copy(m): this
copy(m:T):T;
Parameters
- m: Matrix4
Returns this
Implementation of Matrix.copy
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:106

copyPosition

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

extractBasis

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

makeBasis

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

extractRotation

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

makeRotationFromEuler

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

makeRotationFromQuaternion

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

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

multiply

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

premultiply

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

multiplyMatrices

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

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

multiplyScalar

multiplyScalar(s): this
Multiplies this matrix by s.
Parameters
- s: number
Returns this
Implementation of Matrix.multiplyScalar
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:145

determinant

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

Returns number
Implementation of Matrix.determinant
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:151

transpose

transpose(): this
Transposes this matrix.

Returns this
Implementation of Matrix.transpose
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:156

setPosition

setPosition(v): this
Sets the position component for this matrix from vector v.
Parameters
- v: Vector3
Returns this
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:161
setPosition(x, y, z): this
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:162

invert

invert(): this
Inverts this matrix.

Returns this
Implementation of Matrix.invert
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:167

scale

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

getMaxScaleOnAxis

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

makeTranslation

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

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

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

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

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

makeScale

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

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

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

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

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
- OptionalcoordinateSystem: CoordinateSystem
Returns this
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:234

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
- OptionalcoordinateSystem: CoordinateSystem
Returns this
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:247

equals

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

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.
- Optionaloffset: number
  (optional) offset into the array-like. Default is 0.
Returns this
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:263

toArray

toArray(array?, offset?): number[]
Returns an array with the values of this matrix, or copies them into the provided array.
Parameters
- Optionalarray: number[]
  (optional) array to store the matrix to. If this is not provided, a new array will be created.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns number[]
The created or provided array.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:271
toArray(array?, offset?): Matrix4Tuple
Parameters
- Optionalarray: Matrix4Tuple
- Optionaloffset: 0
Returns Matrix4Tuple
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:272
toArray(array?, offset?): ArrayLike<number>
Copies he values of this matrix into the provided array-like.
Parameters
- Optionalarray: ArrayLike<number>
  array-like to store the matrix to.
- Optionaloffset: number
  (optional) optional offset into the array-like.
Returns ArrayLike<number>
The provided array-like.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:280

setFromMatrix3

setFromMatrix3(m): 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/@types/three/src/math/Matrix4.d.ts:285

extractPosition

extractPosition(m): Matrix4
Parameters
- m: Matrix4
Returns Matrix4
Deprecated
Use .copyPosition() instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:290

setRotationFromQuaternion

setRotationFromQuaternion(q): Matrix4
Parameters
- q: Quaternion
Returns Matrix4
Deprecated
Use .makeRotationFromQuaternion() instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:295

multiplyVector3

multiplyVector3(v): any
Parameters
- v: any
Returns any
Deprecated
Use vector.applyMatrix4( matrix ) instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:300

multiplyVector4

multiplyVector4(v): any
Parameters
- v: any
Returns any
Deprecated
Use vector.applyMatrix4( matrix ) instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:305

multiplyVector3Array

multiplyVector3Array(array): number[]
Parameters
- array: number[]
Returns number[]
Deprecated
This method has been removed completely.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:310

rotateAxis

rotateAxis(v): void
Parameters
- v: any
Returns void
Deprecated
Use Vector3.transformDirection( matrix ) instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:315

crossVector

crossVector(v): void
Parameters
- v: any
Returns void
Deprecated
Use vector.applyMatrix4( matrix ) instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:320

flattenToArrayOffset

flattenToArrayOffset(array, offset): number[]
Parameters
- array: number[]
- offset: number
Returns number[]
Deprecated
Use .toArray() instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:325

getInverse

getInverse(matrix): Matrix
Parameters
- matrix: Matrix
Returns Matrix
Deprecated
Use .invert() instead.
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:330

Class Matrix4

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Matrix4

Parameters

Returns Matrix4

Properties

ReadonlyisMatrix4

elements

Default

Methods

set

Parameters

Returns this

identity

Returns this

clone

Returns Matrix4

copy

Parameters

Returns this

copyPosition

Parameters

Returns this

extractBasis

Parameters

Returns this

makeBasis

Parameters

Returns this

extractRotation

Parameters

Returns this

makeRotationFromEuler

Parameters

Returns this

makeRotationFromQuaternion

Parameters

Returns this

lookAt

Parameters

Returns this

multiply

Parameters

Returns this

premultiply

Parameters

Returns this

multiplyMatrices

Parameters

Returns this

multiplyToArray

Parameters

Returns Matrix4

Deprecated

multiplyScalar

Parameters

Returns this

determinant

Returns number

transpose

Returns this

setPosition

Parameters

Returns this

Parameters

Returns this

invert

Returns this

scale

Parameters

Returns this

getMaxScaleOnAxis

Returns number

`Readonly`isMatrix4