org.cesiumjs.cs.core

Class SkyBox

java.lang.Object

org.cesiumjs.cs.core.SkyBox

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	show Determines if the sky box will be shown.
SkyBoxSources	sources The sources used to create the cube map faces: an object with positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties.

Constructor Summary

Constructors

Constructor and Description
SkyBox()
SkyBox(SkyBoxOptions options)

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

show

public boolean show

Determines if the sky box will be shown. Default: true

sources

public SkyBoxSources sources

The sources used to create the cube map faces: an object with positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties. These can be either URLs or Image objects. Default: undefined

Constructor Detail

SkyBox

@JsConstructor
public SkyBox()

SkyBox

@JsConstructor
public SkyBox(SkyBoxOptions options)

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: