Matrix2D | textalive-app-api

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.

Hierarchy

Matrix2D

Implements

IMatrix2D

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Matrix2D(a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number): Matrix2D

- Defined in textalive-app-api.d.ts:2676
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

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: number, b: number, c: number, d: number, tx: number, ty: number): Matrix2D

Implementation of IMatrix2D.append
- Defined in textalive-app-api.d.ts:2684
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.

appendMatrix

appendMatrix(matrix: Matrix2D): Matrix2D

Implementation of IMatrix2D.appendMatrix
- Defined in textalive-app-api.d.ts:2692
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.

appendTransform

appendTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, regX: number, regY: number): Matrix2D

Implementation of IMatrix2D.appendTransform
- Defined in textalive-app-api.d.ts:2700
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.

clone

clone(): Matrix2D

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

Returns Matrix2D
a clone of the Matrix2D instance.

copy

copy(matrix: Matrix2D): Matrix2D

Implementation of IMatrix2D.copy
- Defined in textalive-app-api.d.ts:2748
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.

decompose

decompose(target?: DecomposedProps): DecomposedProps

Implementation of IMatrix2D.decompose
- Defined in textalive-app-api.d.ts:2744
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.

equals

equals(matrix: Matrix2D): boolean

Implementation of IMatrix2D.equals
- Defined in textalive-app-api.d.ts:2736
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

identity

identity(): Matrix2D

Implementation of IMatrix2D.identity
- Defined in textalive-app-api.d.ts:2724
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.

invert

invert(): Matrix2D

Implementation of IMatrix2D.invert
- Defined in textalive-app-api.d.ts:2728
Inverts the matrix, causing it to perform the opposite transformation.

Returns Matrix2D
This matrix. Useful for chaining method calls.

isIdentity

isIdentity(): boolean

Implementation of IMatrix2D.isIdentity
- Defined in textalive-app-api.d.ts:2732
Returns true if the matrix is an identity matrix.

Returns boolean

prepend

prepend(a: number, b: number, c: number, d: number, tx: number, ty: number): Matrix2D

Implementation of IMatrix2D.prepend
- Defined in textalive-app-api.d.ts:2688
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.

prependMatrix

prependMatrix(matrix: Matrix2D): Matrix2D

Implementation of IMatrix2D.prependMatrix
- Defined in textalive-app-api.d.ts:2696
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.

prependTransform

prependTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, regX: number, regY: number): 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);

Note that the above example would not account for <a href="https://www.createjs.com/docs/easeljs/classes/DisplayObject.html#property_transformMatrix" class="external">https://www.createjs.com/docs/easeljs/classes/DisplayObject.html#property_transformMatrix</a>
values. See <a href="../interfaces/IMatrix2D.html#prependMatrix">IMatrix2D.prependMatrix</a> for an example that does.

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.

rotate

rotate(angle: number): Matrix2D

Implementation of IMatrix2D.rotate
- Defined in textalive-app-api.d.ts:2708
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.

scale

scale(x: number, y: number): Matrix2D

Implementation of IMatrix2D.scale
- Defined in textalive-app-api.d.ts:2716
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.

setValues

setValues(a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number): Matrix2D

Implementation of IMatrix2D.setValues
- Defined in textalive-app-api.d.ts:2680
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.

skew

skew(skewX: number, skewY: number): Matrix2D

Implementation of IMatrix2D.skew
- Defined in textalive-app-api.d.ts:2712
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.

toString

toString(): string

Implementation of IMatrix2D.toString
- Defined in textalive-app-api.d.ts:2756
Returns a string representation of this object.

Returns string
a string representation of the instance.

transformPoint

transformPoint(x: number, y: number, pt: Point): Point

Implementation of IMatrix2D.transformPoint
- Defined in textalive-app-api.d.ts:2740
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.

translate

translate(x: number, y: number): Matrix2D

Implementation of IMatrix2D.translate
- Defined in textalive-app-api.d.ts:2720
Translates the matrix on the x and y axes.

Parameters
- x: number
- y: number
Returns Matrix2D
This matrix. Useful for chaining method calls.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional a: number

Optional b: number

Optional c: number

Optional d: number

Optional tx: number

Optional ty: number

Returns Matrix2D

Properties

a

b

c

d

tx

ty

Static Readonly DEG_TO_RAD

Static Readonly identity

Methods

append

Parameters

a: number

b: number

c: number

d: number

tx: number

ty: number

Returns Matrix2D

appendMatrix

Parameters

matrix: Matrix2D

Returns Matrix2D

appendTransform

Parameters

x: number

y: number

scaleX: number

scaleY: number

rotation: number

skewX: number

skewY: number

regX: number

regY: number

Returns Matrix2D

clone

Returns Matrix2D

copy

Parameters

matrix: Matrix2D

Returns Matrix2D

decompose

Parameters

Optional target: DecomposedProps

Returns DecomposedProps

equals

Parameters

matrix: Matrix2D

Returns boolean

identity

Returns Matrix2D

invert

Returns Matrix2D

isIdentity

Returns boolean

prepend

Parameters

a: number

b: number

c: number

d: number

tx: number

ty: number

Returns Matrix2D