Package | com.adobe.indesign |
Class | public class TransformationMatrix |
Inheritance | TransformationMatrix ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
Invert the transformation matrix. | TransformationMatrix | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
clockwiseShearAngle | property |
clockwiseShearAngle:Number
[read-only] Since : | CS5 |
The shear angle of the transformation matrix.
public function get clockwiseShearAngle():Number
counterclockwiseRotationAngle | property |
counterclockwiseRotationAngle:Number
[read-only] Since : | CS5 |
The rotation angle of the transformation matrix.
public function get counterclockwiseRotationAngle():Number
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
horizontalScaleFactor | property |
horizontalScaleFactor:Number
[read-only] Since : | CS5 |
The horizontal scale factor of the transformation matrix.
public function get horizontalScaleFactor():Number
horizontalTranslation | property |
horizontalTranslation:Number
[read-only] Since : | CS5 |
The horizontal translation of the transformation matrix.
public function get horizontalTranslation():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the TransformationMatrix within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
matrixMapping | property |
matrixMapping:Object
[read-only] Since : | CS5 |
The mapping the transformation matrix performs on the unit triangle. Can return: Array of Array of 2 Arrays of 2 Reals.
public function get matrixMapping():Object
matrixValues | property |
matrixValues:Object
[read-only] Since : | CS5 |
The values of the transformation matrix.
public function get matrixValues():Object
name | property |
name:String
[read-only] Since : | CS5 |
The name of the TransformationMatrix.
public function get name():String
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the TransformationMatrix (a Application).
public function get parent():Application
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
verticalScaleFactor | property |
verticalScaleFactor:Number
[read-only] Since : | CS5 |
The vertical scale factor of the transformation matrix.
public function get verticalScaleFactor():Number
verticalTranslation | property |
verticalTranslation:Number
[read-only] Since : | CS5 |
The vertical translation of the transformation matrix.
public function get verticalTranslation():Number
addEventListenerTransformationMatrix | () | method |
public function addEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
catenateMatrix | () | method |
public function catenateMatrix(withMatrixParam:TransformationMatrix = null):TransformationMatrix
Since : | CS5 |
Multiply the transformation matrix by another.
Parameters
withMatrixParam:TransformationMatrix (default = null ) — (TransformationMatrix) The right hand matrix factor
|
TransformationMatrix |
changeCoordinates | () | method |
public function changeCoordinates(pointParam:Array = null):Object
Since : | CS5 |
Multiply the point by the matrix.
Parameters
pointParam:Array (default = null ) — (Array) The point to transform
|
Object |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
invertMatrix | () | method |
public function invertMatrix():TransformationMatrix
Since : | CS5 |
Invert the transformation matrix.
ReturnsTransformationMatrix |
removeEventListenerTransformationMatrix | () | method |
public function removeEventListenerTransformationMatrix(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
rotateMatrix | () | method |
public function rotateMatrix(byAngleParam:Number, byCosineParam:Number, bySineParam:Number):TransformationMatrix
Since : | CS5 |
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)
|
TransformationMatrix |
scaleMatrix | () | method |
public function scaleMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix
Since : | CS5 |
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)
|
TransformationMatrix |
shearMatrix | () | method |
public function shearMatrix(byAngleParam:Number, bySlopeParam:Number):TransformationMatrix
Since : | CS5 |
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)
|
TransformationMatrix |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
translateMatrix | () | method |
public function translateMatrix(horizontallyByParam:Number, verticallyByParam:Number):TransformationMatrix
Since : | CS5 |
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)
|
TransformationMatrix |