Class: Matrix

Tiny. Matrix

Matrix class as an object, which makes it a lot faster, here is a representation of it:

| a | b | tx|
| c | d | ty|
| 0 | 0 | 1 |

new Tiny.Matrix(a, b, c, d, tx, ty)

Name	Type	Default	Description
`a`	number	1	optional x scale
`b`	number	0	optional y skew
`c`	number	0	optional x skew
`d`	number	1	optional y scale
`tx`	number	0	optional x translation
`ty`	number	0	optional y translation

Members

static,constantTiny.Matrix.IDENTITY

A default (identity) matrix

static,constantTiny.Matrix.TEMP_MATRIX

A temp matrix

anumber

Default Value:

bnumber

Default Value:

cnumber

Default Value:

dnumber

Default Value:

txnumber

Default Value:

tynumber

Default Value:

Methods

append(matrix) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 251

Appends the given Matrix to this Matrix.

Name	Type	Description
`matrix`	Tiny.Matrix	The matrix to append.

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

apply(pos, newPos) ❯ {Tiny.Point} tiny/core/math/Matrix.js, line 155

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)

Name	Type	Description
`pos`	Tiny.Point	The origin
`newPos`	Tiny.Point	optional The point that the new position is assigned to (allowed to be same as input)

Returns:

Type	Description
Tiny.Point	The new point, transformed through this matrix

applyInverse(pos, newPos) ❯ {Tiny.Point} tiny/core/math/Matrix.js, line 175

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)

Name	Type	Description
`pos`	Tiny.Point	The origin
`newPos`	Tiny.Point	optional The point that the new position is assigned to (allowed to be same as input)

Returns:

Type	Description
Tiny.Point	The new point, inverse-transformed through this matrix

clone() ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 417

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

Returns:

Type	Description
Tiny.Matrix	A copy of this matrix. Good for chaining method calls.

copy(matrix) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 436

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

Name	Type	Description
`matrix`	Tiny.Matrix	The matrix to copy from.

Returns:

Type	Description
Tiny.Matrix	The matrix given in parameter with its values updated.

decompose(transform) ❯ {Tiny.Transform|Tiny.TransformStatic} tiny/core/math/Matrix.js, line 337

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

Name	Type	Description
`transform`	Tiny.Transform \| Tiny.TransformStatic	The transform to apply the properties to.

Returns:

Type	Description
Tiny.Transform \| Tiny.TransformStatic	The transform with the newly applied properties

fromArray(array) tiny/core/math/Matrix.js, line 76

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]

Name	Type	Description
`array`	Array.<number>	The array that the matrix will be populated from.

identity() ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 401

Resets this Matix to an identity (default) matrix.

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

invert() ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 378

Inverts this matrix

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

prepend(matrix) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 312

Prepends the given Matrix to this Matrix.

Name	Type	Description
`matrix`	Tiny.Matrix	The matrix to prepend

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

rotate(angle) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 227

Applies a rotation transformation to the matrix.

Name	Type	Description
`angle`	number	The angle in radians.

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

scale(x, y) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 210

Applies a scale transformation to the matrix.

Name	Type	Description
`x`	number	The amount to scale horizontally
`y`	number	The amount to scale vertically

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

set(a, b, c, d, tx, ty) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 97

sets the matrix properties

Name	Type	Description
`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:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

setTransform(x, y, pivotX, pivotY, scaleX, scaleY, rotation, skewX, skewY) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 282

Sets the matrix based on all the available properties

Name	Type	Description
`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:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.

toArray(transpose, out) ❯ {Array.<number>} tiny/core/math/Matrix.js, line 115

Creates an array from the current Matrix object.

Name	Type	Default	Description
`transpose`	boolean		Whether we need to transpose the matrix or not
`out`	Float32Array	new Float32Array(9)	optional If provided the array will be assigned to out

Returns:

Type	Description
Array.<number>	the newly created array which contains the matrix

translate(x, y) ❯ {Tiny.Matrix} tiny/core/math/Matrix.js, line 196

Translates the matrix on the x and y.

Name	Type	Description
`x`	number	How much to translate x by
`y`	number	How much to translate y by

Returns:

Type	Description
Tiny.Matrix	This matrix. Good for chaining method calls.