Class Matrix4

Represents a 4x4 square matrix. Can be used to represent 3 dimensional rotation, scale and skew.

Column major layout: | a | e | i | m | | b | f | j | n | | c | g | k | o | | d | h | l | p |

Index

Constructors

constructor

Properties

a b c d e f g h i j k l m n o p Identity Zero

Constructors

constructor

new Matrix4(
    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
Creates a matrix from raw components.
Parameters
- Optionaln11: number
- Optionaln12: number
- Optionaln13: number
- Optionaln14: number
- Optionaln21: number
- Optionaln22: number
- Optionaln23: number
- Optionaln24: number
- Optionaln31: number
- Optionaln32: number
- Optionaln33: number
- Optionaln34: number
- Optionaln41: number
- Optionaln42: number
- Optionaln43: number
- Optionaln44: number
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:955

Properties

a

a: number

Matrix element a (row 1, column 1).

b

b: number

Matrix element b (row 2, column 1).

c

c: number

Matrix element c (row 3, column 1).

d

d: number

Matrix element d (row 4, column 1).

e

e: number

Matrix element e (row 1, column 2).

f

f: number

Matrix element f (row 2, column 2).

g

g: number

Matrix element g (row 3, column 2).

h

h: number

Matrix element h (row 4, column 2).

i

i: number

Matrix element i (row 1, column 3).

j

j: number

Matrix element j (row 2, column 3).

k

k: number

Matrix element k (row 3, column 3).

l

l: number

Matrix element l (row 4, column 3).

m

m: number

Matrix element m (row 1, column 4).

n

n: number

Matrix element n (row 2, column 4).

o

o: number

Matrix element o (row 3, column 4).

p

p: number

Matrix element p (row 4, column 4).

`Static` `Readonly`Identity

Identity: Matrix4

The identity matrix.

`Static` `Readonly`Zero

Zero: Matrix4

The zero matrix.

Methods

[iterator]

"[iterator]"(): IterableIterator<number>
Iterates over the matrix components in column-major order.

Returns IterableIterator<number>
- Defined in node_modules/hisabati/dist/index.d.ts:1107

add

add(matrix: Matrix4): Matrix4
Adds another matrix to this one.
Parameters
- matrix: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:987

addScalar

addScalar(scalar: number): Matrix4
Adds a scalar to each element.
Parameters
- scalar: number
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:991

clone

clone(): Matrix4
Creates a new matrix with the same components.

Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:967

copy

copy(other: Matrix4): this
Copies another matrix into this one.
Parameters
- other: Matrix4
Returns this
- Defined in node_modules/hisabati/dist/index.d.ts:963

determinant

determinant(): number
Returns the determinant of this matrix.

Returns number
- Defined in node_modules/hisabati/dist/index.d.ts:979

divide

divide(matrix: Matrix4): Matrix4
Divides this matrix by another (this = this * inverse(matrix)).
Parameters
- matrix: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1011

divideScalar

divideScalar(scalar: number): Matrix4
Divides each element by a scalar.
Parameters
- scalar: number
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1015

equals

equals(matrix: Matrix4): boolean
Checks component-wise equality.
Parameters
- matrix: Matrix4
Returns boolean
- Defined in node_modules/hisabati/dist/index.d.ts:1023

invert

invert(): Matrix4
Inverts this matrix in place.

Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1019

multiply

multiply(matrix: Matrix4): Matrix4
Multiplies this matrix by another.
Parameters
- matrix: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1003

multiplyScalar

multiplyScalar(scalar: number): Matrix4
Multiplies each element by a scalar.
Parameters
- scalar: number
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1007

serialize

serialize(): Matrix4Like
Serializes this matrix.

Returns Matrix4Like
- Defined in node_modules/hisabati/dist/index.d.ts:971

set

set(
    e11: number,
    e12: number,
    e13: number,
    e14: number,
    e21: number,
    e22: number,
    e23: number,
    e24: number,
    e31: number,
    e32: number,
    e33: number,
    e34: number,
    e41: number,
    e42: number,
    e43: number,
    e44: number,
): this
Sets this matrix from raw components.
Parameters
- e11: number
- e12: number
- e13: number
- e14: number
- e21: number
- e22: number
- e23: number
- e24: number
- e31: number
- e32: number
- e33: number
- e34: number
- e41: number
- e42: number
- e43: number
- e44: number
Returns this
- Defined in node_modules/hisabati/dist/index.d.ts:959

subtract

subtract(matrix: Matrix4): Matrix4
Subtracts another matrix from this one.
Parameters
- matrix: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:995

subtractScalar

subtractScalar(scalar: number): Matrix4
Subtracts a scalar from each element.
Parameters
- scalar: number
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:999

trace

trace(): number
Returns the trace of this matrix.

Returns number
- Defined in node_modules/hisabati/dist/index.d.ts:983

transpose

transpose(): Matrix4
Transposes this matrix in place.

Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:975

`Static`add

add(matrix1: Matrix4, matrix2: Matrix4, out?: Matrix4): Matrix4
Adds two matrices.
Parameters
- matrix1: Matrix4
- matrix2: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1067

`Static`addScalar

addScalar(matrix: Matrix4, scalar: number, out?: Matrix4): Matrix4
Adds a scalar to each element.
Parameters
- matrix: Matrix4
- scalar: number
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1071

`Static`copy

copy(matrix: Matrix4, out?: Matrix4): Matrix4
Copies a matrix into an output matrix.
Parameters
- matrix: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1031

`Static`deserialize

deserialize(value: Matrix4Like, out?: Matrix4): Matrix4
Deserializes a matrix from an array.
Parameters
- value: Matrix4Like
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1039

`Static`determinant

determinant(matrix: Matrix4): number
Computes the determinant of a matrix.
Parameters
- matrix: Matrix4
Returns number
- Defined in node_modules/hisabati/dist/index.d.ts:1059

`Static`divide

divide(matrix1: Matrix4, matrix2: Matrix4, out?: Matrix4): Matrix4
Divides two matrices (out = matrix1 * inverse(matrix2)).
Parameters
- matrix1: Matrix4
- matrix2: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1091

`Static`divideScalar

divideScalar(matrix: Matrix4, scalar: number, out?: Matrix4): Matrix4
Divides a matrix by a scalar.
Parameters
- matrix: Matrix4
- scalar: number
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1095

`Static`equal

equal(matrix1: Matrix4, matrix2: Matrix4): boolean
Checks component-wise equality for two matrices.
Parameters
- matrix1: Matrix4
- matrix2: Matrix4
Returns boolean
- Defined in node_modules/hisabati/dist/index.d.ts:1103

`Static`identity

identity(out?: Matrix4): Matrix4
Writes the identity matrix.
Parameters
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1051

`Static`invert

invert(matrix: Matrix4, out?: Matrix4): Matrix4
Inverts a matrix.
Parameters
- matrix: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1099

`Static`multiply

multiply(matrix1: Matrix4, matrix2: Matrix4, out?: Matrix4): Matrix4
Multiplies two matrices.
Parameters
- matrix1: Matrix4
- matrix2: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1083

`Static`multiplyScalar

multiplyScalar(matrix: Matrix4, scalar: number, out?: Matrix4): Matrix4
Multiplies a matrix by a scalar.
Parameters
- matrix: Matrix4
- scalar: number
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1087

`Static`serialize

serialize(value: Matrix4): Matrix4Like
Serializes a matrix to an array.
Parameters
- value: Matrix4
Returns Matrix4Like
- Defined in node_modules/hisabati/dist/index.d.ts:1035

`Static`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,
    out?: Matrix4,
): Matrix4
Creates or overwrites a matrix from raw components.
Parameters
- Optionaln11: number
- Optionaln12: number
- Optionaln13: number
- Optionaln14: number
- Optionaln21: number
- Optionaln22: number
- Optionaln23: number
- Optionaln24: number
- Optionaln31: number
- Optionaln32: number
- Optionaln33: number
- Optionaln34: number
- Optionaln41: number
- Optionaln42: number
- Optionaln43: number
- Optionaln44: number
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1027

