new Sun()
Draws a sun billboard.
This is only supported in 3D and Columbus view.
- Source:
- See:
Example
scene.sun = new Cesium.Sun();
Members
glowFactor :Number
Gets or sets a number that controls how "bright" the Sun's lens flare appears
to be. Zero shows just the Sun's disc without any flare.
Use larger values for a more pronounced flare around the Sun.
Type:
- Number
- Default Value:
- 1.0
- Source:
show :Boolean
Determines if the sun will be 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
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
sun = sun && sun.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
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