Two.Matrix

A class to store 3 x 3 transformation matrix information. In addition to storing data Two.Matrix has souped-up methods for commonplace mathematical operations.

Source

Constructor

Argument	Description
a	The value for element at the first column and first row.
b	The value for element at the second column and first row.
c	The value for element at the third column and first row.
d	The value for element at the first column and second row.
e	The value for element at the second column and second row.
f	The value for element at the third column and second row.
g	The value for element at the first column and third row.
h	The value for element at the second column and third row.
i	The value for element at the third column and third row.

Identity

A stored reference to the default value of a 3 x 3 matrix.

matrix.js:58

Multiply

Returns: Array.<Number>

If an optional C matrix isn't passed then a new one is created and returned.

Argument	Description
A	The first Two.Matrix to multiply
B	The second Two.Matrix to multiply
C	An optional Two.Matrix to apply the result to

Multiply two matrices together and return the result.

matrix.js:64

fromObject

Returns: Two.Matrix

Argument	Description
obj	The object notation of a Two.Matrix to create a new instance

Create a new Two.Matrix from an object notation of a Two.Matrix.

matrix.js:129

nota-bene

Works in conjunction with Two.Matrix.toObject

elements

The underlying data stored as an array.

matrix.js:27

manual

Determines whether Two.js automatically calculates the values for the matrix or if the developer intends to manage the matrix.

matrix.js:33

nota-bene

Setting to true nullifies Two.Shape.translation, Two.Shape.rotation, and Two.Shape.scale.

set

Argument	Description
a	The value for element at the first column and first row
b	The value for element at the second column and first row
c	The value for element at the third column and first row
d	The value for element at the first column and second row
e	The value for element at the second column and second row
f	The value for element at the third column and second row
g	The value for element at the first column and third row
h	The value for element at the second column and third row
i	The value for element at the third column and third row

Set an array of values onto the matrix. Order described in Two.Matrix.

matrix.js:141

set

Argument	Description
a	The array of elements to apply

Set an array of values onto the matrix. Order described in Two.Matrix.

matrix.js:156

copy

Argument	Description
m	The matrix to copy

Copy the matrix of one to the current instance.

matrix.js:189

identity

Turn matrix to the identity, like resetting.

matrix.js:211

multiply

Overloaded

Argument	Description
s	The scalar to be multiplied.

Multiply all components of the matrix against a single scalar value.

matrix.js:230

multiply

Overloaded

Argument	Description
x	The `x` component to be multiplied.
y	The `y` component to be multiplied.
z	The `z` component to be multiplied.

Multiply all components of a matrix against a 3 component vector.

matrix.js:238

multiply

Overloaded

Argument	Description
a	The value at the first column and first row of the matrix to be multiplied.
b	The value at the second column and first row of the matrix to be multiplied.
c	The value at the third column and first row of the matrix to be multiplied.
d	The value at the first column and second row of the matrix to be multiplied.
e	The value at the second column and second row of the matrix to be multiplied.
f	The value at the third column and second row of the matrix to be multiplied.
g	The value at the first column and third row of the matrix to be multiplied.
h	The value at the second column and third row of the matrix to be multiplied.
i	The value at the third column and third row of the matrix to be multiplied.

Multiply all components of a matrix against another matrix.

matrix.js:248

inverse

Argument	Description
output	The optional matrix to apply the inversion to.

Return an inverted version of the matrix. If no optional one is passed a new matrix is created and returned.

matrix.js:342

scale

Argument	Description
s	The one dimensional scale to apply to the matrix.

Uniformly scale the transformation matrix.

matrix.js:388

scale

Argument	Description
sx	The horizontal scale factor.
sy	The vertical scale factor

Scale the transformation matrix in two dimensions.

matrix.js:395

rotate

Argument	Description
n	The amount to rotate in Number.

Rotate the matrix.

matrix.js:411

translate

Argument	Description
x	The horizontal translation value to apply
y	The vertical translation value to apply

Translate the matrix to specific x / y values.

matrix.js:424

skewX

Argument	Description
n	The amount to skew

Skew the matrix by an angle in the x axis direction.

matrix.js:435

skewY

Argument	Description
n	The amount to skew

Skew the matrix by an angle in the y axis direction.

matrix.js:447

toString

Returns: String

The transformation matrix as a 6 component string separated by spaces.

Argument	Description
fullMatrix	Return the full 9 elements of the matrix or just 6 for 2D transformations.

Create a transform string. Used for the Two.js rendering APIs.

matrix.js:459

toTransformArray

Argument	Description
fullMatrix	Return the full 9 elements of the matrix or just 6 in the format for 2D transformations.
output	An array empty or otherwise to apply the values to.

Create a transform array. Used for the Two.js rendering APIs.

matrix.js:473