Class Matrix4

A 4x4 Matrix.

example: // Simple rig for rotating around 3 axes var m = new THREE.Matrix4(); var m1 = new THREE.Matrix4(); var m2 = new THREE.Matrix4(); var m3 = new THREE.Matrix4(); var alpha = 0; var beta = Math.PI; var 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

- Defined in RuntimeFull.ts:1704
Returns Matrix4

Properties

elements

elements: Float32Array

Float32Array with matrix values.

Methods

clone

clone(): this

Implementation of Matrix.clone
- Defined in RuntimeFull.ts:1721
Returns this

compose

compose(translation: Vector3, rotation: Quaternion, scale: Vector3): Matrix4

- Defined in RuntimeFull.ts:1834
Sets this matrix to the transformation composed of translation, rotation and scale.

Parameters
- translation: Vector3
- rotation: Quaternion
- scale: Vector3
Returns Matrix4

copy

copy(m: this): this

Implementation of Matrix.copy
- Defined in RuntimeFull.ts:1722
Parameters
- m: this
Returns this

copyPosition

copyPosition(m: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1723
Parameters
- m: Matrix4
Returns Matrix4

crossVector

crossVector(v: any): void

- Defined in RuntimeFull.ts:1893
deprecated

Use {@link Vector3#applyMatrix4 vector.applyMatrix4( matrix )} instead.

Parameters
- v: any
Returns void

decompose

decompose(translation?: Vector3, rotation?: Quaternion, scale?: Vector3): Object[]

- Defined in RuntimeFull.ts:1840
Decomposes this matrix into the translation, rotation and scale components. If parameters are not passed, new instances will be created.

Parameters
- Optional translation: Vector3
- Optional rotation: Quaternion
- Optional scale: Vector3
Returns Object[]

determinant

determinant(): number

Implementation of Matrix.determinant
- Defined in RuntimeFull.ts:1767
Computes determinant of this matrix. Based on http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.htm

Returns number

equals

equals(matrix: Matrix4): boolean

- Defined in RuntimeFull.ts:1856
Parameters
- matrix: Matrix4
Returns boolean

extractBasis

extractBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): Matrix4

- Defined in RuntimeFull.ts:1724
Parameters
- xAxis: Vector3
- yAxis: Vector3
- zAxis: Vector3
Returns Matrix4

extractPosition

extractPosition(m: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1863
deprecated

Use {@link Matrix4#copyPosition .copyPosition()} instead.

Parameters
- m: Matrix4
Returns Matrix4

extractRotation

extractRotation(m: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1730
Copies the rotation component of the supplied matrix m into this matrix rotation component.

Parameters
- m: Matrix4
Returns Matrix4

flattenToArrayOffset

flattenToArrayOffset(array: number[], offset: number): number[]

- Defined in RuntimeFull.ts:1898
deprecated

Use {@link Matrix4#toArray .toArray()} instead.

Parameters
- array: number[]
- offset: number
Returns number[]

fromArray

fromArray(array: number[], offset?: number): Matrix4

- Defined in RuntimeFull.ts:1857
Parameters
- array: number[]
- Optional offset: number
Returns Matrix4

getInverse

getInverse(m: Matrix4, throwOnDegeneratee?: boolean): Matrix4

- Defined in RuntimeFull.ts:1783
Sets this matrix to the inverse of matrix m. Based on http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.htm.

Parameters
- m: Matrix4
- Optional throwOnDegeneratee: boolean
Returns Matrix4

getMaxScaleOnAxis

getMaxScaleOnAxis(): number

- Defined in RuntimeFull.ts:1790
Returns number

identity

identity(): Matrix4

Implementation of Matrix.identity
- Defined in RuntimeFull.ts:1720
Resets this matrix to identity.

Returns Matrix4

lookAt

lookAt(eye: Vector3, target: Vector3, up: Vector3): Matrix4

- Defined in RuntimeFull.ts:1736
Constructs a rotation matrix, looking from eye towards center with defined up vector.

Parameters
- eye: Vector3
- target: Vector3
- up: Vector3
Returns Matrix4

makeBasis

makeBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): Matrix4

- Defined in RuntimeFull.ts:1725
Parameters
- xAxis: Vector3
- yAxis: Vector3
- zAxis: Vector3
Returns Matrix4

makeOrthographic

makeOrthographic(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4

- Defined in RuntimeFull.ts:1855
Creates an orthographic projection matrix.

Parameters
- left: number
- right: number
- top: number
- bottom: number
- near: number
- far: number
Returns Matrix4

makePerspective

makePerspective(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4
makePerspective(fov: number, aspect: number, near: number, far: number): Matrix4

- Defined in RuntimeFull.ts:1845
Creates a frustum matrix.

Parameters
- left: number
- right: number
- bottom: number
- top: number
- near: number
- far: number
Returns Matrix4
- Defined in RuntimeFull.ts:1850
Creates a perspective projection matrix.

Parameters
- fov: number
- aspect: number
- near: number
- far: number
Returns Matrix4

makeRotationAxis

makeRotationAxis(axis: Vector3, angle: number): Matrix4

- Defined in RuntimeFull.ts:1824
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 Matrix4

makeRotationFromEuler

makeRotationFromEuler(euler: Euler): Matrix4

- Defined in RuntimeFull.ts:1731
Parameters
- euler: Euler
Returns Matrix4

makeRotationFromQuaternion

makeRotationFromQuaternion(q: Quaternion): Matrix4

- Defined in RuntimeFull.ts:1732
Parameters
- q: Quaternion
Returns Matrix4

makeRotationX

makeRotationX(theta: number): Matrix4

- Defined in RuntimeFull.ts:1801
Sets this matrix as rotation transform around x axis by theta radians.

Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4

makeRotationY

makeRotationY(theta: number): Matrix4

- Defined in RuntimeFull.ts:1808
Sets this matrix as rotation transform around y axis by theta radians.

Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4

makeRotationZ

makeRotationZ(theta: number): Matrix4

- Defined in RuntimeFull.ts:1815
Sets this matrix as rotation transform around z axis by theta radians.

Parameters
- theta: number
  
  Rotation angle in radians.
Returns Matrix4

makeScale

makeScale(x: number, y: number, z: number): Matrix4

- Defined in RuntimeFull.ts:1829
Sets this matrix as scale transform.

Parameters
- x: number
- y: number
- z: number
Returns Matrix4

makeTranslation

makeTranslation(x: number, y: number, z: number): Matrix4

- Defined in RuntimeFull.ts:1794
Sets this matrix as translation transform.

Parameters
- x: number
- y: number
- z: number
Returns Matrix4

multiply

multiply(m: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1741
Multiplies this matrix by m.

Parameters
- m: Matrix4
Returns Matrix4

multiplyMatrices

multiplyMatrices(a: Matrix4, b: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1748
Sets this matrix to a x b.

Parameters
- a: Matrix4
- b: Matrix4
Returns Matrix4

multiplyScalar

multiplyScalar(s: number): Matrix4

Implementation of Matrix.multiplyScalar
- Defined in RuntimeFull.ts:1761
Multiplies this matrix by s.

Parameters
- s: number
Returns Matrix4

multiplyToArray

multiplyToArray(a: Matrix4, b: Matrix4, r: number[]): Matrix4

- Defined in RuntimeFull.ts:1756
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

multiplyVector3

multiplyVector3(v: any): any

- Defined in RuntimeFull.ts:1873
deprecated

Use {@link Vector3#applyMatrix4 vector.applyMatrix4( matrix )} instead.

Parameters
- v: any
Returns any

multiplyVector3Array

multiplyVector3Array(array: number[]): number[]

- Defined in RuntimeFull.ts:1883
deprecated

This method has been removed completely.

Parameters
- array: number[]
Returns number[]

multiplyVector4

multiplyVector4(v: any): any

- Defined in RuntimeFull.ts:1878
deprecated

Use {@link Vector4#applyMatrix4 vector.applyMatrix4( matrix )} instead.

Parameters
- v: any
Returns any

premultiply

premultiply(m: Matrix4): Matrix4

- Defined in RuntimeFull.ts:1743
Parameters
- m: Matrix4
Returns Matrix4

rotateAxis

rotateAxis(v: any): void

- Defined in RuntimeFull.ts:1888
deprecated

Use {@link Vector3#transformDirection Vector3.transformDirection( matrix )} instead.

Parameters
- v: any
Returns void

scale

scale(v: Vector3): Matrix4

- Defined in RuntimeFull.ts:1788
Multiplies the columns of this matrix by vector v.

Parameters
- v: Vector3
Returns Matrix4

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

- Defined in RuntimeFull.ts:1715
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

setPosition

setPosition(v: Vector3): Matrix4

- Defined in RuntimeFull.ts:1777
Sets the position component for this matrix from vector v.

Parameters
- v: Vector3
Returns Matrix4

setRotationFromQuaternion

setRotationFromQuaternion(q: Quaternion): Matrix4

- Defined in RuntimeFull.ts:1868
deprecated

Use {@link Matrix4#makeRotationFromQuaternion .makeRotationFromQuaternion()} instead.

Parameters
- q: Quaternion
Returns Matrix4

toArray

toArray(): number[]

- Defined in RuntimeFull.ts:1858
Returns number[]

transpose

transpose(): Matrix4

Implementation of Matrix.transpose
- Defined in RuntimeFull.ts:1772
Transposes this matrix.

Returns Matrix4

Generated using TypeDoc