Skip to main content

GraphicsGroup

A Graphic is the base Excalibur primitive for something that can be drawn to the ExcaliburGraphicsContext. Sprite, Animation, GraphicsGroup, Canvas, Rectangle, Circle, and Polygon all derive from the Graphic abstract class.

Implementors of a Graphic must override the abstract Graphic._drawImage method to render an image to the graphics context. Graphic handles all the position, rotation, and scale transformations in Graphic._preDraw and Graphic._postDraw

Hierarchy

Implements

Index

Constructors

constructor

Properties

readonlyid

id: number = ...

publicmembers

members: (Graphic | GraphicsGrouping)[] = []

publicopacity

opacity: number = 1

Gets or sets the opacity of the graphic, 0 is transparent, 1 is solid (opaque).

publicshowDebug

showDebug: boolean = false

Gets or sets wether to show debug information about the graphic

publicoptionaltint

tint?: Color

publictransform

transform: AffineMatrix = ...

publicuseAnchor

useAnchor: boolean = true

Accessors

publicflipHorizontal

  • get flipHorizontal(): boolean
  • set flipHorizontal(value: boolean): void
  • Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)


    Returns boolean

  • Parameters

    • value: boolean

    Returns void

publicflipVertical

  • get flipVertical(): boolean
  • set flipVertical(value: boolean): void
  • Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)


    Returns boolean

  • Parameters

    • value: boolean

    Returns void

publicheight

  • get height(): number
  • set height(value: number): void
  • Gets or sets the height of the graphic (always positive)


    Returns number

  • Parameters

    • value: number

    Returns void

publiclocalBounds

  • Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.


    Returns BoundingBox

publicorigin

  • Gets or sets the origin of the graphic, if not set the center of the graphic is the origin


    Returns Vector

  • Parameters

    Returns void

publicrotation

  • get rotation(): number
  • set rotation(value: number): void
  • Gets or sets the rotation of the graphic


    Returns number

  • Parameters

    • value: number

    Returns void

publicscale

  • Gets or sets the scale of the graphic, this affects the width and


    Returns Vector

  • Parameters

    Returns void

publicwidth

  • get width(): number
  • set width(value: number): void
  • Gets or sets the width of the graphic (always positive)


    Returns number

  • Parameters

    • value: number

    Returns void

Methods

publicclone

  • Returns a new instance of the graphic that has the same properties


    Returns GraphicsGroup

publiccloneGraphicOptions

publicdraw

  • Draw the whole graphic to the context including transform


    Parameters

    Returns void

publicisStale

  • isStale(): boolean
  • Returns boolean

publicreset

  • reset(): void
  • Returns void

publictick

  • tick(elapsedMilliseconds: number, idempotencyToken?: number): void
  • Parameters

    • elapsedMilliseconds: number

      The amount of real world time in milliseconds that has elapsed that must be updated in the animation

    • optionalidempotencyToken: number

      Optional idempotencyToken prevents a ticking animation from updating twice per frame

    Returns void