Class Matrix3

Hierarchy

Matrix3

Constructors

constructor

new Matrix3(): Matrix3
Creates a new Matrix3 object and initializes the mat array with the given values.

Returns Matrix3
- Defined in src/math/Matrix3.ts:196

Properties

mat

mat: number[]

An array of 9 numbers representing a 3x3 matrix

`Static` `Readonly` IDENTITY

IDENTITY: Matrix3 = ...

A static Matrix3 object representing the identity matrix

Methods

clone

clone(): Matrix3
Creates a new Matrix3 object with the same values as this Matrix3.

Returns
A new Matrix3 object with the same values as this Matrix3.

Returns Matrix3
- Defined in src/math/Matrix3.ts:277

compose

compose(position: Vector2, rotation: number, scale: Vector2, shear: null | Vector2): void
Compose the current Matrix3 object from position, rotation, and scale
Parameters
- position: Vector2
  
  The Vector2 representing the position
- rotation: number
  
  The angle to rotate by, in radians
- scale: Vector2
  
  The Vector2 representing the scale to apply
- shear: null | Vector2
Returns void
- Defined in src/math/Matrix3.ts:521

copy

copy(m: Matrix3): void
Copies the values of the specified Matrix3 into this Matrix3.
Parameters
- m: Matrix3
  
  The Matrix3 to copy the values from
Returns void
- Defined in src/math/Matrix3.ts:266

decompose

decompose(): [Vector2, number, Vector2, null | Vector2]
Returns [Vector2, number, Vector2, null | Vector2]
- Defined in src/math/Matrix3.ts:576

element

element(row: number, col: number): number
Returns the element at the specified row and column of the Matrix3.

Returns
The element at the specified row and column of the Matrix3
Parameters
- row: number
  
  The row of the element to return
- col: number
  
  The column of the element to return
Returns number
- Defined in src/math/Matrix3.ts:295

getColumn

getColumn(i: number): Vector2
Parameters
- i: number
Returns Vector2
- Defined in src/math/Matrix3.ts:554

getRotation

getRotation(): number
Gets the rotation quaternion of this Matrix4 object

Returns
The rotation angle in radians

Returns number
- Defined in src/math/Matrix3.ts:422

getRow

getRow(i: number): Vector2
Parameters
- i: number
Returns Vector2
- Defined in src/math/Matrix3.ts:559

getScale

getScale(): Vector2
Gets the scale vector of this Matrix3 object

Returns
The Vector2 representing the scale vector

Returns Vector2
- Defined in src/math/Matrix3.ts:432

getShear

getShear(): Vector2
Gets the shear angles of this Matrix3 object

Returns
The Vector2 containing the X and Y shear angles

Returns Vector2
- Defined in src/math/Matrix3.ts:445

getTranslation

getTranslation(): Vector2
Gets the translation vector of this Matrix3 object

Returns
The Vector2 representing the translation vector

Returns Vector2
- Defined in src/math/Matrix3.ts:412

inverse

inverse(): Matrix3
Computes the inverse of this matrix.

Returns
The inverse of this matrix

Returns Matrix3
- Defined in src/math/Matrix3.ts:465

invert

invert(): void
Inverts this matrix in place.

Returns void
- Defined in src/math/Matrix3.ts:494

multiply

multiply(rhs: Matrix3): void
Multiplies this Matrix4 with another Matrix3 on the right hand side, and sets this Matrix3 to the result.
Parameters
- rhs: Matrix3
  
  The Matrix3 to multiply with.
Returns void
- Defined in src/math/Matrix3.ts:317

multiplyScalar

multiplyScalar(x: number): void
Parameters
- x: number
Returns void
- Defined in src/math/Matrix3.ts:454

premultiply

premultiply(lhs: Matrix3): void
Multiplies this Matrix4 with another Matrix3 on the left hand side, and sets this Matrix3 to the result.
Parameters
- lhs: Matrix3
Returns void
- Defined in src/math/Matrix3.ts:337

set

set(value: number, row: number, col: number): void
Sets the value of the specified element in the Matrix3.
Parameters
- value: number
  
  The value to set
- row: number
  
  The row of the element to set
- col: number
  
  The column of the element to set
Returns void
- Defined in src/math/Matrix3.ts:307

setColumn

