Class Transform

Represents a 3x2 transformation matrix.

Hierarchy (View Summary)

ObjectBase
- Transform

Accessors

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

matrix

get matrix(): number[]
Gets or sets the transformation matrix. The matrix consists of six numbers (their meaning is simplified for clarity): m11 - scales the drawing horizontally m12 - skew the the drawing horizontally m21 - skew the the drawing vertically m22 - scales the drawing vertically m31 - moves the the drawing horizontally m32 - moves the the drawing vertically

Returns number[]
set matrix(matrix: number[]): void
Gets or sets the transformation matrix. The matrix consists of six numbers (their meaning is simplified for clarity): m11 - scales the drawing horizontally m12 - skew the the drawing horizontally m21 - skew the the drawing vertically m22 - scales the drawing vertically m31 - moves the the drawing horizontally m32 - moves the the drawing vertically
Parameters
- matrix: number[]
Returns void

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

Methods

`Static`createIdentity

createIdentity(): Transform
Creates an identity transformation.

Returns Transform
A new instance of Transform.
createIdentity(om: ObjectManager): Transform
Creates an identity transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
Returns Transform
A new instance of Transform.

`Static`createMatrix

createMatrix(
    m11: number,
    m12: number,
    m21: number,
    m22: number,
    m31: number,
    m32: number,
): Transform
Creates a transformation based on the specified 3x2 matrix.
Parameters
- m11: number
  Scales the drawing horizontally
- m12: number
  Skew the the drawing horizontally
- m21: number
  Skew the the drawing vertically
- m22: number
  Scales the drawing vertically
- m31: number
  Moves the the drawing horizontally
- m32: number
  Moves the the drawing vertically
Returns Transform
A new instance of Transform.
createMatrix(
    om: ObjectManager,
    m11: number,
    m12: number,
    m21: number,
    m22: number,
    m31: number,
    m32: number,
): Transform
Creates a transformation based on the specified 3x2 matrix.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- m11: number
  Scales the drawing horizontally
- m12: number
  Skew the the drawing horizontally
- m21: number
  Skew the the drawing vertically
- m22: number
  Scales the drawing vertically
- m31: number
  Moves the the drawing horizontally
- m32: number
  Moves the the drawing vertically
Returns Transform
A new instance of Transform.

`Static`createRotation

createRotation(
    angle: number,
    angleUnits?: AngleUnits,
    cx?: number,
    cy?: number,
): Transform
Creates a rotation transformation.
Parameters
- angle: number
  The rotation angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.
createRotation(
    om: ObjectManager,
    angle: number,
    angleUnits?: AngleUnits,
    cx?: number,
    cy?: number,
): Transform
Creates a rotation transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- angle: number
  The rotation angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.

`Static`createScale

createScale(scaleFactor: number, cx?: number, cy?: number): Transform
Creates a scaling transformation.
Parameters
- scaleFactor: number
  The value to scale by on the X and Y axes.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.
createScale(
    om: ObjectManager,
    scaleFactor: number,
    cx?: number,
    cy?: number,
): Transform
Creates a scaling transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- scaleFactor: number
  The value to scale by on the X and Y axes.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.

`Static`createScaleXY

createScaleXY(
    scaleX: number,
    scaleY: number,
    cx?: number,
    cy?: number,
): Transform
Creates a scaling transformation.
Parameters
- scaleX: number
  The value to scale by on the X axis.
- scaleY: number
  The value to scale by on the Y axis.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.
createScaleXY(
    om: ObjectManager,
    scaleX: number,
    scaleY: number,
    cx?: number,
    cy?: number,
): Transform
Creates a scaling transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- scaleX: number
  The value to scale by on the X axis.
- scaleY: number
  The value to scale by on the Y axis.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.

`Static`createSkew

createSkew(
    angleX: number,
    angleY: number,
    angleUnits?: AngleUnits,
    cx?: number,
    cy?: number,
): Transform
Creates a skew transformation.
Parameters
- angleX: number
  The X angle.
- angleY: number
  The Y angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.
createSkew(
    om: ObjectManager,
    angleX: number,
    angleY: number,
    angleUnits?: AngleUnits,
    cx?: number,
    cy?: number,
): Transform
Creates a skew transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- angleX: number
  The X angle.
- angleY: number
  The Y angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns Transform
A new instance of Transform.

`Static`createTranslation

createTranslation(offsetX: number, offsetY: number): Transform
Creates a translation transformation.
Parameters
- offsetX: number
  The horizontal offset.
- offsetY: number
  The vertical offset.
