API Docs for: 2.2.1
Show:

Matrix Class

Defined in: pixi/geom/Matrix.hx:6

The Matrix class is now an object, which makes it a lot faster, here is a representation of it : | a | b | tx| | c | d | ty| | 0 | 0 | 1 |

Constructor

Matrix

()

Defined in pixi/geom/Matrix.hx:6

Methods

append

(
  • matrix
)
Matrix

Defined in pixi/geom/Matrix.hx:127

Appends the given Matrix to this Matrix.

Parameters:

Returns:

Matrix:

This matrix. Good for chaining method calls.

apply

(
  • pos
  • [newPos]
)
Point

Defined in pixi/geom/Matrix.hx:77

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)

Parameters:

  • pos Point

    The origin

  • [newPos] Point optional

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

Returns:

Point:

The new point, transformed through this matrix

applyInverse

(
  • pos
  • [newPos]
)
Point

Defined in pixi/geom/Matrix.hx:88

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)

Parameters:

  • pos Point

    The origin

  • [newPos] Point optional

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

Returns:

Point:

The new point, inverse-transformed through this matrix

fromArray

(
  • array
)

Defined in pixi/geom/Matrix.hx:60

Creates a pixi matrix object based on the array given as a parameter

Parameters:

  • array Array

    The array that the matrix will be filled with

identity

() Matrix

Defined in pixi/geom/Matrix.hx:136

Resets this Matix to an identity (default) matrix.

Returns:

Matrix:

This matrix. Good for chaining method calls.

rotate

(
  • angle
)
Matrix

Defined in pixi/geom/Matrix.hx:119

Applies a rotation transformation to the matrix.

Parameters:

  • angle Float

    The angle in radians.

Returns:

Matrix:

This matrix. Good for chaining method calls.

scale

(
  • x
  • y
)
Matrix

Defined in pixi/geom/Matrix.hx:109

Applies a scale transformation to the matrix.

Parameters:

  • x Float

    The amount to scale horizontally

  • y Float

    The amount to scale vertically

Returns:

Matrix:

This matrix. Good for chaining method calls.

toArray

(
  • transpose
)
Array

Defined in pixi/geom/Matrix.hx:68

Creates an array from the current Matrix object

Parameters:

  • transpose Bool

    Whether we need to transpose the matrix or not

Returns:

Array:

the newly created array which contains the matrix

translate

(
  • x
  • y
)
Matrix

Defined in pixi/geom/Matrix.hx:99

Translates the matrix on the x and y.

Parameters:

  • x Float
  • y Float

Returns:

Matrix:

This matrix. Good for chaining method calls.

Properties

a

Int

Defined in pixi/geom/Matrix.hx:18

Default: 1

b

Int

Defined in pixi/geom/Matrix.hx:25

Default: 0

c

Int

Defined in pixi/geom/Matrix.hx:32

Default: 0

d

Number

Defined in pixi/geom/Matrix.hx:39

Default: 1

tx

Number

Defined in pixi/geom/Matrix.hx:46

Default: 0

ty

Number

Defined in pixi/geom/Matrix.hx:53

Default: 0