org.cesiumjs.cs.scene

Class Sun

java.lang.Object

org.cesiumjs.cs.scene.Sun

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	glowFactor Gets or sets a number that controls how "bright" the Sun's lens flare appears to be.
boolean	show Determines if the sun will be shown.

Constructor Summary

Constructors

Constructor and Description
Sun() Draws a sun billboard.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the WebGL resources held by this object.
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

glowFactor

@JsProperty
public double glowFactor

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. Default: 1.0

show

@JsProperty
public boolean show

Determines if the sun will be shown. Default: true

Constructor Detail

Sun

@JsConstructor
public Sun()

Draws a sun billboard. This is only supported in 3D and Columbus view.

See Also:

Scene.sun

Method Detail

destroy

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

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()