Class: SkyAtmosphere

SkyAtmosphere

new SkyAtmosphere(ellipsoidopt)

An atmosphere drawn around the limb of the provided ellipsoid. Based on Accurate Atmospheric Scattering in GPU Gems 2.

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

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

Members

brightnessShift :Number

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.
Type:
  • Number
Default Value:
  • 0.0
Source:

(readonly) ellipsoid :Ellipsoid

Gets the ellipsoid the atmosphere is drawn around.
Type:
Source:

hueShift :Number

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.
Type:
  • Number
Default Value:
  • 0.0
Source:

saturationShift :Number

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

show :Boolean

Determines if the atmosphere is shown.
Type:
  • Boolean
Default Value:
  • true
Source:

Methods

destroy() → {undefined}

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.
Source:
See:
Throws:
This object was destroyed, i.e., destroy() was called.
Type
DeveloperError
Returns:
Type
undefined
Example
skyAtmosphere = skyAtmosphere && skyAtmosphere.destroy();

isDestroyed() → {Boolean}

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.
Source:
See:
Returns:
true if this object was destroyed; otherwise, false.
Type
Boolean