new PIXI.Matrix()
Members
-
static,constantPIXI.Matrix.IDENTITY
-
A default (identity) matrix
-
static,constantPIXI.Matrix.TEMP_MATRIX
-
A temp matrix
-
anumber
-
- Default Value:
- 1
-
bnumber
-
- Default Value:
- 0
-
cnumber
-
- Default Value:
- 0
-
dnumber
-
- Default Value:
- 1
-
txnumber
-
- Default Value:
- 0
-
tynumber
-
- Default Value:
- 0
Methods
-
append(matrix){PIXI.Matrix}
-
Appends the given Matrix to this Matrix.
Name Type Description matrix
PIXI.Matrix The matrix to append.
Returns:
Type Description PIXI.Matrix This matrix. Good for chaining method calls. -
apply(pos, newPos){PIXI.Point}
-
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
PIXI.Point The origin
newPos
PIXI.Point optional The point that the new position is assigned to (allowed to be same as input)
Returns:
Type Description PIXI.Point The new point, transformed through this matrix -
applyInverse(pos, newPos){PIXI.Point}
-
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
PIXI.Point The origin
newPos
PIXI.Point optional The point that the new position is assigned to (allowed to be same as input)
Returns:
Type Description PIXI.Point The new point, inverse-transformed through this matrix -
clone(){PIXI.Matrix}
-
Creates a new Matrix object with the same values as this one.
Returns:
Type Description PIXI.Matrix A copy of this matrix. Good for chaining method calls. -
copy(matrix){PIXI.Matrix}
-
Changes the values of the given matrix to be the same as the ones in this matrix
Name Type Description matrix
PIXI.Matrix The matrix to copy from.
Returns:
Type Description PIXI.Matrix The matrix given in parameter with its values updated. -
decompose(transform){PIXI.Transform|PIXI.TransformStatic}
-
Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
Name Type Description transform
PIXI.Transform | PIXI.TransformStatic The transform to apply the properties to.
Returns:
Type Description PIXI.Transform | PIXI.TransformStatic The transform with the newly applied properties -
fromArray(array)
-
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(){PIXI.Matrix}
-
Resets this Matix to an identity (default) matrix.
Returns:
Type Description PIXI.Matrix This matrix. Good for chaining method calls. -
invert(){PIXI.Matrix}
-
Inverts this matrix
Returns:
Type Description PIXI.Matrix This matrix. Good for chaining method calls. -
prepend(matrix){PIXI.Matrix}
-
Prepends the given Matrix to this Matrix.
Name Type Description matrix
PIXI.Matrix The matrix to prepend
Returns:
Type Description PIXI.Matrix This matrix. Good for chaining method calls. -
rotate(angle){PIXI.Matrix}
-
Applies a rotation transformation to the matrix.
Name Type Description angle
number The angle in radians.
Returns:
Type Description PIXI.Matrix This matrix. Good for chaining method calls. -
scale(x, y){PIXI.Matrix}
-
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 PIXI.Matrix This matrix. Good for chaining method calls. -
set(a, b, c, d, tx, ty){PIXI.Matrix}
-
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 PIXI.Matrix This matrix. Good for chaining method calls. -
setTransform(x, y, pivotX, pivotY, scaleX, scaleY, rotation, skewX, skewY){PIXI.Matrix}
-
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 PIXI.Matrix This matrix. Good for chaining method calls. -
toArray(transpose, out){Array.<number>}
-
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){PIXI.Matrix}
-
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 PIXI.Matrix This matrix. Good for chaining method calls.