Class MapViewAtmosphere

constructor

• new MapViewAtmosphere(m_mapAnchors, m_sceneCamera, m_projection, m_rendererCapabilities, m_updateCallback?, m_atmosphereVariant?, m_materialVariant?): MapViewAtmosphere

• Creates and adds Atmosphere effects to the scene.

  Parameters

  • m_mapAnchors: MapAnchors

    The MapAnchors instance where the effect will be added.

  • m_sceneCamera: Camera

    The camera used to render entire scene.

  • m_projection: Projection

    The geo-projection used to transform geo coordinates to cartesian space.

  • m_rendererCapabilities: WebGLCapabilities

    The capabilities of the WebGL renderer.

  • Optional m_updateCallback: (() => void)

    The optional callback to that should be called whenever atmosphere configuration changes, may be used to inform related components (MapView) to redraw.

    • • (): void

      • Returns void

  • m_atmosphereVariant: AtmosphereVariant = AtmosphereVariant.SkyAndGround

    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 = AtmosphereShadingVariant.ScatteringShader

    The optional material variant to be used, mainly for testing and tweaking purposes.

  Returns MapViewAtmosphere

  Note

  Currently works only with globe projection.

Static GroundAtmosphereUserName

Static SkyAtmosphereUserName

enabled

• get enabled(): boolean

• Returns the current atmosphere status, enabled or disabled.

  Returns boolean
• set enabled(enable): void

• Allows to enable/disable the atmosphere effect, regardless of the theme settings.

  Use this method to change the setup in runtime without defining corresponding theme setup.

  Parameters

  • enable: boolean

    A boolean that specifies whether the atmosphere should be enabled or disabled.

  Returns void

groundMesh

• get groundMesh(): undefined | Mesh<BufferGeometry, Material | Material[]>

• Returns undefined | Mesh<BufferGeometry, Material | Material[]>

lightMode

• set lightMode(lightMode): void

• Parameters

  • lightMode: AtmosphereLightMode

  Returns void

skyMesh

• get skyMesh(): undefined | Mesh<BufferGeometry, Material | Material[]>

• Returns undefined | Mesh<BufferGeometry, Material | Material[]>

dispose

• dispose(): void

• Disposes allocated resources.

  Returns void

reset

• reset(theme): void

• Sets the atmosphere depending on the @xyzmaps/harp-datasource-protocol#Theme instance provided.

  This function is called when a theme is loaded. Atmosphere is added only if the theme contains a atmosphere definition with a:

  • color property, used to set the atmosphere color.

  Parameters

  • theme: Theme

    A @xyzmaps/harp-datasource-protocol#Theme instance.

  Returns void

Static isPresent

• isPresent(mapAnchors): boolean

• Check if map anchors have already atmosphere effect added.

  Parameters

  • mapAnchors: MapAnchors

    MapAnchors to check.

  Returns boolean