Class MapViewEnvironment

Class handling the Scene Environment, like fog, sky, background datasource, clearColor etc for MapView

Hierarchy

MapViewEnvironment

Index

Constructors

constructor

Accessors

fog
lights

Methods

Constructors

constructor

new MapViewEnvironment(m_mapView: MapView, options: MapViewEnvironmentOptions): MapViewEnvironment

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:50
Parameters
- m_mapView: MapView
- options: MapViewEnvironmentOptions
Returns MapViewEnvironment

Accessors

fog

get fog(): MapViewFog

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:71
Returns MapViewFog

lights

get lights(): Light[]

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:67
Returns Light[]

Methods

clearBackgroundDataSource

clearBackgroundDataSource(): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:81
Returns void

update

update(): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:87
Returns void

updateBackgroundDataSource

updateBackgroundDataSource(): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:75
Returns void

updateClearColor

updateClearColor(clearColor?: undefined | string, clearAlpha?: undefined | number): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:98
Parameters
- Optional clearColor: undefined | string
- Optional clearAlpha: undefined | number
Returns void

updateLighting

updateLighting(lights?: Light[]): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:120
Parameters
- Optional lights: Light[]
Returns void

updateLights

updateLights(): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:168
Update the directional light camera. Note, this requires the cameras to first be updated.

Returns void

updateSkyBackground

updateSkyBackground(sky?: Sky, clearColor?: undefined | string): void

- Defined in @here/harp-mapview/lib/MapViewEnvironment.ts:106
Parameters
- Optional sky: Sky
- Optional clearColor: undefined | string
Returns void

Generated using TypeDoc