GraphicsComponent

Component to manage drawings, using with the position component

Hierarchy

• Component
  • GraphicsComponent

Index

Constructors

• constructor

Properties

• copyGraphics
• dependencies
• flipHorizontal
• flipVertical
• forceOnScreen
• material
• onPostDraw
• onPostTransformDraw
• onPreDraw
• onPreTransformDraw
• opacity
• owner
• visible

Accessors

• anchor
• bounds
• current
• currentOptions
• graphics
• localBounds
• offset
• options

Methods

• add
• clone
• getGraphic
• getNames
• getOptions
• hide
• onAdd
• onRemove
• recalculateBounds
• remove
• show
• use

Constructors

constructor

• new GraphicsComponent(options?: GraphicsComponentOptions): GraphicsComponent

• Overrides Component.constructor

  Parameters

  • optionaloptions: GraphicsComponentOptions

  Returns GraphicsComponent

Properties

publiccopyGraphics

copyGraphics: boolean = false

If set to true graphics added to the component will be copied. This can effect performance, but is useful if you don't want changes to a graphic to effect all the places it is used.

optionalreadonlydependencies

dependencies?: ComponentCtor<Component>[]

Inherited from Component.dependencies

Optionally list any component types this component depends on If the owner entity does not have these components, new components will be added to the entity

Only components with zero-arg constructors are supported as automatic component dependencies

publicflipHorizontal

flipHorizontal: boolean = false

Flip all graphics horizontally along the y-axis

publicflipVertical

flipVertical: boolean = false

Flip all graphics vertically along the x-axis

publicforceOnScreen

forceOnScreen: boolean = false

Optionally force the graphic onscreen, default false. Not recommend to use for perf reasons, only if you known what you're doing.

publicmaterial

material: Material = null

publicoptionalonPostDraw

onPostDraw?: (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void

Draws after the entity transform has been applied, and after graphics component graphics has been drawn

---

Type declaration

• • (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void

  • Draws after the entity transform has been applied, and after graphics component graphics has been drawn

    ---

    Parameters

    • ctx: ExcaliburGraphicsContext

    • elapsedMilliseconds: number

    Returns void

publicoptionalonPostTransformDraw

onPostTransformDraw?: (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void

Draws after the entity transform has been applied, and after all graphics component drawing

---

Type declaration

• • (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void

  • Draws after the entity transform has been applied, and after all graphics component drawing

    ---

    Parameters

    • ctx: ExcaliburGraphicsContext

    • elapsedMilliseconds: number

    Returns void

publicoptionalonPreDraw

onPreDraw?: (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void

Draws after the entity transform has been applied, but before graphics component graphics have been drawn

---

Type declaration

• • (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void

  • Draws after the entity transform has been applied, but before graphics component graphics have been drawn

    ---

    Parameters

    • ctx: ExcaliburGraphicsContext

    • elapsedMilliseconds: number

    Returns void

publicoptionalonPreTransformDraw

onPreTransformDraw?: (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void

Draws before the entity transform has been applied before any any graphics component drawing

---

Type declaration

• • (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void

  • Draws before the entity transform has been applied before any any graphics component drawing

    ---

    Parameters

    • ctx: ExcaliburGraphicsContext

    • elapsedMilliseconds: number

    Returns void

publicopacity

opacity: number = 1

Sets or gets wither all drawings should have an opacity applied

optionalowner

owner?: Entity<any> = undefined

Inherited from Component.owner

Current owning Entity, if any, of this component. Null if not added to any Entity

publicvisible

visible: boolean = true

Sets or gets wether any drawing should be visible in this component

Accessors

publicanchor

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

• Anchor to apply to graphics by default

  ---

  Returns Vector

• Parameters

  • value: Vector

  Returns void

publicbounds

• get bounds(): BoundingBox

• Get world bounds of graphics component

  ---

  Returns BoundingBox

publiccurrent

• get current(): Graphic

• Returns the currently displayed graphic

  ---

  Returns Graphic

publiccurrentOptions

• get currentOptions(): GraphicsShowOptions

• Returns the currently displayed graphic offsets

  ---

  Returns GraphicsShowOptions

publicgraphics

• get graphics(): {}

• Returns all graphics associated with this component

  ---

  Returns {}

  • [graphicName string]: Graphic

publiclocalBounds

• get localBounds(): BoundingBox
• set localBounds(bounds: BoundingBox): void

• Get local bounds of graphics component

  ---

  Returns BoundingBox

• Parameters

  • bounds: BoundingBox

  Returns void

publicoffset

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

• Offset to apply to graphics by default

  ---

  Returns Vector

• Parameters

  • value: Vector

  Returns void

publicoptions

• get options(): {}

• Returns all graphics options associated with this component

  ---

  Returns {}

  • [graphicName string]: GraphicsShowOptions | undefined

Methods

publicadd

• add(graphic: Graphic, options?: GraphicsShowOptions): Graphic
• add(name: string, graphic: Graphic, options?: GraphicsShowOptions): Graphic

• Adds a named graphic to this component, if the name is "default" or not specified, it will be shown by default without needing to call

  ---

  Parameters

  • graphic: Graphic

  • optionaloptions: GraphicsShowOptions

  Returns Graphic

publicclone

• clone(): GraphicsComponent

• Overrides Component.clone

  Clones any properties on this component, if that property value has a clone() method it will be called

  ---

  Returns GraphicsComponent

publicgetGraphic

• getGraphic(name: string): Graphic

• Parameters

  • name: string

  Returns Graphic

publicgetNames

• getNames(): string[]

• Get registered graphics names

  ---

  Returns string[]

publicgetOptions

• getOptions(name: string): GraphicsShowOptions

• Parameters

  • name: string

  Returns GraphicsShowOptions

publichide

• hide(): void

• Hide currently shown graphic

  ---

  Returns void

optionalonAdd

• onAdd(owner: Entity<any>): void

• Inherited from Component.onAdd

  Optional callback called when a component is added to an entity

  ---

  Parameters

  • owner: Entity<any>

  Returns void

optionalonRemove

• onRemove(previousOwner: Entity<any>): void

• Inherited from Component.onRemove

  Optional callback called when a component is removed from an entity

  ---

  Parameters

  • previousOwner: Entity<any>

  Returns void

publicrecalculateBounds

• recalculateBounds(): void

• Returns void

publicremove

• remove(name: string): void

• Removes a registered graphic, if the removed graphic is the current it will switch to the default

  ---

  Parameters

  • name: string

  Returns void

publicshow

• show<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T

• Shows a graphic, will be removed

  @deprecated

  will be removed in v0.30.0, use graphics.use(...)

  ---

  Type parameters

  • T: Graphic = Graphic

  Parameters

  • nameOrGraphic: string | T

  • optionaloptions: GraphicsShowOptions

  Returns T

publicuse

• use<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T

• Use a graphic only, will set the default graphic. Returns the new Graphic

  Optionally override the stored options

  ---

  Type parameters

  • T: Graphic = Graphic

  Parameters

  • nameOrGraphic: string | T

  • optionaloptions: GraphicsShowOptions

  Returns T