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

• Graphic
  • GraphicsGroup

Implements

• HasTick

Index

Constructors

• constructor

Properties

• id
• members
• opacity
• shouldAlwaysTick
• showDebug
• tint
• transform
• useAnchor

Accessors

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

Methods

• clone
• cloneGraphicOptions
• draw
• isStale
• reset
• tick

Constructors

constructor

• GraphicsGroup(options: GraphicsGroupingOptions & GraphicOptions): GraphicsGroup

• Overrides Graphic.constructor

  Parameters

  • options: GraphicsGroupingOptions & GraphicOptions

  Returns GraphicsGroup

Properties

readonlyinheritedid

id: number = ...

Inherited from Graphic.id

publicmembers

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

publicinheritedopacity

opacity: number = 1

Inherited from Graphic.opacity

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

publicshouldAlwaysTick

shouldAlwaysTick: boolean = false

Implementation of HasTick.shouldAlwaysTick

Optional property to tick any graphics EVEN when offscreen, this is useful when you want to keep animations synchronized across your game scene.

publicinheritedshowDebug

showDebug: boolean = false

Inherited from Graphic.showDebug

Gets or sets wether to show debug information about the graphic

publicoptionalinheritedtint

tint?: Color

Inherited from Graphic.tint

publicinheritedtransform

transform: AffineMatrix = ...

Inherited from Graphic.transform

publicuseAnchor

useAnchor: boolean = true

Accessors

publicinheritedflipHorizontal

• get flipHorizontal(): boolean
• set flipHorizontal(value: boolean): void

• Inherited from Graphic.flipHorizontal

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

  ---

  Returns boolean

• Inherited from Graphic.flipHorizontal

  Parameters

  • value: boolean

  Returns void

publicinheritedflipVertical

• get flipVertical(): boolean
• set flipVertical(value: boolean): void

• Inherited from Graphic.flipVertical

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

  ---

  Returns boolean

• Inherited from Graphic.flipVertical

  Parameters

  • value: boolean

  Returns void

publicinheritedheight

• get height(): number
• set height(value: number): void

• Inherited from Graphic.height

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

  ---

  Returns number

• Inherited from Graphic.height

  Parameters

  • value: number

  Returns void

publiclocalBounds

• get localBounds(): BoundingBox

• Overrides Graphic.localBounds

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

  ---

  Returns BoundingBox

publicinheritedorigin

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

• Inherited from Graphic.origin

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

  ---

  Returns Vector | undefined

• Inherited from Graphic.origin

  Parameters

  • value: Vector | undefined

  Returns void

publicinheritedrotation

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

• Inherited from Graphic.rotation

  Gets or sets the rotation of the graphic

  ---

  Returns number

• Inherited from Graphic.rotation

  Parameters

  • value: number

  Returns void

publicinheritedscale

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

• Inherited from Graphic.scale

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

  ---

  Returns Vector

• Inherited from Graphic.scale

  Parameters

  • value: Vector

  Returns void

publicinheritedwidth

• get width(): number
• set width(value: number): void

• Inherited from Graphic.width

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

  ---

  Returns number

• Inherited from Graphic.width

  Parameters

  • value: number

  Returns void

Methods

publicclone

• clone(): GraphicsGroup

• Overrides Graphic.clone

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

  ---

  Returns GraphicsGroup

publicinheritedcloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Inherited from Graphic.cloneGraphicOptions

  Returns GraphicOptions

publicinheriteddraw

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

• Inherited from Graphic.draw

  Draw the whole graphic to the context including transform

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicinheritedisStale

• isStale(): boolean

• Inherited from Graphic.isStale

  Returns boolean

publicreset

• reset(): void

• Returns void

publictick

• tick(elapsed: number, idempotencyToken?: number): void

• Implementation of HasTick.tick

  Parameters

  • elapsed: 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