Sprite

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

Index

Constructors

• constructor

Properties

• destSize
• id
• image
• opacity
• showDebug
• sourceView
• tint
• transform

Accessors

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

Methods

• _drawImage
• clone
• cloneGraphicOptions
• draw
• isStale
• from

Constructors

constructor

• new Sprite(options: GraphicOptions & SpriteOptions): Sprite

• Overrides Graphic.constructor

  Parameters

  • options: GraphicOptions & SpriteOptions

  Returns Sprite

Properties

publicdestSize

destSize: DestinationSize

readonlyid

id: number = ...

Inherited from Graphic.id

publicimage

image: ImageSource

publicopacity

opacity: number = 1

Inherited from Graphic.opacity

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

publicshowDebug

showDebug: boolean = false

Inherited from Graphic.showDebug

Gets or sets wether to show debug information about the graphic

publicsourceView

sourceView: SourceView

publicoptionaltint

tint?: Color

Inherited from Graphic.tint

publictransform

transform: AffineMatrix = ...

Inherited from Graphic.transform

Accessors

publicflipHorizontal

• 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

publicflipVertical

• 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

publicheight

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

• Overrides Graphic.height

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

  ---

  Returns number

• Overrides Graphic.height

  Parameters

  • newHeight: number

  Returns void

publiclocalBounds

• get localBounds(): BoundingBox

• Inherited from Graphic.localBounds

  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

• 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

• Inherited from Graphic.origin

  Parameters

  • value: Vector

  Returns void

publicrotation

• 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

publicscale

• 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

publicwidth

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

• Overrides Graphic.width

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

  ---

  Returns number

• Overrides Graphic.width

  Parameters

  • newWidth: number

  Returns void

Methods

public_drawImage

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

• Overrides Graphic._drawImage

  Parameters

  • ex: ExcaliburGraphicsContext

  • x: number

  • y: number

  Returns void

publicclone

• clone(): Sprite

• Overrides Graphic.clone

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

  ---

  Returns Sprite

publiccloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Inherited from Graphic.cloneGraphicOptions

  Returns GraphicOptions

publicdraw

• 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

publicisStale

• isStale(): boolean

• Inherited from Graphic.isStale

  Returns boolean

publicstaticfrom

• from(image: ImageSource): Sprite

• Parameters

  • image: ImageSource

  Returns Sprite