Class Matrix4

Represents a 4 by 4 matrix for linear algebra calculations.

Implements

ArrayN<number>

Index

Constructors

Accessors

columns dimensions rows

Methods

get getSize getValue set setValue fromIdentity fromIterable

Constructors

`Protected`constructor

new Matrix4(array: number[]): Matrix4
Parameters
- array: number[]
  The exact array that will back this matrix.
Returns Matrix4
- Defined in math/linear-algebra/Matrix4.ts:81

Accessors

columns

get columns(): number
Returns number
Number of columns in the matrix.
- Defined in math/linear-algebra/Matrix4.ts:116

dimensions

get dimensions(): number
Returns number
Number of dimensions this array is using.
Implementation of ArrayN.dimensions
- Defined in math/linear-algebra/Matrix4.ts:188

rows

get rows(): number
Returns number
Number of rows in the matrix.
- Defined in math/linear-algebra/Matrix4.ts:124

Methods

get

get(x: number, y: number): number
Parameters
- x: number
  X coordinate to get.
- y: number
  Y coordinate to get.
Returns number
Value at the given x and y coordinate.
- Defined in math/linear-algebra/Matrix4.ts:95

getSize

getSize(dimension: number): number
Parameters
- dimension: number
  Dimension we want to get the size of.
Returns number
Size of this dimension.

All unused dimensions will return 0.
Implementation of ArrayN.getSize
- Defined in math/linear-algebra/Matrix4.ts:178

getValue

getValue(position: number[]): number
Parameters
- position: number[]
  Position we want to retrieve value from.
  
  If position array has fewer dimensions than this array, they will be treated as 0.
Returns number
Value at position.
Implementation of ArrayN.getValue
- Defined in math/linear-algebra/Matrix4.ts:128

set

set(x: number, y: number, value: number): void
Parameters
- x: number
  X coordinate to set.
- y: number
  Y coordinate to set.
- value: number
  Value to save to the given x and y coordinate.
Returns void
- Defined in math/linear-algebra/Matrix4.ts:108

setValue

setValue(position: number[], value: number): void
Parameters
- position: number[]
  Position we want to store value to.
  
  If position array has fewer dimensions than this array, they will be treated as 0.
- value: number
  Value we want to store at position.
Returns void
Implementation of ArrayN.setValue
- Defined in math/linear-algebra/Matrix4.ts:171

`Static`fromIdentity

fromIdentity(): Matrix4
Returns Matrix4
An identity matrix.
- Defined in math/linear-algebra/Matrix4.ts:35

`Static`fromIterable

fromIterable(iterable: Iterable<number>): Matrix4
Parameters
- iterable: Iterable<number>
  An iterable containing numbers to build a matrix from.
Returns Matrix4
A matrix built from the numbers inside of iterable.

Throws
RangeError If iterable does not have at least 16 elements.
- Defined in math/linear-algebra/Matrix4.ts:53