abstractGraphic

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

• Graphic
  • Sprite
  • GraphicsGroup
  • Animation
  • Line
  • Raster
  • Text
  • Font
  • SpriteFont

Index

Constructors

• constructor

Properties

• id
• opacity
• showDebug
• tint
• transform

Accessors

• flipHorizontal
• flipVertical
• height
• localBounds
• origin
• rotation
• scale
• width

Methods

• clone
• cloneGraphicOptions
• draw
• isStale

Constructors

constructor

• new Graphic(options?: GraphicOptions): Graphic

• Parameters

  • optionaloptions: GraphicOptions

  Returns Graphic

Properties

readonlyid

id: number = ...

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 = ...

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

• get localBounds(): BoundingBox

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

  ---

  Returns BoundingBox

publicorigin

• get origin(): Vector
• set origin(value: Vector): void

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

  ---

  Returns Vector

• Parameters

  • value: Vector

  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

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

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

  ---

  Returns Vector

• Parameters

  • value: Vector

  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

abstractclone

• clone(): Graphic

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

  ---

  Returns Graphic

publiccloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Returns GraphicOptions

publicdraw

• draw(ex: ExcaliburGraphicsContext, x: number, y: number): void

• Draw the whole graphic to the context including transform

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicisStale

• isStale(): boolean

• Returns boolean