Transform

Index

Constructors

• constructor

Accessors

• children
• globalPos
• globalRotation
• globalScale
• globalZ
• inverse
• matrix
• parent
• pos
• rotation
• scale
• z

Methods

• apply
• applyInverse
• clone
• cloneWithParent
• flagDirty
• isMirrored
• setTransform
• toString

Constructors

constructor

• new Transform(): Transform

• Returns Transform

Accessors

children

• get children(): readonly Transform[]

• Returns readonly Transform[]

globalPos

• get globalPos(): Vector
• set globalPos(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

globalRotation

• get globalRotation(): number
• set globalRotation(rotation: number): void

• Returns number

• Parameters

  • rotation: number

  Returns void

globalScale

• get globalScale(): Vector
• set globalScale(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

globalZ

• get globalZ(): number
• set globalZ(z: number): void

• Returns number

• Parameters

  • z: number

  Returns void

publicinverse

• get inverse(): AffineMatrix

• Calculates and returns the inverse matrix representation of this transform

  ---

  Returns AffineMatrix

publicmatrix

• get matrix(): AffineMatrix

• Calculates and returns the matrix representation of this transform

  Avoid mutating the matrix to update the transform, it is not the source of truth. Update the transform pos, rotation, scale.

  ---

  Returns AffineMatrix

parent

• get parent(): Transform
• set parent(transform: Transform): void

• Returns Transform

• Parameters

  • transform: Transform

  Returns void

pos

• get pos(): Vector
• set pos(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

rotation

• get rotation(): number
• set rotation(rotation: number): void

• Returns number

• Parameters

  • rotation: number

  Returns void

scale

• get scale(): Vector
• set scale(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

z

• get z(): number
• set z(z: number): void

• Returns number

• Parameters

  • z: number

  Returns void

Methods

publicapply

• apply(point: Vector): Vector

• Parameters

  • point: Vector

  Returns Vector

publicapplyInverse

• applyInverse(point: Vector): Vector

• Parameters

  • point: Vector

  Returns Vector

publicclone

• clone(dest?: Transform): Transform

• Clones the current transform Warning does not clone the parent

  ---

  Parameters

  • optionaldest: Transform

  Returns Transform

publiccloneWithParent

• cloneWithParent(dest?: Transform): Transform

• Clones but keeps the same parent reference

  ---

  Parameters

  • optionaldest: Transform

  Returns Transform

publicflagDirty

• flagDirty(): void

• Returns void

publicisMirrored

• isMirrored(): boolean

• Returns true if the transform has a negative x scale or y scale, but not both

  ---

  Returns boolean

publicsetTransform

• setTransform(pos: Vector, rotation: number, scale: Vector): void

• Parameters

  • pos: Vector

  • rotation: number

  • scale: Vector

  Returns void

publictoString

• toString(): string

• Returns string