setColumn(col: number, v: Vector2): void
Parameters
- col: number
- v: Vector2
Returns void
- Defined in src/math/Matrix3.ts:564

setColumnMajor

setColumnMajor(n1: number, n2: number, n3: number, n4: number, n5: number, n6: number, n7: number, n8: number, n9: number): void
Sets the elements of the Matrix3 in column major order.
Parameters
- n1: number
  
  The first element in the first column
- n2: number
  
  The second element in the first column
- n3: number
  
  The third element in the first column
- n4: number
  
  The first element in the second column
- n5: number
  
  The second element in the second column
- n6: number
  
  The third element in the second column
- n7: number
  
  The first element in the third column
- n8: number
  
  The second element in the third column
- n9: number
  
  The third element in the third column
Returns void
- Defined in src/math/Matrix3.ts:218

setRotation

setRotation(angle: number): void
Sets the rotation of this matrix from a given angle.
Parameters
- angle: number
  
  The angle in radians to set the rotation from.
Returns void
- Defined in src/math/Matrix3.ts:371

setRow

setRow(row: number, v: Vector2): void
Parameters
- row: number
- v: Vector2
Returns void
- Defined in src/math/Matrix3.ts:570

setRowMajor

setRowMajor(n1: number, n2: number, n3: number, n4: number, n5: number, n6: number, n7: number, n8: number, n9: number): void
Sets the elements of the Matrix3 in row major order.
Parameters
- n1: number
  
  The first element in the first row
- n2: number
  
  The second element in the first row
- n3: number
  
  The third element in the first row
- n4: number
  
  The first element in the second row
- n5: number
  
  The second element in the second row
- n6: number
  
  The third element in the second row
- n7: number
  
  The first element in the third row
- n8: number
  
  The second element in the third row
- n9: number
  
  The third element in the third row
Returns void
- Defined in src/math/Matrix3.ts:246

setScale

setScale(scale: Vector2): void
Sets the scale of this matrix from a Vector2.
Parameters
- scale: Vector2
  
  The Vector2 to set the scale from.
Returns void
- Defined in src/math/Matrix3.ts:388

setShear

setShear(shear: Vector2): void
Parameters
- shear: Vector2
Returns void
- Defined in src/math/Matrix3.ts:397

setTranslation

setTranslation(v: Vector2): void
Sets the translation of this matrix from a Vector2.
Parameters
- v: Vector2
  
  The Vector2 to set the translation from.
Returns void
- Defined in src/math/Matrix3.ts:357

transformPoint

transformPoint(v: Vector2): Vector2
Parameters
- v: Vector2
Returns Vector2
- Defined in src/math/Matrix3.ts:536

transformVector

transformVector(v: Vector2): Vector2
Parameters
- v: Vector2
Returns Vector2
- Defined in src/math/Matrix3.ts:545

transpose

transpose(): Matrix3
Transposes this matrix.

Returns
The transposed matrix.

Returns Matrix3
- Defined in src/math/Matrix3.ts:505

`Static` compose

compose(position?: Vector2, rotation?: number, scale?: Vector2): Matrix3
Creates a Matrix3 object from position, rotation, and scale

Returns
The resulting Matrix3 object
Parameters
- position: Vector2 = Vector2.ZERO
  
  The Vector2 representing the position
- rotation: number = 0
  
  The angle to rotate by, in radians
- scale: Vector2 = Vector2.ONE
  
  The Vector2 representing the scale to apply
Returns Matrix3
- Defined in src/math/Matrix3.ts:165

`Static` copy

copy(m: Matrix3): Matrix3
Creates a copy of a Matrix3 object

Returns
A new Matrix3 object representing a copy of the input Matrix3
Parameters
- m: Matrix3
  
  The Matrix3 object to be copied
Returns Matrix3
- Defined in src/math/Matrix3.ts:46

`Static` fromColumnMajor

fromColumnMajor(n1: number, n2: number, n3: number, n4: number, n5: number, n6: number, n7: number, n8: number, n9: number): Matrix3
Creates a new Matrix3 object from 9 numbers representing a column-major matrix

Returns
A new Matrix3 object created from the given numbers
Parameters
- n1: number
  
  Number in column 1, row 1
- n2: number
  
  Number in column 2, row 1
- n3: number
  
  Number in column 3, row 1
- n4: number
  
  Number in column 1, row 2
