Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

id: number = ...
opacity: number = 1

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

showDebug: boolean = false

Gets or sets wether to show debug information about the graphic

tint: Color = null
transform: AffineMatrix = ...

Accessors

  • 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

  • Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)

    Parameters

    • value: boolean

    Returns void

  • 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

  • Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)

    Parameters

    • value: boolean

    Returns void

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

    Returns number

  • Gets or sets the height of the graphic (always positive)

    Parameters

    • value: number

    Returns void

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

    Returns Vector

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

    Parameters

    Returns void

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

    Returns number

  • Gets or sets the width of the graphic (always positive)

    Parameters

    • value: number

    Returns void

Methods

  • Meant to be overridden by the graphic implementation to draw the underlying image (HTMLCanvasElement or HTMLImageElement) to the graphics context without transform. Transformations like position, rotation, and scale are handled by Graphic._preDraw and Graphic._postDraw

    Parameters

    Returns void

  • isStale(): boolean