SkyAtmosphere

new Cesium.SkyAtmosphere(ellipsoid)
Scene/SkyAtmosphere.js 43

An atmosphere drawn around the limb of the provided ellipsoid. Based on Display of The Earth Taking Into Account Atmospheric Scattering.

This is only supported in 3D. Atmosphere is faded out when morphing to 2D or Columbus view.

Name Type Default Description
ellipsoid Ellipsoid Ellipsoid.WGS84 optional The ellipsoid that the atmosphere is drawn around.
Example:
scene.skyAtmosphere = new Cesium.SkyAtmosphere();
See:
  • Scene.skyAtmosphere

Members

atmosphereLightIntensity : Number
Scene/SkyAtmosphere.js 89

The intensity of the light that is used for computing the sky atmosphere color.
Default Value: 50.0

atmosphereMieAnisotropy : Number
Scene/SkyAtmosphere.js 131

The anisotropy of the medium to consider for Mie scattering.

Valid values are between -1.0 and 1.0.

Default Value: 0.9

atmosphereMieCoefficient : Cartesian3
Scene/SkyAtmosphere.js 105

The Mie scattering coefficient used in the atmospheric scattering equations for the sky atmosphere.
Default Value: Cartesian3(21e-6, 21e-6, 21e-6)

atmosphereMieScaleHeight : Number
Scene/SkyAtmosphere.js 121

The Mie scale height used in the atmospheric scattering equations for the sky atmosphere, in meters.
Default Value: 3200.0

atmosphereRayleighCoefficient : Cartesian3
Scene/SkyAtmosphere.js 97

The Rayleigh scattering coefficient used in the atmospheric scattering equations for the sky atmosphere.
Default Value: Cartesian3(5.5e-6, 13.0e-6, 28.4e-6)

atmosphereRayleighScaleHeight : Number
Scene/SkyAtmosphere.js 113

The Rayleigh scale height used in the atmospheric scattering equations for the sky atmosphere, in meters.
Default Value: 10000.0

brightnessShift : Number
Scene/SkyAtmosphere.js 155

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.
Default Value: 0.0

readonly ellipsoid : Ellipsoid
Scene/SkyAtmosphere.js 212

Gets the ellipsoid the atmosphere is drawn around.

hueShift : Number
Scene/SkyAtmosphere.js 139

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.
Default Value: 0.0

perFragmentAtmosphere : Boolean
Scene/SkyAtmosphere.js 61

Compute atmosphere per-fragment instead of per-vertex. This produces better looking atmosphere with a slight performance penalty.
Default Value: false

saturationShift : Number
Scene/SkyAtmosphere.js 147

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

show : Boolean
Scene/SkyAtmosphere.js 52

Determines if the atmosphere is shown.
Default Value: true

Methods

destroy()
Scene/SkyAtmosphere.js 395

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
skyAtmosphere = skyAtmosphere && skyAtmosphere.destroy();
See:

isDestroyed() → Boolean
Scene/SkyAtmosphere.js 375

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.