Class Matrix3

A 3x3 (square) matrix of numbers.

An adapter over a Float32Array, enabling it to be used directly with WebGL.

The 9 elements are stored in column-major order (the order expected by WebGL):

0	3	6
1	4	7
2	5	8

Hierarchy

AbstractMatrix<Matrix3>
- Matrix3

Index

Constructors

constructor

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

Properties

modified

modified: boolean

`Static` `Readonly`one

one: Matrix3 = ...

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

`Static` `Readonly`zero

zero: Matrix3 = ...

The identity matrix for addition. 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

add

__add__(rhs): Matrix3
Parameters
- rhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:496

mul

__mul__(rhs): Matrix3
Parameters
- rhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:522

neg

__neg__(): Matrix3
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:546

pos

__pos__(): Matrix3
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:542

radd

__radd__(lhs): Matrix3
Parameters
- lhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:509

rmul

__rmul__(lhs): Matrix3
Parameters
- lhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:532

rsub

__rsub__(lhs): Matrix3
Parameters
- lhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:563

sub

__sub__(rhs): Matrix3
Parameters
- rhs: any
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:550

add

add(rhs): this
Parameters
- rhs: Matrix3
Returns this
- Defined in src/lib/math/Matrix3.ts:75

add2

add2(a, b): this
Parameters
- a: Matrix3
- b: Matrix3
Returns this
- Defined in src/lib/math/Matrix3.ts:85

clone

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

Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:93

copy

copy(m): Matrix3
Parameters
- m: Matrix3
Returns Matrix3
Inherited from AbstractMatrix.copy
- Defined in src/lib/math/AbstractMatrix.ts:64

det

det(): number
Computes the determinant.

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

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
Returns this
- Defined in src/lib/math/Matrix3.ts:151

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
Returns boolean
Overrides AbstractMatrix.isOne
- Defined in src/lib/math/Matrix3.ts:159

isZero

isZero(): boolean
Returns boolean
- Defined in src/lib/math/Matrix3.ts:176

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: Matrix3
Returns this
- Defined in src/lib/math/Matrix3.ts:193

mul2

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

neg

neg(): this
Returns this
- Defined in src/lib/math/Matrix3.ts:217

normalFromMatrix4

normalFromMatrix4(m): this
Sets this 3x3 matrix to the matrix required to properly transform normal vectors (pseudo or axial vectors) based upon the 4x4 matrix used to transform polar vectors.
Parameters
- m: Matrix4
Returns this
- Defined in src/lib/math/Matrix3.ts:229

one

one(): this
Returns this
- Defined in src/lib/math/Matrix3.ts:236

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: VectorE2
Returns this
- Defined in src/lib/math/Matrix3.ts:251

rmul

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

rotate

rotate(spinor): this
Parameters
- spinor: SpinorE2
Returns this
- Defined in src/lib/math/Matrix3.ts:275

rotation

rotation(spinor): this
Parameters
- spinor: SpinorE2
Returns this
- Defined in src/lib/math/Matrix3.ts:283

row

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

scale

scale(s): this
Parameters
- s: number
Returns this
- Defined in src/lib/math/Matrix3.ts:295

set

set(n11, n12, n13, n21, n22, n23, n31, n32, n33): this
Sets all elements of this matrix to the supplied values (provided in row-major order).

An advantage of this method is that the function call resembles the matrix written out.

The parameters are named according to the 1-based row and column.
Parameters
- n11: number
- n12: number
- n13: number
- n21: number
- n22: number
- n23: number
- n31: number
- n32: number
- n33: number
Returns this
- Defined in src/lib/math/Matrix3.ts:330

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

sub

sub(rhs): this
Parameters
- rhs: Matrix3
Returns this
- Defined in src/lib/math/Matrix3.ts:349

toExponential

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

toFixed

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

toPrecision

toPrecision(precision?): string
Parameters
- Optionalprecision: number
Returns string
- Defined in src/lib/math/Matrix3.ts:423

toString

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

translation

translation(d): this
Computes the homogeneous translation matrix for a 2D translation.
Parameters
- d: VectorE2
Returns this
- Defined in src/lib/math/Matrix3.ts:463

transpose

transpose(): this
Returns this
- Defined in src/lib/math/Matrix3.ts:472

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/Matrix3.ts:492

`Static`reflection

reflection(n): Matrix3
Parameters
- n: VectorE2
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:580

`Static`rotation

rotation(spinor): Matrix3
Parameters
- spinor: SpinorE2
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:587

`Static`translation

translation(d): Matrix3
Parameters
- d: VectorE2
Returns Matrix3
- Defined in src/lib/math/Matrix3.ts:594

Class Matrix3

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Matrix3

Properties

modified

Static Readonlyone

Static Readonlyzero

Accessors

dimensions

Returns number

Parameters

Returns void

elements

Returns Float32Array

Parameters

Returns void

Methods

__add__

Parameters

Returns Matrix3

__mul__

Parameters

Returns Matrix3

__neg__

Returns Matrix3

__pos__

Returns Matrix3

__radd__

Parameters

Returns Matrix3

__rmul__

Parameters

Returns Matrix3

__rsub__

Parameters

Returns Matrix3

__sub__

Parameters

Returns Matrix3

add

Parameters

Returns this

add2

Parameters

Returns this

clone

Returns Matrix3

copy

Parameters

Returns Matrix3

det

Returns number

getElement

Parameters

Returns number

inv

Returns this

isLocked

Returns boolean

isOne

Returns boolean

isZero

Returns boolean

lock

Returns number

mul

Parameters

Returns this

mul2

Parameters

Returns this

neg

`Static` `Readonly`one

`Static` `Readonly`zero

add

mul

neg

pos

radd

rmul

rsub

sub

`Static`reflection

`Static`rotation

`Static`translation