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

Hierarchy

Matrix4

Implements

Matrix

Constructors

constructor

new Matrix4(): Matrix4
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:44

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
Implementation of Matrix.clone
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:78

compose

compose(translation: THREE.Vector3, rotation: Quaternion, scale: THREE.Vector3): Matrix4
Sets this matrix to the transformation composed of translation, rotation and scale.
Parameters
- translation: THREE.Vector3
- rotation: Quaternion
- scale: THREE.Vector3
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:195

copy

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

copyPosition

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

crossVector

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

decompose

decompose(translation: THREE.Vector3, rotation: Quaternion, scale: THREE.Vector3): Matrix4
Decomposes this matrix into it's position, quaternion and scale components.
Parameters
- translation: THREE.Vector3
- rotation: Quaternion
- scale: THREE.Vector3
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:200

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:124

equals

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

extractBasis

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

extractPosition

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

extractRotation

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

flattenToArrayOffset

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

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Matrix4
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 Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:223

getInverse

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

getMaxScaleOnAxis

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

identity

identity(): Matrix4
Resets this matrix to identity.

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

invert

invert(): Matrix4
Inverts this matrix.

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

lookAt

lookAt(eye: THREE.Vector3, target: THREE.Vector3, up: THREE.Vector3): Matrix4
Constructs a rotation matrix, looking from eye towards center with defined up vector.
Parameters
- eye: THREE.Vector3
- target: THREE.Vector3
- up: THREE.Vector3
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:93

makeBasis

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

makeOrthographic

makeOrthographic(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4
Creates an orthographic projection matrix.
Parameters
- left: number
- right: number
- top: number
- bottom: number
- near: number
- far: number
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:215

makePerspective

makePerspective(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4
Creates a frustum matrix.
Parameters
- left: number
- right: number
- bottom: number
- top: number
- near: number
- far: number
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:205
makePerspective(fov: number, aspect: number, near: number, far: number): Matrix4
Creates a perspective projection matrix.
Parameters
- fov: number
- aspect: number
- near: number
- far: number
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:210

makeRotationAxis

makeRotationAxis(axis: THREE.Vector3, angle: number): Matrix4
Sets this matrix as rotation transform around axis by angle radians. Based on http://www.gamedev.net/reference/articles/article1199.asp.
Parameters
- axis: THREE.Vector3
  
  Rotation axis.
- angle: number
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:180

makeRotationFromEuler

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

makeRotationFromQuaternion

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

makeRotationX

makeRotationX(theta: number): Matrix4
Sets this matrix as rotation transform around x axis by theta radians.
Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:157

makeRotationY

makeRotationY(theta: number): Matrix4
Sets this matrix as rotation transform around y axis by theta radians.
Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:164

makeRotationZ

makeRotationZ(theta: number): Matrix4
Sets this matrix as rotation transform around z axis by theta radians.
Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:171

makeScale

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

makeShear

makeShear(xy: number, xz: number, yx: number, yz: number, zx: number, zy: number): Matrix4
Sets this matrix as shear transform.
Parameters
- xy: number
- xz: number
- yx: number
- yz: number
- zx: number
- zy: number
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:190

makeTranslation

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

multiply

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

multiplyMatrices

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

multiplyScalar

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

multiplyToArray

multiplyToArray(a: Matrix4, b: Matrix4, r: number[]): 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.

Deprecated
This method has been removed completely.
Parameters
- a: Matrix4
- b: Matrix4
- r: number[]
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:113

multiplyVector3

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

multiplyVector3Array

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

multiplyVector4

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

premultiply

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

rotateAxis

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

scale

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

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

setFromMatrix3

setFromMatrix3(m: Matrix3): Matrix4
Set the upper 3x3 elements of this matrix to the values of the Matrix3 m.
Parameters
- m: Matrix3
Returns Matrix4
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:245

setPosition

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

setRotationFromQuaternion

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

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array with the values of this matrix, or copies them into the provided array.

Returns
The created or 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[]
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:231
toArray(array?: Matrix4Tuple, offset?: 0): Matrix4Tuple
Parameters
- Optional array: Matrix4Tuple
- Optional offset: 0
Returns Matrix4Tuple
- Defined in node_modules/@types/three/src/math/Matrix4.d.ts:232
toArray(array?: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies he values of this matrix into the provided array-like.

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

transpose

transpose(): Matrix4
Transposes this matrix.

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

Class Matrix4

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Matrix4

Properties

elements

Default

Methods

clone

Returns Matrix4

compose

Parameters

translation: THREE.Vector3

rotation: Quaternion

scale: THREE.Vector3

Returns Matrix4

copy

Parameters

m: Matrix4

Returns Matrix4

copyPosition

Parameters

m: Matrix4

Returns Matrix4

crossVector

Deprecated

Parameters

v: any

Returns void

decompose

Parameters

translation: THREE.Vector3

rotation: Quaternion

scale: THREE.Vector3

Returns Matrix4

determinant

Returns number

equals

Parameters

matrix: Matrix4

Returns boolean

extractBasis

Parameters

xAxis: THREE.Vector3

yAxis: THREE.Vector3

zAxis: THREE.Vector3

Returns Matrix4

extractPosition

Deprecated

Parameters

m: Matrix4

Returns Matrix4

extractRotation

Parameters

m: Matrix4

Returns Matrix4

flattenToArrayOffset

Deprecated

Parameters

array: number[]

offset: number

Returns number[]

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns Matrix4

getInverse

Deprecated

Parameters

matrix: Matrix

Returns Matrix

getMaxScaleOnAxis

`Optional` offset: number