Scene

Members

Default Value: false

Default Value: Color.BLACK

See:

• Scene#skyBox

Default Value: false

See:

• Scene#clampToHeight
• Scene#clampToHeightMostDetailed

Default Value: true

Default Value: undefined

Example:

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

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

Default Value: undefined

Default Value: false

Default Value: 1

Default Value: false

Default Value: false

Default Value: false

See:

• drawingBufferHeight

See:

• drawingBufferWidth

Default Value: 1000.0

Default Value: 2.2

Default Value: false

Default Value: true

Default Value: false

Default Value: Color.WHITE

See:

• Scene#invertClassification

Default Value: 1e9

Default Value: new GeographicProjection()

See:

• glGet with ALIASED_LINE_WIDTH_RANGE.

See:

• glGet with GL_MAX_CUBE_MAP_TEXTURE_SIZE.

Default Value: 0.0

See:

• Improving Performance with Explicit Rendering
• Scene#requestRenderMode

Default Value: 0.0

Default Value: SceneMode.SCENE3D

Default Value: undefined

Default Value: Event()

Default Value: Event()

Default Value: 1.0

Default Value: 4

Default Value: 1.75e6

See:

• Scene#pickPosition

Default Value: false

Example:

// picking the position of a translucent primitive
viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
     const pickedFeature = viewer.scene.pick(movement.position);
     if (!Cesium.defined(pickedFeature)) {
         // nothing picked
         return;
     }
     const worldPosition = viewer.scene.pickPosition(movement.position);
}, Cesium.ScreenSpaceEventType.LEFT_CLICK);

See:

• Improving Performance with Explicit Rendering
• Scene#preUpdate
• Scene#postUpdate
• Scene#postRender

See:

• Improving Performance with Explicit Rendering
• Scene#preUpdate
• Scene#preRender
• Scene#postRender

See:

• Improving Performance with Explicit Rendering
• Scene#preUpdate
• Scene#postUpdate
• Scene#postRender

See:

• Improving Performance with Explicit Rendering
• Scene#postUpdate
• Scene#preRender
• Scene#postRender

Default Value: false

See:

• Improving Performance with Explicit Rendering
• Scene#maximumRenderTimeChange
• Scene#requestRender

Default Value: false

See:

• Scene#sampleHeight
• Scene#sampleHeightMostDetailed

Default Value: undefined

Default Value: undefined

See:

• Scene#backgroundColor

See:

• Scene#specularEnvironmentMaps

Default Value: undefined

Default Value: true

Default Value: true

Default Value: false

Default Value: 1.0

Default Value: 0.0

Methods

Returns:

Example:

// Output the canvas position of longitude/latitude (0, 0) every time the mouse moves.
const scene = widget.scene;
const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
handler.setInputAction(function(movement) {
    console.log(scene.cartesianToCanvasCoordinates(position));
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);

Returns:

Throws:

• DeveloperError ：clampToHeight 仅在 3D 模式下受支持。
• DeveloperError ：clampToHeight 需要深度纹理支持。请检查 clampToHeightSupported。

Example:

// Clamp an entity to the underlying scene geometry
const position = entity.position.getValue(Cesium.JulianDate.now());
entity.position = viewer.scene.clampToHeight(position);

See:

• Scene#sampleHeight
• Scene#sampleHeightMostDetailed
• Scene#clampToHeightMostDetailed

Returns:

Throws:

• DeveloperError ：clampToHeightMostDetailed 仅在 3D 模式下受支持。
• DeveloperError ：clampToHeightMostDetailed 需要深度纹理支持。请检查 clampToHeightSupported。

Example:

const cartesians = [
    entities[0].position.getValue(Cesium.JulianDate.now()),
    entities[1].position.getValue(Cesium.JulianDate.now())
];
const promise = viewer.scene.clampToHeightMostDetailed(cartesians);
promise.then(function(updatedCartesians) {
    entities[0].position = updatedCartesians[0];
    entities[1].position = updatedCartesians[1];
}

See:

• Scene#clampToHeight

Throws:

• DeveloperError ：该对象已被销毁，即已调用 destroy()。

Example:

scene = scene && scene.destroy();

See:

• Scene#isDestroyed

Returns:

Throws:

• DeveloperError ：windowPosition 为 undefined。

Example:

const pickedObjects = scene.drillPick(new Cesium.Cartesian2(100.0, 200.0));

See:

• Scene#pick

Returns:

Returns:

See:

• Scene#destroy

Returns:

Example:

// On mouse over, color the feature yellow.
handler.setInputAction(function(movement) {
    const feature = scene.pick(movement.endPosition);
    if (feature instanceof Cesium.Cesium3DTileFeature) {
        feature.color = Cesium.Color.YELLOW;
    }
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);

Returns:

Example:

// On mouse over, color the feature yellow.
handler.setInputAction(function(movement) {
    const feature = scene.pickAsync(movement.endPosition).then(function(feature) {
       if (feature instanceof Cesium.Cesium3DTileFeature) {
           feature.color = Cesium.Color.YELLOW;
       }
    });
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);

See:

• Scene#pick

Returns:

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

Returns:

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

Returns:

Throws:

• DeveloperError ：不支持从深度缓冲区拾取。请检查 pickPositionSupported。

Returns:

Example:

On left click, report the value of the "color" property at that voxel sample.
handler.setInputAction(function(movement) {
  const voxelCell = scene.pickVoxel(movement.position);
  if (defined(voxelCell)) {
    console.log(voxelCell.getProperty("color"));
  }
}, Cesium.ScreenSpaceEventType.LEFT_CLICK);

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

See:

• Scene#requestRenderMode

Returns:

Throws:

• DeveloperError ：sampleHeight 仅在 3D 模式下受支持。
• DeveloperError ：sampleHeight 需要深度纹理支持。请检查 sampleHeightSupported。

Example:

const position = new Cesium.Cartographic(-1.31968, 0.698874);
const height = viewer.scene.sampleHeight(position);
console.log(height);

See:

• Scene#clampToHeight
• Scene#clampToHeightMostDetailed
• Scene#sampleHeightMostDetailed

Returns:

Throws:

• DeveloperError ：sampleHeightMostDetailed 仅在 3D 模式下受支持。
• DeveloperError ：sampleHeightMostDetailed 需要深度纹理支持。请检查 sampleHeightSupported。

Example:

const positions = [
    new Cesium.Cartographic(-1.31968, 0.69887),
    new Cesium.Cartographic(-1.10489, 0.83923)
];
const promise = viewer.scene.sampleHeightMostDetailed(positions);
promise.then(function(updatedPosition) {
    // positions[0].height and positions[1].height have been updated.
    // updatedPositions is just a reference to positions.
}

See:

• Scene#sampleHeight

Returns:

Examples:

// Use Cesium World Terrain
scene.setTerrain(Cesium.Terrain.fromWorldTerrain());

// Use a custom terrain provider
const terrain = new Cesium.Terrain(Cesium.CesiumTerrainProvider.fromUrl("https://myTestTerrain.com"));
scene.setTerrain(terrain);

terrain.errorEvent.addEventListener(error => {
  alert(`Encountered an error while creating terrain! ${error}`);
});