Class Matrix3

Serializable THREE.js Matrix3

Hierarchy-Diagram

Legend

class

Hierarchy

Matrix3
- Matrix3

Constructors

constructor

new Matrix3(): Matrix3
Creates an identity matrix.

Returns Matrix3
Inherited from THREE.Matrix3.constructor
- Defined in src/three/math/Matrix3.d.ts:57

Properties

elements

elements: number[]

Methods

clone

clone(): Matrix3
Returns Matrix3
Overrides THREE.Matrix3.clone
- Defined in src/utils/math/Matrix3.ts:25

copy

copy(m: Matrix3): Matrix3
Parameters
- m: Matrix3
Returns Matrix3
Inherited from THREE.Matrix3.copy
- Defined in src/three/math/Matrix3.d.ts:78

determinant

determinant(): number
Returns number
Inherited from THREE.Matrix3.determinant
- Defined in src/three/math/Matrix3.d.ts:82

equals

equals(matrix: Matrix3): boolean
Parameters
- matrix: Matrix3
Returns boolean
Inherited from THREE.Matrix3.equals
- Defined in src/three/math/Matrix3.d.ts:152

extractBasis

extractBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): Matrix3
Parameters
- xAxis: Vector3
- yAxis: Vector3
- zAxis: Vector3
Returns Matrix3
Inherited from THREE.Matrix3.extractBasis
- Defined in src/three/math/Matrix3.d.ts:79

flattenToArrayOffset

flattenToArrayOffset(array: number[], offset: number): number[]
Deprecated
Use .toArray() instead.
Parameters
- array: number[]
- offset: number
Returns number[]
Inherited from THREE.Matrix3.flattenToArrayOffset
- Defined in src/three/math/Matrix3.d.ts:209

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Matrix3
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 Matrix3
Inherited from THREE.Matrix3.fromArray
- Defined in src/three/math/Matrix3.d.ts:159

getInverse

getInverse(matrix: Matrix4, throwOnDegenerate?: boolean): Matrix3
Deprecated
Use .invert() instead.
Parameters
- matrix: Matrix4
- Optional throwOnDegenerate: boolean
Returns Matrix3
Inherited from THREE.Matrix3.getInverse
- Defined in src/three/math/Matrix3.d.ts:203
getInverse(matrix: Matrix): Matrix
Parameters
- matrix: Matrix
Returns Matrix
Inherited from THREE.Matrix3.getInverse
- Defined in src/three/math/Matrix3.d.ts:204

getNormalMatrix

getNormalMatrix(matrix4: Matrix4): Matrix3
Parameters
- matrix4: Matrix4
Returns Matrix3
Inherited from THREE.Matrix3.getNormalMatrix
- Defined in src/three/math/Matrix3.d.ts:93

identity

identity(): Matrix3
Returns Matrix3
Inherited from THREE.Matrix3.identity
- Defined in src/three/math/Matrix3.d.ts:76

invert

invert(): Matrix3
Inverts this matrix in place.

Returns Matrix3
Inherited from THREE.Matrix3.invert
- Defined in src/three/math/Matrix3.d.ts:87

makeRotation

makeRotation(theta: number): Matrix3
Sets this matrix as a 2D rotational transformation by theta radians. The resulting matrix will be:
```
cos(θ) -sin(θ) 0
sin(θ) cos(θ)  0
0      0       1
```
Parameters
- theta: number
  
  Rotation angle in radians. Positive values rotate counterclockwise.
Returns Matrix3
Inherited from THREE.Matrix3.makeRotation
- Defined in src/three/math/Matrix3.d.ts:130
makeRotation(theta: number): Matrix3
Parameters
- theta: number
Returns Matrix3
Inherited from THREE.Matrix3.makeRotation
- Defined in src/three/math/Matrix3.d.ts:131

makeScale

makeScale(x: number, y: number): Matrix3
Sets this matrix as a 2D scale transform:
```
x, 0, 0,
0, y, 0,
0, 0, 1
```
Parameters
- x: number
  
  the amount to scale in the X axis.
- y: number
  
  the amount to scale in the Y axis.
Returns Matrix3
Inherited from THREE.Matrix3.makeScale
- Defined in src/three/math/Matrix3.d.ts:145
makeScale(x: number, y: number): Matrix3
Parameters
- x: number
- y: number
Returns Matrix3
Inherited from THREE.Matrix3.makeScale
- Defined in src/three/math/Matrix3.d.ts:146

makeTranslation

makeTranslation(x: number, y: number): Matrix3
Sets this matrix as a 2D translation transform:
```
1, 0, x,
0, 1, y,
0, 0, 1
```
Parameters
- x: number
  
  the amount to translate in the X axis.
- y: number
  
  the amount to translate in the Y axis.
Returns Matrix3
Inherited from THREE.Matrix3.makeTranslation
- Defined in src/three/math/Matrix3.d.ts:116
makeTranslation(x: number, y: number): Matrix3
Parameters
- x: number
- y: number
Returns Matrix3
Inherited from THREE.Matrix3.makeTranslation
- Defined in src/three/math/Matrix3.d.ts:117

multiply

multiply(m: Matrix3): Matrix3
Multiplies this matrix by m.
Parameters
- m: Matrix3
Returns Matrix3
Inherited from THREE.Matrix3.multiply
- Defined in src/three/math/Matrix3.d.ts:181

multiplyMatrices

