Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • any
    • WeatherEffects

Index

Constructors

  • Returns WeatherEffects

Properties

mask: any
sortableChildren: boolean
eventMode: string
filterArea: any
effects: Map<string, (ParticleEffect | WeatherShaderEffect)[]> = ...

Array of weather effects linked to this weather container.

A default configuration of the terrain mask that is automatically applied to any shader-based weather effects. This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.

A default configuration of the terrain mask that is automatically applied to any shader-based weather effects. This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.

#elevation: number = Infinity
PRIMARY_SORT_ORDER: number = 1000

Sorting values to deal with ties.

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 layerOptions(): any
  • inheritdoc

    Returns any

Methods

  • _draw(options: any): Promise<void>
  • override

    Parameters

    • options: any

    Returns Promise<void>

  • _tearDown(options: any): Promise<void>
  • override

    Parameters

    • options: any

    Returns Promise<void>

  • initializeEffects(weatherEffectsConfig: any): void
  • Initialize the weather container from a weather config object.

    Parameters

    • weatherEffectsConfig: any

    Returns void

  • clearEffects(): void
  • Clear the weather container.

    Returns void

  • #initializeInverseOcclusionFilter(): void
  • Initialize the inverse occlusion filter.

    Returns void

  • #destroyEffects(): void
  • Destroy all effects associated with this weather container.

    Returns void

  • #constructEffects(weatherEffectsConfig: any): boolean
  • Construct effects according to the weather effects config object.

    Parameters

    • weatherEffectsConfig: any

    Returns boolean

  • Set the occlusion uniforms for this weather shader.

    Parameters

    Returns void

  • Set the terrain uniforms for this weather shader.

    Parameters

    Returns void