Scene - Cesium Documentation

Scene

new Scene

The container for all 3D graphical objects and state in a Cesium virtual scene. Generally, a scene is not created directly; instead, it is implicitly created by CesiumWidget.

Parameters:

Name	Type	Argument	Default	Description
`canvas`	HTMLCanvasElement			The HTML canvas element to create the scene for.
`contextOptions`	Object	<optional>	undefined	Properties corresponding to WebGLContextAttributes used to create the WebGL context. Default values are shown in the code example below.
`creditContainer`	HTMLElement	<optional>	undefined	The HTML element in which the credits will be displayed.

Example

// Create scene with default context options.
var scene = new Scene(canvas, {
    alpha : false,
    depth : true,
    stencil : false,
    antialias : true,
    premultipliedAlpha : true,
    preserveDrawingBuffer : false
});

See:

Source:

/Source/Scene/Scene.js

Members

backgroundColor :Color

The background color, which is only visible if there is no sky box, i.e., Scene#skyBox is undefined.

Default Value:

Color.BLACK

See:

Scene#skyBox

debugCommandFilter :Function

This property is for debugging only; it is not for production use.

A function that determines what commands are executed. As shown in the examples below, the function receives the command's owner as an argument, and returns a boolean indicating if the command should be executed.

The default is undefined, indicating that all commands are executed.

Example

// Do not execute any commands.
scene.debugCommandFilter = function(command) {
    return false;
};

// Execute only the billboard's commands.  That is, only draw the billboard.
var billboards = new BillboardCollection();
scene.debugCommandFilter = function(command) {
    return command.owner === billboards;
};

Default Value: