Class Matrix4

A 4x4 (square) matrix of numbers.

An adapter for a Float32Array.

Hierarchy

AbstractMatrix<Matrix4>
- Matrix4

Index

Constructors

Properties

modified one zero

Accessors

dimensions elements

Constructors

constructor

new Matrix4(elements): Matrix4
Parameters
- elements: Float32Array
Returns Matrix4
Overrides AbstractMatrix<Matrix4>.constructor
- Defined in src/lib/math/Matrix4.ts:84

Properties

modified

modified: boolean

`Static` `Readonly`one

one: Matrix4 = ...

The identity matrix for multiplication, 1. The matrix is locked (immutable), but may be cloned.

`Static` `Readonly`zero

zero: Matrix4 = ...

The identity matrix for addition, 0. The matrix is locked (immutable), but may be cloned.

Accessors

dimensions

get dimensions(): number
Returns number
Inherited from AbstractMatrix.dimensions
- Defined in src/lib/math/AbstractMatrix.ts:46
set dimensions(unused): void
Parameters
- unused: number
Returns void
Inherited from AbstractMatrix.dimensions
- Defined in src/lib/math/AbstractMatrix.ts:49

elements

get elements(): Float32Array
Returns Float32Array
Inherited from AbstractMatrix.elements
- Defined in src/lib/math/AbstractMatrix.ts:53
set elements(elements): void
Parameters
- elements: Float32Array
Returns void
Inherited from AbstractMatrix.elements
- Defined in src/lib/math/AbstractMatrix.ts:56

Methods

mul

__mul__(rhs): Matrix4
Parameters
- rhs: number | Matrix4
Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:551

rmul

__rmul__(lhs): Matrix4
Parameters
- lhs: number | Matrix4
Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:561

add

add(rhs): this
Sets this matrix to this + rhs.
Parameters
- rhs: Matrix4
Returns this
- Defined in src/lib/math/Matrix4.ts:124

add2

add2(a, b): this
Sets this matrix to a + b.
Parameters
- a: Matrix4
- b: Matrix4
Returns this
- Defined in src/lib/math/Matrix4.ts:134

clone

clone(): Matrix4
Returns a copy of this Matrix4 instance.

Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:142

compose

compose(S, R, T): this
Sets this matrix to perform the specified scaling, rotation, and translation.
Parameters
- S: VectorE3
- R: SpinorE3
- T: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:149

copy

copy(m): this
Copies the specified matrix into this matrix.
Parameters
- m: Matrix4
Returns this
Overrides AbstractMatrix.copy
- Defined in src/lib/math/Matrix4.ts:159

det

det(): number
Computes the determinant.

Returns number
- Defined in src/lib/math/Matrix4.ts:167

frustum

frustum(left, right, bottom, top, near, far): this
Parameters
- left: number
- right: number
- bottom: number
- top: number
- near: number
- far: number
Returns this
- Defined in src/lib/math/Matrix4.ts:248

getElement

getElement(row, column): number
Parameters
- row: number
  The zero-based row.
- column: number
  The zero-based column.
Returns number
Inherited from AbstractMatrix.getElement
- Defined in src/lib/math/AbstractMatrix.ts:76

inv

inv(): this
Sets the elements of this matrix to that of its inverse.

Returns this
- Defined in src/lib/math/Matrix4.ts:174

isLocked

isLocked(): boolean
Determines whether this Lockable is locked. If the Lockable is in the unlocked state then it is mutable. If the Lockable is in the locked state then it is immutable.

Returns boolean
Inherited from AbstractMatrix.isLocked
- Defined in src/lib/math/AbstractMatrix.ts:34

isOne

isOne(): boolean
Determines whether this matrix is the identity matrix.

Returns boolean
Inherited from AbstractMatrix.isOne
- Defined in src/lib/math/AbstractMatrix.ts:83

lock

lock(): number
Locks this Lockable (preventing any further mutation), and returns a token that may be used to unlock it.

Returns number
Inherited from AbstractMatrix.lock
- Defined in src/lib/math/AbstractMatrix.ts:38

mul

mul(rhs): this
Parameters
- rhs: Matrix4
Returns this
- Defined in src/lib/math/Matrix4.ts:310

