org.cesiumjs.cs.core.options

Class SkyBoxOptions

java.lang.Object

org.cesiumjs.cs.core.options.SkyBoxOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class SkyBoxOptions
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	show Determines if this primitive will be shown.
SkyBoxSources	sources The source URL or Image object for each of the six cube map faces.

Constructor Summary

Constructors

Constructor and Description
SkyBoxOptions()

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.
void	update() Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Methods inherited from class java.lang.Object

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

Field Detail

sources

@JsProperty
public SkyBoxSources sources

The source URL or Image object for each of the six cube map faces. See the example below.

show

public boolean show

Determines if this primitive will be shown. Default: true

Constructor Detail

SkyBoxOptions

@JsConstructor
public SkyBoxOptions()

Method Detail

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

update

@JsMethod
public void update()

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive. Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered: