org.cesiumjs.cs.core

Class SkyAtmosphere

java.lang.Object

org.cesiumjs.cs.core.SkyAtmosphere

@JsType(isNative=true,
        namespace="Cesium",
        name="SkyAtmosphere")
public class SkyAtmosphere
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
float	brightnessShift The brightness shift to apply to the atmosphere.
float	hueShift The hue shift to apply to the atmosphere.
float	saturationShift The saturation shift to apply to the atmosphere.
boolean	show Determines if the atmosphere is shown.

Constructor Summary

Constructors

Constructor and Description
SkyAtmosphere() An atmosphere drawn around the limb of the provided ellipsoid.
SkyAtmosphere(Ellipsoid ellipsoid) An atmosphere drawn around the limb of the provided ellipsoid.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the WebGL resources held by this object.
Ellipsoid	ellipsoid() Gets the ellipsoid the atmosphere is drawn around.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

brightnessShift

@JsProperty
public float brightnessShift

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: 0.0

hueShift

@JsProperty
public float hueShift

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: 0.0

saturationShift

@JsProperty
public float saturationShift

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

show

@JsProperty
public boolean show

Determines if the atmosphere is shown. Default: true

Constructor Detail

SkyAtmosphere

@JsConstructor
public SkyAtmosphere()

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.

See Also:

Scene.skyAtmosphere

SkyAtmosphere

@JsConstructor
public SkyAtmosphere(Ellipsoid ellipsoid)

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:

ellipsoid - The ellipsoid that the atmosphere is drawn around. Default: Ellipsoid.WGS84()

See Also:

Scene.skyAtmosphere

Method Detail

ellipsoid

@JsProperty(name="ellipsoid")
public Ellipsoid ellipsoid()

Gets the ellipsoid the atmosphere is drawn around.

destroy

@JsMethod
public void destroy()

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.

See Also:

isDestroyed()

isDestroyed

@JsMethod
public boolean isDestroyed()

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 Also:

destroy()