Class Matrix3

Hierarchy

Constructors

constructor

Properties

modified

Accessors

dimensions elements uom

Methods

copy getElement inv isLocked isMutable isOne lock mul mul2 permlock rmul row set setElement toString transpose unlock one zero

Constructors

constructor

  • new Matrix3(elements, uom?): Matrix3

  • Parameters

    • elements: Float32Array

      The matrix elements in column-major order. i.e. [m00, m10, m20, m01, m11, m21,,m02, m12, m22]

    • Optional uom: Unit

      The optional unit of measure.

    Returns Matrix3

Properties

modified

modified: boolean

Accessors

dimensions

  • get dimensions(): number

  • Returns number

elements

  • get elements(): Float32Array

  • Returns Float32Array

  • set elements(elements): void

  • Parameters

    • elements: Float32Array

    Returns void

uom

  • get uom(): Unit

  • Returns Unit

  • set uom(uom): void

  • Parameters

    Returns void

Methods

copy

  • copy(source): Matrix3

  • Parameters

    • source: MatrixLike

    Returns Matrix3

getElement

  • getElement(row, column): number

  • Returns the element at the specified (zero-based) row and column.

    Parameters

    • row: number

      The zero-based row.

    • column: number

      The zero-based column.

    Returns number

inv

  • inv(): this

  • Returns this

isLocked

  • isLocked(): boolean

  • Determines whether this multivector is locked. If the multivector is in the unlocked state then it is mutable. If the multivector is in the locked state then it is immutable.

    Returns boolean

isMutable

  • isMutable(): boolean

  • Returns boolean

isOne

  • isOne(): boolean

  • Determines whether this matrix is the identity matrix.

    Returns boolean

lock

  • lock(): number

  • Locks this multivector (preventing any further mutation), and returns a token that may be used to unlock it.

    Returns number

mul

  • mul(rhs): this

  • Parameters

    Returns this

mul2

  • mul2(a, b): this

  • Parameters

    Returns this

permlock

  • permlock(): this

  • Returns this

rmul

  • rmul(lhs): this

  • Parameters

    Returns this

row

  • row(i): number[]

  • Parameters

    • i: number

      the zero-based index of the row.

    Returns number[]

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

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

toString

  • toString(radix?): string

  • Parameters

    • Optional radix: number

    Returns string

transpose

  • transpose(): this

  • Returns this

unlock

  • unlock(token): this

  • Unlocks this multivector (allowing mutation), using a token that was obtained from a preceding lock method call.

    Parameters

    • token: number

    Returns this

Static one

  • one(): Matrix3

  • Creates a new matrix with all elements zero except those along the main diagonal which have the value unity.

    Returns Matrix3

Static zero

  • zero(): Matrix3

  • Returns Matrix3

Settings

Member Visibility

Theme

On This Page

constructormodifieddimensionselementsuomcopygetElementinvisLockedisMutableisOnelockmulmul2permlockrmulrowsetsetElementtoStringtransposeunlockonezero

Generated using TypeDoc