Class Matrix3

ReadonlyisMatrix3

copy

• copy(m: Matrix3): this

  Parameters

  • m: Matrix3

  Returns this

determinant

• determinant(): number

  Returns number

equals

• equals(matrix: Matrix3): boolean

  Parameters

  • matrix: Matrix3

  Returns boolean

extractBasis

• extractBasis(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): this

  Parameters

  • xAxis: Vector3
  • yAxis: Vector3
  • zAxis: Vector3

  Returns this

fromArray

• fromArray(array: ArrayLike<number>, offset?: number): this

  Sets the values of this matrix from the provided array or array-like.

  Parameters

  • array: ArrayLike<number>

    the source array or array-like.

  • Optionaloffset: number

    (optional) offset into the array-like. Default is 0.

  Returns this

getNormalMatrix

• getNormalMatrix(matrix4: Matrix4): this

  Parameters

  • matrix4: Matrix4

  Returns this

identity

• identity(): this

  Returns this

invert

• invert(): this

  Inverts this matrix in place.

  Returns this

makeRotation

• makeRotation(theta: number): this

  Sets this matrix as a 2D rotational transformation by theta radians. The resulting matrix will be:

  cos(θ) -sin(θ) 0
  sin(θ) cos(θ)  0
  0      0       1
  Copy

  Parameters

  • theta: number

    Rotation angle in radians. Positive values rotate counterclockwise.

  Returns this

makeScale

• makeScale(x: number, y: number): this

  Sets this matrix as a 2D scale transform:

  x, 0, 0,
  0, y, 0,
  0, 0, 1
  Copy

  Parameters

  • x: number

    the amount to scale in the X axis.

  • y: number

    the amount to scale in the Y axis.

  Returns this

makeTranslation

• makeTranslation(v: Vector2): this

  Sets this matrix as a 2D translation transform:

  1, 0, x,
  0, 1, y,
  0, 0, 1
  Copy

  Parameters

  • v: Vector2

    the amount to translate.

  Returns this

• makeTranslation(x: number, y: number): this

  Sets this matrix as a 2D translation transform:

  1, 0, x,
  0, 1, y,
  0, 0, 1
  Copy

  Parameters

  • x: number

    the amount to translate in the X axis.

  • y: number

    the amount to translate in the Y axis.

  Returns this

multiply

• multiply(m: Matrix3): this

  Multiplies this matrix by m.

  Parameters

  • m: Matrix3

  Returns this

multiplyMatrices

• multiplyMatrices(a: Matrix3, b: Matrix3): this

  Sets this matrix to a x b.

  Parameters

  • a: Matrix3
  • b: Matrix3

  Returns this

multiplyScalar

• multiplyScalar(s: number): this

  Parameters

  • s: number

  Returns this

premultiply

• premultiply(m: Matrix3): this

  Parameters

  • m: Matrix3

  Returns this

rotate

• rotate(theta: number): this

  Parameters

  • theta: number

  Returns this

scale

• scale(sx: number, sy: number): this

  Parameters

  • sx: number
  • sy: number

  Returns this

set

• set(
      n11: number,
      n12: number,
      n13: number,
      n21: number,
      n22: number,
      n23: number,
      n31: number,
      n32: number,
      n33: number,
  ): Matrix3

  Parameters

  • n11: number
  • n12: number
  • n13: number
  • n21: number
  • n22: number
  • n23: number
  • n31: number
  • n32: number
  • n33: number

  Returns Matrix3

setFromMatrix4

• setFromMatrix4(m: Matrix4): Matrix3

  Parameters

  • m: Matrix4

  Returns Matrix3

setUvTransform

• setUvTransform(
      tx: number,
      ty: number,
      sx: number,
      sy: number,
      rotation: number,
      cx: number,
      cy: number,
  ): this

  Parameters

  • tx: number
  • ty: number
  • sx: number
  • sy: number
  • rotation: number
  • cx: number
  • cy: number

  Returns this

toArray

• toArray(): Matrix3Tuple

  Writes the elements of this matrix to an array in column-major format.

  Returns Matrix3Tuple

• toArray<TArray extends ArrayLike<number>>(
      array: TArray,
      offset?: number,
  ): TArray

  Writes the elements of this matrix to an array in column-major format.

  Type Parameters

  • TArray extends ArrayLike<number>

  Parameters

  • array: TArray

    array to store the resulting vector in. If not given a new array will be created.

  • Optionaloffset: number

    (optional) offset in the array at which to put the result.

  Returns TArray

translate

• translate(tx: number, ty: number): this

  Parameters

  • tx: number
  • ty: number

  Returns this

transpose

• transpose(): this

  Transposes this matrix in place.

  Returns this

transposeIntoArray

• transposeIntoArray(r: number[]): this

  Transposes this matrix into the supplied array r, and returns itself.

  Parameters

  • r: number[]

  Returns this