flywave-mapview.mapviewatmosphere._constructor_

Home > @flywave/flywave-mapview > MapViewAtmosphere > (constructor)

MapViewAtmosphere.(constructor)

Creates and adds Atmosphere effects to the scene.

Currently works only with globe projection.

Signature:

constructor(m_mapAnchors: MapAnchors, m_sceneCamera: THREE.Camera, m_projection: Projection, m_rendererCapabilities: THREE.WebGLCapabilities, m_updateCallback?: () => void, m_atmosphereVariant?: AtmosphereVariant, m_materialVariant?: AtmosphereShadingVariant);

Parameters

Parameter	Type	Description
m_mapAnchors	MapAnchors	The MapAnchors instance where the effect will be added.
m_sceneCamera	THREE.Camera	The camera used to render entire scene.
m_projection	Projection	The geo-projection used to transform geo coordinates to cartesian space.
m_rendererCapabilities	THREE.WebGLCapabilities	The capabilities of the WebGL renderer.
m_updateCallback	() => void	(Optional) The optional callback to that should be called whenever atmosphere configuration changes, may be used to inform related components (MapView) to redraw.
m_atmosphereVariant	AtmosphereVariant	(Optional) The optional atmosphere configuration variant enum [[AtmosphereVariant]], which denotes where the atmosphere scattering effect should be applied, it may be ground or sky atmosphere only or most realistic for both, which is chosen by default.
m_materialVariant	AtmosphereShadingVariant	(Optional) The optional material variant to be used, mainly for testing and tweaking purposes.