kotlin-cesium-engine/cesium.engine/SkyBox

SkyBox

external class SkyBox(options: SkyBox.ConstructorOptions)(source)

A sky box around the scene to draw stars. The sky box is defined using the True Equator Mean Equinox (TEME) axes.

This is only supported in 3D. The sky box is faded out when morphing to 2D or Columbus view. The size of the sky box must not exceed Scene.maximumCubeMapSize.

scene.skyBox = new SkyBox({
  sources : {
    positiveX : 'skybox_px.png',
    negativeX : 'skybox_nx.png',
    positiveY : 'skybox_py.png',
    negativeY : 'skybox_ny.png',
    positiveZ : 'skybox_pz.png',
    negativeZ : 'skybox_nz.png'
  }
});
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor(options: SkyBox.ConstructorOptions)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
interface ConstructorOptions

Properties

Link copied to clipboard
var show: Boolean

Determines if the sky box will be shown.

Link copied to clipboard
var sources: Any

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.

Functions

Link copied to clipboard
fun 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.

Link copied to clipboard
fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false.

Link copied to clipboard
fun update()

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.