Adobe InDesign CS3 (5.0) Object Model JS: TransformationMatrix

InDesign CS3

Class

TransformationMatrix

 A transformation matrix.

QuickLinks

catenateMatrix, changeCoordinates, getElements, invertMatrix, rotateMatrix, scaleMatrix, shearMatrix, toSource, toSpecifier, translateMatrix

Hierarchy

Application
TransformationMatrix

Properties

PropertyTypeAccessDescription
clockwiseShearAnglenumber readonlyThe shear angle of the transformation matrix.
counterclockwiseRotationAnglenumber readonlyThe rotation angle of the transformation matrix.
horizontalScaleFactornumber readonlyThe horizontal scale factor of the transformation matrix.
horizontalTranslationnumber readonlyThe horizontal translation of the transformation matrix.
indexnumber readonlyThe index of the TransformationMatrix within its containing object.
matrixValues Array of number readonlyThe values of the transformation matrix.
namestring readonlyThe name of the TransformationMatrix.
parentApplication readonlyThe parent of the TransformationMatrix (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
verticalScaleFactornumber readonlyThe vertical scale factor of the transformation matrix.
verticalTranslationnumber readonlyThe vertical translation of the transformation matrix.

Methods

Instances

TransformationMatrix catenateMatrix (withMatrix: TransformationMatrix)
Multiply the transformation matrix by another.

ParameterTypeDescription
withMatrixTransformationMatrixThe right hand matrix factor

Array of number changeCoordinates (point: Array of number)
Multiply the point by the matrix.

ParameterTypeDescription
point Array of numberThe point to transform

Array of TransformationMatrix getElements ()
Resolves the object specifier, creating an array of object references.

TransformationMatrix invertMatrix ()
Invert the transformation matrix.

TransformationMatrix rotateMatrix ([byAngle: number][, byCosine: number][, bySine: number])
Rotate the transformation matrix.

ParameterTypeDescription
byAnglenumberThe counterclockwise rotation angle (Optional)
byCosinenumberThe cosine of the desired rotation (Optional)
bySinenumberThe sine of the desired rotation (Optional)

TransformationMatrix scaleMatrix ([horizontallyBy: number][, verticallyBy: number])
Scale the transformation matrix.

ParameterTypeDescription
horizontallyBynumberThe horizontal scale factor (Optional)
verticallyBynumberThe vertical scale factor (Optional)

TransformationMatrix shearMatrix ([byAngle: number][, bySlope: number])
Shear the transformation matrix.

ParameterTypeDescription
byAnglenumberThe horizontal shear angle (Optional)
bySlopenumberThe horizontal shear slope (Optional)

string toSource ()
Generates a string which, if executed, will return the TransformationMatrix.

string toSpecifier ()
Retrieves the object specifier.

TransformationMatrix translateMatrix ([horizontallyBy: number][, verticallyBy: number])
Translate the transformation matrix.

ParameterTypeDescription
horizontallyBynumberThe horizontal translation distance (Optional)
verticallyBynumberThe vertical translation distance (Optional)

Used in:

void Button.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void EPS.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void FormField.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Graphic.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void GraphicLine.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Group.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Image.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void ImportedPage.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Movie.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Oval.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void PDF.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void PICT.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void PageItem.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Polygon.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Rectangle.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void Sound.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

void TextFrame.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

array of TransformationMatrix TransformationMatrices.itemByRange (from: any, to: any)

TransformationMatrix TransformationMatrices.nextItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrices.previousItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrix.catenateMatrix (withMatrix: TransformationMatrix)

void WMF.transform (in: CoordinateSpaces, from: any, withMatrix: any[, replacingCurrent: any][, consideringRulerUnits: bool=false])

Return

Array of TransformationMatrix Button.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix EPS.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix FormField.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Graphic.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix GraphicLine.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Group.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Image.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix ImportedPage.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Oval.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PDF.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PICT.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PageItem.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Polygon.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Rectangle.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix TextFrame.transformValuesOf (in: CoordinateSpaces)

TransformationMatrix TransformationMatrices.add ([horizontalScaleFactor: number][, verticalScaleFactor: number][, clockwiseShearAngle: number][, counterclockwiseRotationAngle: number][, horizontalTranslation: number][, verticalTranslation: number][, matrixValues: Array of number][, withProperties: Object])

TransformationMatrix TransformationMatrices.anyItem ()

Array of TransformationMatrix TransformationMatrices.everyItem ()

TransformationMatrix TransformationMatrices.firstItem ()

TransformationMatrix TransformationMatrices.item (index: any)

TransformationMatrix TransformationMatrices.itemByName (name: string)

Array of TransformationMatrix TransformationMatrices.itemByRange (from: any, to: any)

TransformationMatrix TransformationMatrices.lastItem ()

TransformationMatrix TransformationMatrices.middleItem ()

TransformationMatrix TransformationMatrices.nextItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrices.previousItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrix.catenateMatrix (withMatrix: TransformationMatrix)

Array of TransformationMatrix TransformationMatrix.getElements ()

TransformationMatrix TransformationMatrix.invertMatrix ()

TransformationMatrix TransformationMatrix.rotateMatrix ([byAngle: number][, byCosine: number][, bySine: number])

TransformationMatrix TransformationMatrix.scaleMatrix ([horizontallyBy: number][, verticallyBy: number])

TransformationMatrix TransformationMatrix.shearMatrix ([byAngle: number][, bySlope: number])

TransformationMatrix TransformationMatrix.translateMatrix ([horizontallyBy: number][, verticallyBy: number])

Array of TransformationMatrix WMF.transformValuesOf (in: CoordinateSpaces)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index