Class Matrix

constructor

• new Matrix(
      a?: number,
      b?: number,
      c?: number,
      d?: number,
      tx?: number,
      ty?: number,
  ): Matrix

  Parameters

  • Optionala: number

    x scale

  • Optionalb: number

    y skew

  • Optionalc: number

    x skew

  • Optionald: number

    y scale

  • Optionaltx: number

    x translation

  • Optionalty: number

    y translation

  Returns Matrix

a

1
Copy

array

b

0
Copy

c

0
Copy

d

1
Copy

tx

0
Copy

ty

0
Copy

StaticIDENTITY

• get IDENTITY(): Matrix

  A default (identity) matrix

  Returns Matrix

StaticTEMP_MATRIX

• get TEMP_MATRIX(): Matrix

  A temp matrix

  Returns Matrix

append

• append(matrix: Matrix): this

  Appends the given Matrix to this Matrix.

  Parameters

  • matrix: Matrix

    The matrix to append.

  Returns this

  This matrix. Good for chaining method calls.

apply

• apply<P extends IPointData = Point>(pos: IPointData, newPos?: P): P

  Get a new position with the current transformation applied. Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)

  Type Parameters

  • P extends IPointData = Point

  Parameters

  • pos: IPointData

    The origin

  • OptionalnewPos: P

    The point that the new position is assigned to (allowed to be same as input)

  Returns P

  The new point, transformed through this matrix

applyInverse

• applyInverse<P extends IPointData = Point>(pos: IPointData, newPos?: P): P

  Get a new position with the inverse of the current transformation applied. Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)

  Type Parameters

  • P extends IPointData = Point

  Parameters

  • pos: IPointData

    The origin

  • OptionalnewPos: P

    The point that the new position is assigned to (allowed to be same as input)

  Returns P

  The new point, inverse-transformed through this matrix

clone

• clone(): Matrix

  Creates a new Matrix object with the same values as this one.

  Returns Matrix

  A copy of this matrix. Good for chaining method calls.

copyFrom

• copyFrom(matrix: Matrix): this

  Changes the values of the matrix to be the same as the ones in given matrix

  Parameters

  • matrix: Matrix

    The matrix to copy from.

  Returns this

  this

copyTo

• copyTo(matrix: Matrix): Matrix

  Changes the values of the given matrix to be the same as the ones in this matrix

  Parameters

  • matrix: Matrix

    The matrix to copy to.

  Returns Matrix

  The matrix given in parameter with its values updated.

decompose

• decompose(transform: Transform): Transform

  Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.

  Parameters

  • transform: Transform

    The transform to apply the properties to.

  Returns Transform

  The transform with the newly applied properties

fromArray

• fromArray(array: number[]): void

  Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:

  a = array[0] b = array[1] c = array[3] d = array[4] tx = array[2] ty = array[5]

  Parameters

  • array: number[]

    The array that the matrix will be populated from.

  Returns void

identity

• identity(): this

  Resets this Matrix to an identity (default) matrix.

  Returns this

  This matrix. Good for chaining method calls.

invert

• invert(): this

  Inverts this matrix

  Returns this

  This matrix. Good for chaining method calls.

prepend

• prepend(matrix: Matrix): this

  Prepends the given Matrix to this Matrix.

  Parameters

  • matrix: Matrix

    The matrix to prepend

  Returns this

  This matrix. Good for chaining method calls.

rotate

• rotate(angle: number): this

  Applies a rotation transformation to the matrix.

  Parameters

  • angle: number

    The angle in radians.

  Returns this

  This matrix. Good for chaining method calls.

scale

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

  Applies a scale transformation to the matrix.

  Parameters

  • x: number

    The amount to scale horizontally

  • y: number

    The amount to scale vertically

  Returns this

  This matrix. Good for chaining method calls.

set

• set(a: number, b: number, c: number, d: number, tx: number, ty: number): this

  Sets the matrix properties.

  Parameters

  • a: number

    Matrix component

  • b: number

    Matrix component

  • c: number

    Matrix component

  • d: number

    Matrix component

  • tx: number

    Matrix component

  • ty: number

    Matrix component

  Returns this

  This matrix. Good for chaining method calls.

setTransform

• setTransform(
      x: number,
      y: number,
      pivotX: number,
      pivotY: number,
      scaleX: number,
      scaleY: number,
      rotation: number,
      skewX: number,
      skewY: number,
  ): this

  Sets the matrix based on all the available properties

  Parameters

  • x: number

    Position on the x axis

  • y: number

    Position on the y axis

  • pivotX: number

    Pivot on the x axis

  • pivotY: number

    Pivot on the y axis

  • scaleX: number

    Scale on the x axis

  • scaleY: number

    Scale on the y axis

  • rotation: number

    Rotation in radians

  • skewX: number

    Skew on the x axis

  • skewY: number

    Skew on the y axis

  Returns this

  This matrix. Good for chaining method calls.

toArray

• toArray(transpose: boolean, out?: Float32Array<ArrayBufferLike>): Float32Array

  Creates an array from the current Matrix object.

  Parameters

  • transpose: boolean

    Whether we need to transpose the matrix or not

  • Optionalout: Float32Array<ArrayBufferLike>

    If provided the array will be assigned to out

  Returns Float32Array

  The newly created array which contains the matrix

translate

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

  Translates the matrix on the x and y.

  Parameters

  • x: number

    How much to translate x by

  • y: number

    How much to translate y by

  Returns this

  This matrix. Good for chaining method calls.