mul2

mul2(a, b): this
Parameters
- a: Matrix4
- b: Matrix4
Returns this
- Defined in src/lib/math/Matrix4.ts:317

one

one(): this
Sets this matrix to the identity element for multiplication, 1.

Returns this
- Defined in src/lib/math/Matrix4.ts:182

perspective

perspective(fov, aspect, near, far): this
Sets this matrix to the viewing transformation. This is the matrix that may be applied to points in the truncated viewing pyramid. The resulting points then lie in the image space (cube).
Parameters
- fov: number
- aspect: number
- near: number
- far: number
Returns this
- Defined in src/lib/math/Matrix4.ts:283

reflection

reflection(n): this
Sets this matrix to the transformation for a reflection in the plane normal to the unit vector n.

this ⟼ reflection(n)
Parameters
- n: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:337

rmul

rmul(lhs): this
Parameters
- lhs: Matrix4
Returns this
- Defined in src/lib/math/Matrix4.ts:325

rotate

rotate(spinor): this
this ⟼ rotation(spinor) * this
Parameters
- spinor: SpinorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:359

rotation

rotation(spinor): this
Sets this matrix to be equivalent to the spinor.

this ⟼ rotation(spinor)
Parameters
- spinor: SpinorE3
  The spinor from which the rotation will be computed.
Returns this
- Defined in src/lib/math/Matrix4.ts:370

rotationAxis

rotationAxis(axis, angle): this
Parameters
- axis: VectorE3
- angle: number
Returns this
- Defined in src/lib/math/Matrix4.ts:292

row

row(i): number[]
Parameters
- i: number
  the zero-based index of the row.
Returns number[]
- Defined in src/lib/math/Matrix4.ts:399

scale

scale(s): this
Multiplies all elements of this matrix by the specified value.
Parameters
- s: number
Returns this
- Defined in src/lib/math/Matrix4.ts:189

scaleXYZ

scaleXYZ(scale): this
Parameters
- scale: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:407

scaling

scaling(scale): this
Parameters
- scale: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:425

set

set(n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44): this
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 this
- Defined in src/lib/math/Matrix4.ts:432

setElement

setElement(row, column, value): void
Parameters
- row: number
  The zero-based row.
- column: number
  The zero-based column.
- value: number
  The value of the element.
Returns void
Inherited from AbstractMatrix.setElement
- Defined in src/lib/math/AbstractMatrix.ts:106

toExponential

toExponential(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/math/Matrix4.ts:458

toFixed

toFixed(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/math/Matrix4.ts:476

toPrecision

toPrecision(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/math/Matrix4.ts:494

toString

toString(radix?): string
Parameters
- Optionalradix: number
Returns string
- Defined in src/lib/math/Matrix4.ts:512

translate

translate(d): this
this ⟼ translation(spinor) * this
Parameters
- d: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:530

translation

translation(displacement): this
Sets this matrix to be equivalent to the displacement vector argument.
Parameters
- displacement: VectorE3
Returns this
- Defined in src/lib/math/Matrix4.ts:537

transpose

transpose(): this
Sets this matrix to its transpose.

Returns this
- Defined in src/lib/math/Matrix4.ts:213

unlock

unlock(token): void
Unlocks this Lockable (allowing mutation), using a token that was obtained from a preceding lock method call.
Parameters
- token: number
Returns void
Inherited from AbstractMatrix.unlock
- Defined in src/lib/math/AbstractMatrix.ts:42

zero

zero(): this
Sets this matrix to the identity element for addition, 0.

Returns this
- Defined in src/lib/math/Matrix4.ts:547

`Static`rotation

rotation(spinor): Matrix4
Constructs a 4x4 matrix that performs the rotation specified by the spinor.
Parameters
- spinor: SpinorE3
Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:117

`Static`scaling

scaling(scale): Matrix4
Constructs a 4x4 matrix that performs the scaling specified by the vector.
Parameters
- scale: VectorE3
Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:103

`Static`translation

translation(vector): Matrix4
Constructs a 4x4 matrix that performs the translation specified by the vector.
Parameters
- vector: VectorE3
Returns Matrix4
- Defined in src/lib/math/Matrix4.ts:110