Scriptographer.com

About
News
Gallery
Scripts
Download
Documentation
Reference
Forum
Users

Matrix represents an affine transformation between two coordinate spaces in 2 dimensions. Such a transform preserves the "straightness" and "parallelness" of lines. The transform is built from a sequence of translations, scales, flips, rotations, and shears.
The transformation can be represented using matrix math on a 3x3 array. Given (x, y), the transformation (x', y') can be found by:

 [ x']   [ scaleX shearX translateX ] [ x ]   [ scaleX * x + shearX * y + translateX ]
 [ y'] = [ shearY scaleY translateY ] [ y ] = [ shearY * x + scaleY * y + translateY ]
 [ 1 ]   [ 0      0      1          ] [ 1 ]   [ 1                                    ]

The bottom row of the matrix is constant, so a transform can be uniquely represented (as in toString()) by "[[scaleX, shearX, translateX], [shearY, scaleY, translateY]]".

Constructors

Matrix(m)

Create a new matrix which copies the given one.

Parameters:

m: Matrix - the matrix to copy

Throws:

NullPointerException - if m is null

Matrix(at)

Create a new matrix from the given AWT AffineTransform.

Parameters:

at: Matrix - the transform to copy

Throws:

NullPointerException - if at is null

Matrix(scaleX, shearY, shearX, scaleY, translateX, translateY)

Construct a transform with the given matrix entries:

  [ scaleX shearX translateX ]
  [ shearY scaleY translateY ]
  [ 0      0      1          ]

Parameters:

scaleX: Number - the x scaling component

shearY: Number - the y shearing component

shearX: Number - the x shearing component

scaleY: Number - the y scaling component

translateX: Number - the x translation component

translateY: Number

Matrix(values)

Construct a matrix from a sequence of numbers. The array must have at least 4 entries, which has a translation factor of 0; or 6 entries, for specifying all parameters:

 [ values[0] values[2] (values[4]) ]
 [ values[1] values[3] (values[5]) ]
 [ 0         0         1           ]

Parameters:

values: Array of Number - the matrix to copy from, with at least 4 (6) entries

Throws:

NullPointerException - if values is null

ArrayIndexOutOfBoundsException - if values is too small

Properties

identity

Read-only.

Returns:

Boolean

scaleX

Returns:

Number

scaleY

Returns:

Number

shearX

Returns:

Number

shearY

Returns:

Number

singular

Read-only.

Returns:

Boolean

translateX

Returns:

Number

translateY

Returns:

Number

Functions

clone()

Returns a copy of this Matrix object.

Returns:

Object - an copy of this Matrix object.

invert()

Creates the inverse transformation of the object. If the object is not invertible (in which case isSingular() returns true), invert() returns null, otherwise the object itself is modified and a reference to it is returned.

Returns:

Matrix - the inversed matrix, or null, if the matrix is singular

rotate(theta[, centerX, centerY])

Parameters:

theta: Number

centerX: Number

centerY: Number

Returns:

Matrix

rotate(theta, center)

Parameters:

theta: Number