Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Mat3

Class representing a 3x3 Matrix and providing static utilities for mathematical operations

Hierarchy

  • Mat3

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Mat3(array?: readonly number[]): Mat3

  • Constructor. Take and store the Mat3's values

    Parameters

    • array: readonly number[] = ...

    Returns Mat3

Properties

Readonly array

array: readonly number[] = ...

Accessors

determinant

  • get determinant(): number

  • Getter for the Mat3's determinant

    Returns number

float32Array

  • get float32Array(): Float32Array

  • Getter for the Float32Array form of the Mat3

    Returns Float32Array

string

  • get string(): string

  • Getter for the readable string form of the Mat3

    Returns string

Methods

clone

  • Clone the Mat3

    Returns Mat3

    a new Mat3 with the same values as this one

reset

  • reset(): void

  • Reset the Mat3's values to match the identity matrix

    Returns void

Static add

  • Add two Mat3s

    Parameters

    • left: Mat3

      the first Mat3

    • right: Mat3

      the second Mat3

    Returns Mat3

    the result of the addition

Static adjoint

  • Calculate the adjugate of a Mat3

    Parameters

    Returns Mat3

    the adjugate of the Mat3

Static fromRotation

  • fromRotation(angle: number): Mat3

  • Create a Mat3 representing a rotation by a given angle (radians)

    Useful convenience method effectively equivalent to Mat3.rotate(new Mat3(), <angle>)

    Parameters

    • angle: number

      the angle to rotate by

    Returns Mat3

    the rotation Matrix

Static invert

  • Invert a Mat3

    Parameters

    • m: Mat3

      the Mat3 to invert

    Returns null | Mat3

    the inverse of the Mat3

Static mult

  • Multiply two Mat3s

    Parameters

    • left: Mat3

      the first Mat3

    • right: Mat3

      the second Mat3

    Returns Mat3

    the result of the multiplication

Static multScalar

  • multScalar(m: Mat3, factor: number): Mat3

  • Multiply a Mat3 by a given scalar factor

    Parameters

    • m: Mat3

      the Mat3 to multiply

    • factor: number

      the factor to multiply by

    Returns Mat3

    the multiplied Mat3

Static projection

  • projection(width: number, height: number): Mat3

  • Create a 3x3 projection matrix for a given screen width and height

    Parameters

    • width: number

      the width of the screen

    • height: number

      the height of the screen

    Returns Mat3

    the 3x3 projection matrix

Static rotate

  • Rotate a Mat3 by a given angle (radians)

    Parameters

    • m: Mat3

      the Mat3 to rotate

    • angle: number

      the angle to rotate by

    Returns Mat3

    the rotated Mat3

Static scale

  • Scale a Mat3 by factors on the x and y axes, given as a Vec2

    Parameters

    • m: Mat3

      the Mat3 to scale

    • factor: Vec2

      the Vec2 to scale by

    Returns Mat3

    the scaled Mat3

Static sub

  • Subtract the right Mat3 from the left

    Parameters

    • left: Mat3

      the Mat3 to subtract from

    • right: Mat3

      the Mat3 to subtract

    Returns Mat3

    the result of the subtraction

Static translate

  • Translate a Mat3 by a Vec2 along the x and y

    Parameters

    • m: Mat3

      the Mat3 to translate

    • translate: Vec2

      the Vec2 to translate by

    Returns Mat3

    the translated Mat3

Static transpose

  • Transpose a Mat3

    Parameters

    • m: Mat3

      the Mat3 to transpose

    Returns Mat3

    the transposed Mat3