multiplyMatrices(a: Matrix3, b: Matrix3): Matrix3
Sets this matrix to a x b.
Parameters
- a: Matrix3
- b: Matrix3
Returns Matrix3
Inherited from THREE.Matrix3.multiplyMatrices
- Defined in src/three/math/Matrix3.d.ts:188

multiplyScalar

multiplyScalar(s: number): Matrix3
Parameters
- s: number
Returns Matrix3
Inherited from THREE.Matrix3.multiplyScalar
- Defined in src/three/math/Matrix3.d.ts:81

multiplyVector3

multiplyVector3(vector: Vector3): any
Deprecated
Use vector.applyMatrix3( matrix ) instead.
Parameters
- vector: Vector3
Returns any
Inherited from THREE.Matrix3.multiplyVector3
- Defined in src/three/math/Matrix3.d.ts:193

multiplyVector3Array

multiplyVector3Array(a: any): any
Deprecated
This method has been removed completely.
Parameters
- a: any
Returns any
Inherited from THREE.Matrix3.multiplyVector3Array
- Defined in src/three/math/Matrix3.d.ts:198

premultiply

premultiply(m: Matrix3): Matrix3
Parameters
- m: Matrix3
Returns Matrix3
Inherited from THREE.Matrix3.premultiply
- Defined in src/three/math/Matrix3.d.ts:183

rotate

rotate(theta: number): Matrix3
Parameters
- theta: number
Returns Matrix3
Inherited from THREE.Matrix3.rotate
- Defined in src/three/math/Matrix3.d.ts:148

scale

scale(sx: number, sy: number): Matrix3
Parameters
- sx: number
- sy: number
Returns Matrix3
Inherited from THREE.Matrix3.scale
- Defined in src/three/math/Matrix3.d.ts:102

set

set(n11: number, n12: number, n13: number, n21: number, n22: number, n23: number, n31: number, n32: number, n33: number): Matrix3
Parameters
- n11: number
- n12: number
- n13: number
- n21: number
- n22: number
- n23: number
- n31: number
- n32: number
- n33: number
Returns Matrix3
Inherited from THREE.Matrix3.set
- Defined in src/three/math/Matrix3.d.ts:65

setFromMatrix4

setFromMatrix4(m: Matrix4): Matrix3
Parameters
- m: Matrix4
Returns Matrix3
Inherited from THREE.Matrix3.setFromMatrix4
- Defined in src/three/math/Matrix3.d.ts:80

setUvTransform

setUvTransform(tx: number, ty: number, sx: number, sy: number, rotation: number, cx: number, cy: number): Matrix3
Parameters
- tx: number
- ty: number
- sx: number
- sy: number
- rotation: number
- cx: number
- cy: number
Returns Matrix3
Inherited from THREE.Matrix3.setUvTransform
- Defined in src/three/math/Matrix3.d.ts:100

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[]
Inherited from THREE.Matrix3.toArray
- Defined in src/three/math/Matrix3.d.ts:167
toArray(array?: Matrix3Tuple, offset?: 0): Matrix3Tuple
Parameters
- Optional array: Matrix3Tuple
- Optional offset: 0
Returns Matrix3Tuple
Inherited from THREE.Matrix3.toArray
- Defined in src/three/math/Matrix3.d.ts:168
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>
Inherited from THREE.Matrix3.toArray
- Defined in src/three/math/Matrix3.d.ts:176

translate

translate(tx: number, ty: number): Matrix3
Parameters
- tx: number
- ty: number
Returns Matrix3
Inherited from THREE.Matrix3.translate
- Defined in src/three/math/Matrix3.d.ts:150

transpose

transpose(): Matrix3
Transposes this matrix in place.

Returns Matrix3
Inherited from THREE.Matrix3.transpose
- Defined in src/three/math/Matrix3.d.ts:92

transposeIntoArray

transposeIntoArray(r: number[]): Matrix3
Transposes this matrix into the supplied array r, and returns itself.
Parameters
- r: number[]
Returns Matrix3
Inherited from THREE.Matrix3.transposeIntoArray
- Defined in src/three/math/Matrix3.d.ts:98

`Static` fromArray

fromArray<T>(array: number[][]): T
Create a matrix from array

Returns
Matrix3
Type Parameters
- T extends Matrix3<T>
Parameters
- array: number[][]
  
  Array
Returns T
- Defined in src/utils/math/Matrix3.ts:18

Class Matrix3

Hierarchy-Diagram

Legend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Matrix3

Properties

elements

Methods

clone

Returns Matrix3

copy

Parameters

m: Matrix3

Returns Matrix3

determinant

Returns number

equals

Parameters

matrix: Matrix3

Returns boolean

extractBasis

Parameters

xAxis: Vector3

yAxis: Vector3

zAxis: Vector3

Returns Matrix3

flattenToArrayOffset

Deprecated

Parameters

array: number[]

offset: number

Returns number[]

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns Matrix3

getInverse

Deprecated

Parameters

matrix: Matrix4

Optional throwOnDegenerate: boolean

Returns Matrix3

Parameters

matrix: Matrix

Returns Matrix

getNormalMatrix

Parameters

matrix4: Matrix4

Returns Matrix3

identity

Returns Matrix3

invert

Returns Matrix3

makeRotation

Parameters

theta: number

Returns Matrix3

Parameters

theta: number

Returns Matrix3

makeScale

Parameters

x: number

y: number

Returns Matrix3

Parameters

x: number

y: number

Returns Matrix3

makeTranslation

Parameters

x: number

y: number

`Optional` offset: number

`Optional` throwOnDegenerate: boolean