GraphicsComponentOptions

Index

Properties

• anchor
• copyGraphics
• current
• graphics
• material
• offset
• onPostDraw
• onPostTransformDraw
• onPreDraw
• onPreTransformDraw
• opacity
• visible

Properties

optionalanchor

anchor?: Vector

Optional anchor

optionalcopyGraphics

copyGraphics?: boolean

Optionally copy instances of graphics by calling .clone(), you may set this to false to avoid sharing graphics when added to the component for performance reasons. By default graphics are not copied and are shared when added to the component.

optionalcurrent

current?: string

Name of current graphic to use

optionalgraphics

graphics?: {}

List of graphics and optionally the options per graphic

---

Type declaration

• [graphicName string]: Graphic | { graphic: Graphic; options: GraphicsShowOptions }

optionalmaterial

material?: Material

Optionally set a material to use on the graphic

optionaloffset

offset?: Vector

Optional offset in absolute pixels to shift all graphics in this component from each graphic's anchor (default is top left corner)

optionalonPostDraw

onPostDraw?: (ex: ExcaliburGraphicsContext, elapsed: number) => void

Type declaration

• • (ex: ExcaliburGraphicsContext, elapsed: number): void

  • Parameters

    • ex: ExcaliburGraphicsContext

    • elapsed: number

    Returns void

optionalonPostTransformDraw

onPostTransformDraw?: (ex: ExcaliburGraphicsContext, elapsed: number) => void

Type declaration

• • (ex: ExcaliburGraphicsContext, elapsed: number): void

  • Parameters

    • ex: ExcaliburGraphicsContext

    • elapsed: number

    Returns void

optionalonPreDraw

onPreDraw?: (ex: ExcaliburGraphicsContext, elapsed: number) => void

Type declaration

• • (ex: ExcaliburGraphicsContext, elapsed: number): void

  • Parameters

    • ex: ExcaliburGraphicsContext

    • elapsed: number

    Returns void

optionalonPreTransformDraw

onPreTransformDraw?: (ex: ExcaliburGraphicsContext, elapsed: number) => void

Type declaration

• • (ex: ExcaliburGraphicsContext, elapsed: number): void

  • Parameters

    • ex: ExcaliburGraphicsContext

    • elapsed: number

    Returns void

optionalopacity

opacity?: number

Optional opacity

optionalvisible

visible?: boolean

Optional visible flag, if the graphics component is not visible it will not be displayed