Class Matrix2D

Matrix2D

Represents an affine transformation matrix, and provides tools for constructing and concatenating matrices.

This matrix can be visualized as:

    [ a  c  tx
      b  d  ty
      0  0  1  ]

Note the locations of b and c.

Visit http://createjs.com/ for documentation, updates and examples.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Implements

IMatrix2D

Index

Constructors

constructor

new Matrix2D(a?, b?, c?, d?, tx?, ty?): Matrix2D
Parameters
- Optional a: number
  Specifies the a property for the new matrix.
- Optional b: number
  Specifies the b property for the new matrix.
- Optional c: number
  Specifies the c property for the new matrix.
- Optional d: number
  Specifies the d property for the new matrix.
- Optional tx: number
  Specifies the tx property for the new matrix.
- Optional ty: number
  Specifies the ty property for the new matrix.
Returns Matrix2D
- Defined in textalive-app-api.d.ts:2256

Properties

a

a: number

Position (0, 0) in a 3x3 affine transformation matrix.

b

b: number

Position (0, 1) in a 3x3 affine transformation matrix.

c

c: number

Position (1, 0) in a 3x3 affine transformation matrix.

d

d: number

Position (1, 1) in a 3x3 affine transformation matrix.

tx

tx: number

Position (2, 0) in a 3x3 affine transformation matrix.

ty

ty: number

Position (2, 1) in a 3x3 affine transformation matrix.

`Static` `Readonly` DEG_TO_RAD

DEG_TO_RAD: number

Multiplier for converting degrees to radians. Used internally by Matrix2D.

`Static` `Readonly` identity

identity: Matrix2D

An identity matrix, representing a null transformation.

Methods

append

append(a, b, c, d, tx, ty): Matrix2D
Appends the specified matrix properties to this matrix. All parameters are required. This is the equivalent of multiplying (this matrix) * (specified matrix).
Parameters
- a: number
- b: number
- c: number
- d: number
- tx: number
- ty: number
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.append
- Defined in textalive-app-api.d.ts:2274

appendMatrix

appendMatrix(matrix): Matrix2D
Appends the specified matrix to this matrix. This is the equivalent of multiplying (this matrix) * (specified matrix).
Parameters
- matrix: Matrix2D
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.appendMatrix
- Defined in textalive-app-api.d.ts:2292

appendTransform

appendTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, regX, regY): Matrix2D
Generates matrix properties from the specified display object transform properties, and appends them to this matrix. For example, you can use this to generate a matrix representing the transformations of a display object:
```
    var mtx = new createjs.Matrix2D();
    mtx.appendTransform(o.x, o.y, o.scaleX, o.scaleY, o.rotation);
```
Parameters
- x: number
- y: number
- scaleX: number
- scaleY: number
- rotation: number
- skewX: number
- skewY: number
- regX: number
  Optional.
- regY: number
  Optional.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.appendTransform
- Defined in textalive-app-api.d.ts:2296

clone

clone(): Matrix2D
Returns a clone of the Matrix2D instance.

Returns Matrix2D
a clone of the Matrix2D instance.
Implementation of IMatrix2D.clone
- Defined in textalive-app-api.d.ts:2342

copy

copy(matrix): Matrix2D
Copies all properties from the specified matrix to this matrix.
Parameters
- matrix: Matrix2D
  The matrix to copy properties from.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.copy
- Defined in textalive-app-api.d.ts:2340

decompose

decompose(target?): DecomposedProps
Decomposes the matrix into transform properties (x, y, scaleX, scaleY, and rotation). Note that these values may not match the transform properties you used to generate the matrix, though they will produce the same visual results.
Parameters
- Optional target: DecomposedProps
  The object to apply the transform properties to. If null, then a new object will be returned.
Returns DecomposedProps
The target, or a new generic object with the transform properties applied.
Implementation of IMatrix2D.decompose
- Defined in textalive-app-api.d.ts:2338

equals

equals(matrix): boolean
Returns true if this matrix is equal to the specified matrix (all property values are equal).
Parameters
- matrix: Matrix2D
  The matrix to compare.
Returns boolean
Implementation of IMatrix2D.equals
- Defined in textalive-app-api.d.ts:2334

identity

identity(): Matrix2D
Sets the properties of the matrix to those of an identity matrix (one that applies a null transformation).

Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.identity
- Defined in textalive-app-api.d.ts:2328

invert

invert(): Matrix2D
Inverts the matrix, causing it to perform the opposite transformation.

Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.invert
- Defined in textalive-app-api.d.ts:2330

isIdentity

isIdentity(): boolean
Returns true if the matrix is an identity matrix.

Returns boolean
Implementation of IMatrix2D.isIdentity
- Defined in textalive-app-api.d.ts:2332

prepend

prepend(a, b, c, d, tx, ty): Matrix2D
Prepends the specified matrix properties to this matrix. This is the equivalent of multiplying (specified matrix) * (this matrix). All parameters are required.
Parameters
- a: number
- b: number
- c: number
- d: number
- tx: number
- ty: number
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.prepend
- Defined in textalive-app-api.d.ts:2283

