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 is only supported in 3D mode.
• DeveloperError : clampToHeight requires depth texture support. Check 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 is only supported in 3D mode.
• DeveloperError : clampToHeightMostDetailed requires depth texture support. Check 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 : This object was destroyed, i.e., destroy() was called.

Example:

scene = scene && scene.destroy();

See:

• Scene#isDestroyed

Returns:

Throws:

• DeveloperError : windowPosition is 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 : Picking from the depth buffer is not supported. Check 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 is only supported in 3D mode.
• DeveloperError : sampleHeight requires depth texture support. Check 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 is only supported in 3D mode.
• DeveloperError : sampleHeightMostDetailed requires depth texture support. Check 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}`);
});