Class MapViewFog

Manages the fog display in MapView.

Hierarchy

MapViewFog

Index

Constructors

constructor

Accessors

enabled

Methods

reset
update

Constructors

constructor

new MapViewFog(m_scene: Scene): MapViewFog

- Defined in @here/harp-mapview/lib/MapViewFog.ts:21
Constructs a MapViewFog instance.

Parameters
- m_scene: Scene
  
  The scene used in MapView that contains the map objects.
Returns MapViewFog

Accessors

enabled

get enabled(): boolean
set enabled(enableFog: boolean): void

- Defined in @here/harp-mapview/lib/MapViewFog.ts:49
Returns the current fog status, enabled or disabled.

Returns boolean
- Defined in @here/harp-mapview/lib/MapViewFog.ts:37
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

reset

reset(fog?: Fog): void

- Defined in @here/harp-mapview/lib/MapViewFog.ts:63
Sets the fog depending on the {@link @here/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

update

update(mapView: MapView, viewDistance?: undefined | number): void

- Defined in @here/harp-mapview/lib/MapViewFog.ts:84
Updates the fog at runtime, depending on the camera.

Parameters
- mapView: MapView
- Optional viewDistance: undefined | number
Returns void

Generated using TypeDoc