`Static`subtract

subtract(matrix1: Matrix4, matrix2: Matrix4, out?: Matrix4): Matrix4
Subtracts two matrices.
Parameters
- matrix1: Matrix4
- matrix2: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1075

`Static`subtractScalar

subtractScalar(matrix: Matrix4, scalar: number, out?: Matrix4): Matrix4
Subtracts a scalar from each element.
Parameters
- matrix: Matrix4
- scalar: number
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1079

`Static`trace

trace(matrix: Matrix4): number
Computes the trace of a matrix.
Parameters
- matrix: Matrix4
Returns number
- Defined in node_modules/hisabati/dist/index.d.ts:1063

`Static`transpose

transpose(matrix: Matrix4, out?: Matrix4): Matrix4
Transposes a matrix.
Parameters
- matrix: Matrix4
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1047

`Static`validateSerial

validateSerial(value: unknown): value is Matrix4Like
Checks whether a value is a valid matrix serial.
Parameters
- value: unknown
Returns value is Matrix4Like
- Defined in node_modules/hisabati/dist/index.d.ts:1043

`Static`zero

zero(out?: Matrix4): Matrix4
Writes the zero matrix.
Parameters
- Optionalout: Matrix4
Returns Matrix4
- Defined in node_modules/hisabati/dist/index.d.ts:1055

Class Matrix4

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Matrix4

Properties

a

b

c

d

e

f

g

h

i

j

k

l

m

n

o

p

Static ReadonlyIdentity

Static ReadonlyZero

Methods

[iterator]

Returns IterableIterator<number>

add

Parameters

Returns Matrix4

addScalar

Parameters

Returns Matrix4

clone

Returns Matrix4

copy

Parameters

Returns this

determinant

Returns number

divide

Parameters

Returns Matrix4

divideScalar

Parameters

Returns Matrix4

equals

Parameters

Returns boolean

invert

Returns Matrix4

multiply

Parameters

Returns Matrix4

multiplyScalar

Parameters

Returns Matrix4

serialize

Returns Matrix4Like

set

Parameters

Returns this

subtract

Parameters

Returns Matrix4

subtractScalar

Parameters

Returns Matrix4

trace

Returns number

transpose

Returns Matrix4

Staticadd

Parameters

Returns Matrix4

StaticaddScalar

`Static` `Readonly`Identity

`Static` `Readonly`Zero

`Static`add

`Static`addScalar

`Static`copy

`Static`deserialize

`Static`determinant

`Static`divide

`Static`divideScalar

`Static`equal

`Static`identity

`Static`invert

`Static`multiply

`Static`multiplyScalar

`Static`serialize

`Static`set

`Static`subtract

`Static`subtractScalar

`Static`trace

`Static`transpose

`Static`validateSerial

`Static`zero