Class MapViewFog

Manages the fog display in MapView.

Hierarchy

  • MapViewFog

Constructors

Accessors

Methods

Constructors

Accessors

  • get enabled(): boolean
  • Returns the current fog status, enabled or disabled.

    Returns boolean

  • set enabled(enableFog): void
  • Allows for disabling the fog, even if it is defined in the theme. Use this property for custom views like the demo app's debug camera. However, if the theme does not define a fog, enabling this property here has no effect.

    Parameters

    • enableFog: boolean

    Returns void

Methods

  • Sets the fog depending on the @xyzmaps/harp-datasource-protocol#Theme instance provided. This function is called when a theme is loaded. Fog is added only if the theme contains a fog definition with a:

    • color property, used to set the fog color.
    • startRatio property, used to set the start distance of the fog as a ratio of the far clipping plane distance.

    Parameters

    • Optional fog: Fog

    Returns void

Generated using TypeDoc