- n5: number
  
  Number in column 2, row 2
- n6: number
  
  Number in column 3, row 2
- n7: number
  
  Number in column 1, row 3
- n8: number
  
  Number in column 2, row 3
- n9: number
  
  Number in column 3, row 3
Returns Matrix3
- Defined in src/math/Matrix3.ts:90

`Static` fromRowMajor

fromRowMajor(n1: number, n2: number, n3: number, n4: number, n5: number, n6: number, n7: number, n8: number, n9: number): Matrix3
Creates a new Matrix3 object from 9 numbers representing a row-major matrix

Returns
A new Matrix3 object created from the given numbers
Parameters
- n1: number
  
  Number in row 1, column 1
- n2: number
  
  Number in row 1, column 2
- n3: number
  
  Number in row 1, column 3
- n4: number
  
  Number in row 2, column 1
- n5: number
  
  Number in row 2, column 2
- n6: number
  
  Number in row 2, column 3
- n7: number
  
  Number in row 3, column 1
- n8: number
  
  Number in row 3, column 2
- n9: number
  
  Number in row 3, column 3
Returns Matrix3
- Defined in src/math/Matrix3.ts:67

`Static` makeRotation

makeRotation(angle: number): Matrix3
Creates a new Matrix3 object representing a rotation matrix

Returns
A new Matrix3 object representing a rotation matrix
Parameters
- angle: number
  
  The angle of rotation, in radians
Returns Matrix3
- Defined in src/math/Matrix3.ts:120

`Static` makeScale

makeScale(scale: Vector2): Matrix3
Creates a new Matrix3 object representing a scaling matrix

Returns
A new Matrix3 object representing a scaling matrix
Parameters
- scale: Vector2
  
  The Vector2 object representing the x and y scaling factors
Returns Matrix3
- Defined in src/math/Matrix3.ts:138

`Static` makeShear

makeShear(shear: Vector2): Matrix3
Parameters
- shear: Vector2
Returns Matrix3
- Defined in src/math/Matrix3.ts:147

`Static` makeTranslation

makeTranslation(v: Vector2): Matrix3
Creates a new Matrix3 object representing a translation matrix

Returns
A new Matrix3 object representing a translation matrix
Parameters
- v: Vector2
  
  The Vector2 object representing the translation vector
Returns Matrix3
- Defined in src/math/Matrix3.ts:105

`Static` multiply

multiply(lhs: Matrix3, rhs: Matrix3): Matrix3
Multiplies two 3x3 matrices, m1 and m2, and returns the result as a new Matrix3

Returns
A new Matrix3 object representing the product of m1 and m2
Parameters
- lhs: Matrix3
- rhs: Matrix3
Returns Matrix3
- Defined in src/math/Matrix3.ts:22

`Static` transformPoint

transformPoint(v: Vector2, m: Matrix3): Vector2
Parameters
- v: Vector2
- m: Matrix3
Returns Vector2
- Defined in src/math/Matrix3.ts:175

`Static` transformVector

transformVector(v: Vector2, m: Matrix3): Vector2
Parameters
- v: Vector2
- m: Matrix3
Returns Vector2
- Defined in src/math/Matrix3.ts:184

Class Matrix3

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Matrix3

Properties

mat

Static Readonly IDENTITY

Methods

clone

Returns

Returns Matrix3

compose

Parameters

position: Vector2

rotation: number

scale: Vector2

shear: null | Vector2

Returns void

copy

Parameters

m: Matrix3

Returns void

decompose

Returns [Vector2, number, Vector2, null | Vector2]

element

Returns

Parameters

row: number

col: number

Returns number

getColumn

Parameters

i: number

Returns Vector2

getRotation

Returns

Returns number

getRow

Parameters

i: number

Returns Vector2

getScale

Returns

Returns Vector2

getShear

Returns

Returns Vector2

getTranslation

Returns

Returns Vector2

inverse

Returns

Returns Matrix3

invert

Returns void

multiply

Parameters

rhs: Matrix3

Returns void

multiplyScalar

Parameters

x: number

Returns void

premultiply

Parameters

lhs: Matrix3

Returns void

set

Parameters

value: number

row: number

col: number

Returns void

setColumn

Parameters

`Static` `Readonly` IDENTITY

`Static` compose

`Static` copy