Atmosphere

external class Atmosphere(source)

Common atmosphere settings used by 3D Tiles and models for rendering sky atmosphere, ground atmosphere, and fog.

This class is not to be confused with SkyAtmosphere, which is responsible for rendering the sky.

While the atmosphere settings affect the color of fog, see Fog to control how fog is rendered.

// Turn on dynamic atmosphere lighting using the sun direction
scene.atmosphere.dynamicLighting = DynamicAtmosphereLightingType.SUNLIGHT;
// Turn on dynamic lighting using whatever light source is in the scene
scene.light = new DirectionalLight({
direction: new Cartesian3(1, 0, 0)
});
scene.atmosphere.dynamicLighting = DynamicAtmosphereLightingType.SCENE_LIGHT;
// Adjust the color of the atmosphere effects.
scene.atmosphere.hueShift = 0.4; // Cycle 40% around the color wheel
scene.atmosphere.brightnessShift = 0.25; // Increase the brightness
scene.atmosphere.saturationShift = -0.1; // Desaturate the colors

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). A brightness shift of -1.0 is complete darkness, which will let space show through.

Link copied to clipboard

When not DynamicAtmosphereLightingType.NONE, the selected light source will be used for dynamically lighting all atmosphere-related rendering effects.

Link copied to clipboard

The hue shift to apply to the atmosphere. Defaults to 0.0 (no shift). A hue shift of 1.0 indicates a complete rotation of the hues available.

Link copied to clipboard

The intensity of the light that is used for computing the ground atmosphere color.

Link copied to clipboard

The anisotropy of the medium to consider for Mie scattering.

Link copied to clipboard

The Mie scattering coefficient used in the atmospheric scattering equations for the ground atmosphere.

Link copied to clipboard

The Mie scale height used in the atmospheric scattering equations for the ground atmosphere, in meters.

Link copied to clipboard

The Rayleigh scattering coefficient used in the atmospheric scattering equations for the ground atmosphere.

Link copied to clipboard

The Rayleigh scale height used in the atmospheric scattering equations for the ground atmosphere, in meters.

Link copied to clipboard

The saturation shift to apply to the atmosphere. Defaults to 0.0 (no shift). A saturation shift of -1.0 is monochrome.