Packagecom.adobe.indesign
Classpublic class TransformationMatrix
InheritanceTransformationMatrix Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  clockwiseShearAngle : Number
[read-only] The shear angle of the transformation matrix.
TransformationMatrix
  counterclockwiseRotationAngle : Number
[read-only] The rotation angle of the transformation matrix.
TransformationMatrix
  eventListeners : EventListeners
[read-only] A collection of event listeners.
TransformationMatrix
  events : Events
[read-only] A collection of events.
TransformationMatrix
  horizontalScaleFactor : Number
[read-only] The horizontal scale factor of the transformation matrix.
TransformationMatrix
  horizontalTranslation : Number
[read-only] The horizontal translation of the transformation matrix.
TransformationMatrix
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the TransformationMatrix within its containing object.
TransformationMatrix
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
TransformationMatrix
  matrixMapping : Object
[read-only] The mapping the transformation matrix performs on the unit triangle.
TransformationMatrix
  matrixValues : Object
[read-only] The values of the transformation matrix.
TransformationMatrix
  name : String
[read-only] The name of the TransformationMatrix.
TransformationMatrix
  parent : Application
[read-only] The parent of the TransformationMatrix (a Application).
TransformationMatrix
  properties : Object
A property that allows setting of several properties at the same time.
TransformationMatrix
  verticalScaleFactor : Number
[read-only] The vertical scale factor of the transformation matrix.
TransformationMatrix
  verticalTranslation : Number
[read-only] The vertical translation of the transformation matrix.
TransformationMatrix
Public Methods
 MethodDefined By
  
addEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TransformationMatrix
  
Multiply the transformation matrix by another.
TransformationMatrix
  
changeCoordinates(pointParam:Array = null):Object
Multiply the point by the matrix.
TransformationMatrix
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
TransformationMatrix
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
Invert the transformation matrix.
TransformationMatrix
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TransformationMatrix
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
rotateMatrix(byAngleParam:Number, byCosineParam:Number, bySineParam:Number):TransformationMatrix
Rotate the transformation matrix.
TransformationMatrix
  
scaleMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix
Scale the transformation matrix.
TransformationMatrix
  
shearMatrix(byAngleParam:Number, bySlopeParam:Number):TransformationMatrix
Shear the transformation matrix.
TransformationMatrix
  
toSpecifier():String
Retrieves the object specifier.
TransformationMatrix
  
translateMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix
Translate the transformation matrix.
TransformationMatrix
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
clockwiseShearAngleproperty
clockwiseShearAngle:Number  [read-only]

The shear angle of the transformation matrix.


Implementation
    public function get clockwiseShearAngle():Number
counterclockwiseRotationAngleproperty 
counterclockwiseRotationAngle:Number  [read-only]

The rotation angle of the transformation matrix.


Implementation
    public function get counterclockwiseRotationAngle():Number
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
horizontalScaleFactorproperty 
horizontalScaleFactor:Number  [read-only]

The horizontal scale factor of the transformation matrix.


Implementation
    public function get horizontalScaleFactor():Number
horizontalTranslationproperty 
horizontalTranslation:Number  [read-only]

The horizontal translation of the transformation matrix.


Implementation
    public function get horizontalTranslation():Number
indexproperty 
index:Number  [read-only]

The index of the TransformationMatrix within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
matrixMappingproperty 
matrixMapping:Object  [read-only]

The mapping the transformation matrix performs on the unit triangle. Can return: Array of Array of 2 Arrays of 2 Reals.


Implementation
    public function get matrixMapping():Object
matrixValuesproperty 
matrixValues:Object  [read-only]

The values of the transformation matrix.


Implementation
    public function get matrixValues():Object
nameproperty 
name:String  [read-only]

The name of the TransformationMatrix.


Implementation
    public function get name():String
parentproperty 
parent:Application  [read-only]

The parent of the TransformationMatrix (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
verticalScaleFactorproperty 
verticalScaleFactor:Number  [read-only]

The vertical scale factor of the transformation matrix.


Implementation
    public function get verticalScaleFactor():Number
verticalTranslationproperty 
verticalTranslation:Number  [read-only]

The vertical translation of the transformation matrix.


Implementation
    public function get verticalTranslation():Number
Method Detail
addEventListenerTransformationMatrix()method
public function addEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
catenateMatrix()method 
public function catenateMatrix(withMatrixParam:TransformationMatrix = null):TransformationMatrix

Multiply the transformation matrix by another.

Parameters

withMatrixParam:TransformationMatrix (default = null) — (TransformationMatrix) The right hand matrix factor

Returns
TransformationMatrix
changeCoordinates()method 
public function changeCoordinates(pointParam:Array = null):Object

Multiply the point by the matrix.

Parameters

pointParam:Array (default = null) — (Array) The point to transform

Returns
Object
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
invertMatrix()method 
public function invertMatrix():TransformationMatrix

Invert the transformation matrix.

Returns
TransformationMatrix
removeEventListenerTransformationMatrix()method 
public function removeEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
rotateMatrix()method 
public function rotateMatrix(byAngleParam:Number, byCosineParam:Number, bySineParam:Number):TransformationMatrix

Rotate the transformation matrix.

Parameters

byAngleParam:Number (default = NaN) — (Number) The counterclockwise rotation angle (Optional)
 
byCosineParam:Number (default = NaN) — (Number) The cosine of the desired rotation (Optional)
 
bySineParam:Number (default = NaN) — (Number) The sine of the desired rotation (Optional)

Returns
TransformationMatrix
scaleMatrix()method 
public function scaleMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix

Scale the transformation matrix.

Parameters

horizontallyByParam:Number (default = NaN) — (Number) The horizontal scale factor (Optional)
 
verticallyByParam:Number (default = NaN) — (Number) The vertical scale factor (Optional)

Returns
TransformationMatrix
shearMatrix()method 
public function shearMatrix(byAngleParam:Number, bySlopeParam:Number):TransformationMatrix

Shear the transformation matrix.

Parameters

byAngleParam:Number (default = NaN) — (Number) The horizontal shear angle (Optional)
 
bySlopeParam:Number (default = NaN) — (Number) The horizontal shear slope (Optional)

Returns
TransformationMatrix
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
translateMatrix()method 
public function translateMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix

Translate the transformation matrix.

Parameters

horizontallyByParam:Number (default = NaN) — (Number) The horizontal translation distance (Optional)
 
verticallyByParam:Number (default = NaN) — (Number) The vertical translation distance (Optional)

Returns
TransformationMatrix