Returns Transform
A new instance of Transform.
createTranslation(
    om: ObjectManager,
    offsetX: number,
    offsetY: number,
): Transform
Creates a translation transformation.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the Transform object.
- offsetX: number
  The horizontal offset.
- offsetY: number
  The vertical offset.
Returns Transform
A new instance of Transform.

applyTransform

applyTransform(transform: Transform): void
Applies the transformation to the current instance.
Parameters
- transform: Transform
  The Transform object to be multiplied by the current transformation matrix.
Returns void

clone

clone(): Transform
Creates a copy of the current transformation.

Returns Transform
A copy of the current Transform object.

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

pop

pop(): void
Restores the previously pushed transformation from the stack.

Returns void

push

push(): void
Saves the current transformation to the stack.

Returns void

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

reset

reset(): void
Resets the transformation to the identity matrix.

Returns void

rotate

rotate(angle: number, angleUnits?: AngleUnits, cx?: number, cy?: number): void
Applies the rotation transformation.
Parameters
- angle: number
  The rotation angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns void

scale

scale(scaleFactor: number, cx?: number, cy?: number): void
Applies the scaling transformation.
Parameters
- scaleFactor: number
  The value to scale by on the X and Y axes.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns void

scaleXY

scaleXY(scaleX: number, scaleY: number, cx?: number, cy?: number): void
Applies the scaling transformation.
Parameters
- scaleX: number
  The value to scale by on the X axis.
- scaleY: number
  The value to scale by on the Y axis.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns void

setTransform

setTransform(transform: Transform): void
Sets the transformation to the current instance.
Parameters
- transform: Transform
  The Transform object to replace the current transformation.
Returns void

skew

skew(
    angleX: number,
    angleY: number,
    angleUnits?: AngleUnits,
    cx?: number,
    cy?: number,
): void
Applies the skew transformation.
Parameters
- angleX: number
  The X angle.
- angleY: number
  The Y angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
- Optionalcx: number
  The optional center point X offset.
- Optionalcy: number
  The optional center point Y offset.
Returns void

skewX

skewX(angle: number, angleUnits?: AngleUnits): void
Applies the skew transformation along the X axis.
Parameters
- angle: number
  The X angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
Returns void

skewY

skewY(angle: number, angleUnits?: AngleUnits): void
Applies the skew transformation along the Y axis.
Parameters
- angle: number
  The Y angle.
- OptionalangleUnits: AngleUnits
  The angle units. The default is Degrees.
Returns void

transformPoint

transformPoint(point: Point): Point
Transforms a Point by the transformation matrix.
Parameters
- point: Point
  The original Point.
Returns Point
The transformed Point.

transformPoints

transformPoints(points: Point[]): Point[]
Transforms an array of Points by the transformation matrix.
Parameters
- points: Point[]
  The original array of Points.
Returns Point[]
The array of transformed Points.

transformQuadrilateral

transformQuadrilateral(quad: Quadrilateral): Quadrilateral
Transforms a ds.Quadrilateral by the transformation matrix.
Parameters
- quad: Quadrilateral
  The original ds.Quadrilateral.
Returns Quadrilateral
The transformed ds.Quadrilateral.

translate

translate(offsetX: number, offsetY: number): void
Applies the translation transformation.
Parameters
- offsetX: number
  The horizontal offset.
- offsetY: number
  The vertical offset.
Returns void

tryInvert

tryInvert(): boolean
Inverts the transformation matrix, if possible.

Returns boolean
true on success, false otherwise.

Class Transform

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

id

Returns number

matrix

Returns number[]

Parameters

Returns void

om

Returns ObjectManager

Methods

StaticcreateIdentity

Returns Transform

Parameters

Returns Transform

StaticcreateMatrix

Parameters

Returns Transform

Parameters

Returns Transform

StaticcreateRotation

Parameters

Returns Transform

Parameters

Returns Transform

StaticcreateScale

Parameters

Returns Transform

Parameters

Returns Transform

StaticcreateScaleXY

Parameters

Returns Transform

Parameters

Returns Transform

StaticcreateSkew

Parameters

Returns Transform

Parameters

Returns Transform

StaticcreateTranslation

Parameters

Returns Transform

Parameters

Returns Transform

applyTransform

Parameters

Returns void

clone

Returns Transform

free

Returns void

pop

Returns void

push

Returns void

rebind

Parameters

Returns void

reset

Returns void

rotate

Parameters

Returns void

scale

Parameters

Returns void

scaleXY

Parameters

Returns void

setTransform

Parameters

Returns void

skew

Parameters

Returns void

`Static`createIdentity

`Static`createMatrix

`Static`createRotation

`Static`createScale

`Static`createScaleXY

`Static`createSkew

`Static`createTranslation