prependMatrix

prependMatrix(matrix): Matrix2D
Prepends the specified matrix to this matrix. This is the equivalent of multiplying (specified matrix) * (this matrix). For example, you could calculate the combined transformation for a child object using:
```
    var o = myDisplayObject;
    var mtx = o.getMatrix();
    while (o = o.parent) {
        // prepend each parent's transformation in turn:
        o.prependMatrix(o.getMatrix());
    }
```
Parameters
- matrix: Matrix2D
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.prependMatrix
- Defined in textalive-app-api.d.ts:2294

prependTransform

prependTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, regX, regY): Matrix2D
Generates matrix properties from the specified display object transform properties, and prepends them to this matrix. For example, you could calculate the combined transformation for a child object using:
```
 var o = myDisplayObject;
 var mtx = new createjs.Matrix2D();
 do  {
     // prepend each parent's transformation in turn:
     mtx.prependTransform(o.x, o.y, o.scaleX, o.scaleY, o.rotation, o.skewX, o.skewY, o.regX, o.regY);
 } while (o = o.parent);
```
Parameters
- x: number
- y: number
- scaleX: number
- scaleY: number
- rotation: number
- skewX: number
- skewY: number
- regX: number
  Optional.
- regY: number
  Optional.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.prependTransform
- Defined in textalive-app-api.d.ts:2308

rotate

rotate(angle): Matrix2D
Applies a clockwise rotation transformation to the matrix.
Parameters
- angle: number
  The angle to rotate by, in degrees. To use a value in radians, multiply it by 180/Math.PI.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.rotate
- Defined in textalive-app-api.d.ts:2320

scale

scale(x, y): Matrix2D
Applies a scale transformation to the matrix.
Parameters
- x: number
  The amount to scale horizontally. E.G. a value of 2 will double the size in the X direction, and 0.5 will halve it.
- y: number
  The amount to scale vertically.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.scale
- Defined in textalive-app-api.d.ts:2324

setValues

setValues(a?, b?, c?, d?, tx?, ty?): Matrix2D
Sets the specified values on this instance.
Parameters
- Optional a: number
  Specifies the a property for the new matrix.
- Optional b: number
  Specifies the b property for the new matrix.
- Optional c: number
  Specifies the c property for the new matrix.
- Optional d: number
  Specifies the d property for the new matrix.
- Optional tx: number
  Specifies the tx property for the new matrix.
- Optional ty: number
  Specifies the ty property for the new matrix.
Returns Matrix2D
This instance. Useful for chaining method calls.
Implementation of IMatrix2D.setValues
- Defined in textalive-app-api.d.ts:2265

skew

skew(skewX, skewY): Matrix2D
Applies a skew transformation to the matrix.
Parameters
- skewX: number
  The amount to skew horizontally in degrees. To use a value in radians, multiply it by 180/Math.PI.
- skewY: number
  The amount to skew vertically in degrees.
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.skew
- Defined in textalive-app-api.d.ts:2322

toString

toString(): string
Returns a string representation of this object.

Returns string
a string representation of the instance.
Implementation of IMatrix2D.toString
- Defined in textalive-app-api.d.ts:2344

transformPoint

transformPoint(x, y, pt): Point
Transforms a point according to this matrix.
Parameters
- x: number
  The x component of the point to transform.
- y: number
  The y component of the point to transform.
- pt: Point
  An object to copy the result into. If omitted a generic object with x/y properties will be returned.
Returns Point
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.transformPoint
- Defined in textalive-app-api.d.ts:2336

translate

translate(x, y): Matrix2D
Translates the matrix on the x and y axes.
Parameters
- x: number
- y: number
Returns Matrix2D
This matrix. Useful for chaining method calls.
Implementation of IMatrix2D.translate
- Defined in textalive-app-api.d.ts:2326

Class Matrix2D

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Matrix2D

Properties

a

b

c

d

tx

ty

Static Readonly DEG_TO_RAD

Static Readonly identity

Methods

append

Parameters

Returns Matrix2D

appendMatrix

Parameters

Returns Matrix2D

appendTransform

Parameters

Returns Matrix2D

clone

Returns Matrix2D

copy

Parameters

Returns Matrix2D

decompose

Parameters

Returns DecomposedProps

equals

Parameters

Returns boolean

identity

Returns Matrix2D

invert

Returns Matrix2D

isIdentity

Returns boolean

prepend

Parameters

Returns Matrix2D

prependMatrix

Parameters

Returns Matrix2D

prependTransform

Parameters

Returns Matrix2D

rotate

Parameters

Returns Matrix2D

scale

Parameters

Returns Matrix2D

setValues

Parameters

Returns Matrix2D

skew

Parameters

Returns Matrix2D

toString

Returns string

transformPoint

Parameters

Returns Point

translate

Parameters

Returns Matrix2D

Settings

Member Visibility

Theme

On This Page

`Static` `Readonly` DEG_TO_RAD

`Static` `Readonly` identity