Options
All
  • Public
  • Public/Protected
  • All
Menu

A CanvasLayer for displaying visual effects like weather, transitions, flashes, or more.

Hierarchy

Index

Constructors

Properties

The weather overlay container

weatherEffect: ParticleEffect

The currently active weather effect

weatherOcclusionFilter: AbstractBaseMaskFilter

An occlusion filter that prevents weather from being displayed in certain regions

options: { name: string } = ...

Options for this layer instance.

Type declaration

  • name: string
interactiveChildren: boolean = false
renderable: boolean
#elevation: number = Infinity

Accessors

  • get elevation(): number
  • set elevation(value: number): void
  • Define an elevation property on the WeatherEffects layer. This approach is used for now until the weather elevation property is formally added to the Scene data schema.

    Returns number

  • Define an elevation property on the WeatherEffects layer. This approach is used for now until the weather elevation property is formally added to the Scene data schema.

    Parameters

    • value: number

    Returns void

  • get name(): string
  • The canonical name of the CanvasLayer

    Returns string

  • get layerOptions(): any
  • inheritdoc

    Returns any

  • Return a reference to the active instance of this canvas layer

    Returns CanvasLayer

Methods

  • _draw(options: any): Promise<void>
  • _tearDown(options: any): Promise<void>
  • The inner _tearDown method which may be customized by each CanvasLayer subclass.

    Parameters

    • options: any

    Returns Promise<void>

  • Draw the weather container.

    Returns FullCanvasContainer

    The weather container, or null if no effect is present

  • Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.

    Parameters

    • options: any = {}

    Returns Promise<CanvasLayer>

  • Deconstruct data used in the current layer in preparation to re-draw the canvas

    Parameters

    • options: any = {}

    Returns Promise<CanvasLayer>