Class SkyBackground

Class that handles MapView's sky background.

Hierarchy

SkyBackground

Index

Constructors

constructor

Accessors

texture

Methods

Constructors

constructor

new SkyBackground(m_sky: GradientSky | CubemapSky, m_projectionType: ProjectionType, camera: Camera): SkyBackground

- Defined in @here/harp-mapview/lib/SkyBackground.ts:18
Constructs a new SkyBackground.

Parameters
- m_sky: GradientSky | CubemapSky
  
  Sky configuration parameters.
- m_projectionType: ProjectionType
  
  MapView's projection type.
- camera: Camera
  
  MapView's camera.
Returns SkyBackground

Accessors

texture

get texture(): Texture

- Defined in @here/harp-mapview/lib/SkyBackground.ts:54
Sky texture.

Returns Texture

Methods

dispose

dispose(): void

- Defined in @here/harp-mapview/lib/SkyBackground.ts:47
Disposes allocated resources.

Returns void

updateCamera

updateCamera(camera: Camera): void

- Defined in @here/harp-mapview/lib/SkyBackground.ts:63
This method updates the skybox based on the camera position (needed for some types of sky).

Parameters
- camera: Camera
  
  The camera used in the map view.
Returns void

updateTexture

updateTexture(params: GradientSky | CubemapSky, projectionType: ProjectionType): void

- Defined in @here/harp-mapview/lib/SkyBackground.ts:76
Updates the sky texture with new parameters.

Parameters
- params: GradientSky | CubemapSky
  
  New sky configuration parameters.
- projectionType: ProjectionType
  
  Which projection is used, this may also change (in which case the textures should be recreated).
Returns void

Generated using TypeDoc