HybridScreenSpacePanCameraController

A contextual camera controller that combines screenspace map panning and screenspace elevator panning. The controller automatically switches between the two based on the camera's angle relative to nadir. If the camera is looking mostly down (within angleThreshold of nadir), ScreenSpaceMapCameraController is used. If the camera is looking towards the horizon (beyond angleThreshold from nadir), the ScreenSpaceElevatorCameraController is used.

new Cesium.HybridScreenSpacePanCameraController()
engine/Source/Scene/Controllers/HybridScreenSpacePanCameraController.js 17

Example:
viewer.scene.screenSpaceCameraController.enableInputs = false;
viewer.scene.screenSpaceCameraController.enableCollisionDetection = false;

const hybridController = new HybridScreenSpacePanCameraController();
viewer.addController(hybridController);

Members

angleThreshold : number
engine/Source/Scene/Controllers/HybridScreenSpacePanCameraController.js 30

The angle threshold in radians that determines which controller is used. If the camera is looking within this angle of nadir, the map controller is used. Otherwise, the elevator controller is used.
Default Value: CesiumMath.toRadians(125)

readonly elevatorController : ScreenSpaceElevatorCameraController
engine/Source/Scene/Controllers/HybridScreenSpacePanCameraController.js 46

The controller that is used when the camera is looking more horizontally (beyond angleThreshold from nadir).

enabled : boolean
engine/Source/Scene/Controllers/Controller.js 19

Determines if the controller is enabled and should be updated by the host scene.

readonly mapController : ScreenSpaceMapCameraController
engine/Source/Scene/Controllers/HybridScreenSpacePanCameraController.js 55

The controller that is used when the camera is looking mostly down (within angleThreshold of nadir).

Methods

connectedCallback(element)
engine/Source/Scene/Controllers/Controller.js 30

Invoked when the controller is added to the DOM. Implement connectedCallback to set up any DOM event listeners.
Name Type Description
element HTMLElement The DOM element containing the Cesium scene.

disconnectedCallback(element)
engine/Source/Scene/Controllers/Controller.js 38

Invoked when the controller is removed from the DOM. Implement disconnectedCallback to tear down any DOM event listeners.
Name Type Description
element HTMLElement The DOM element containing the Cesium scene.

firstUpdate(scene, time)
engine/Source/Scene/Controllers/Controller.js 58

Invoked when the controller is being updated the first time, immediately before update is called. Implement firstUpdate to perform one-time work after the relevant scene has begun its render loop. Some examples might include initializing simulation time values or adding a primitive to the scene.
Name Type Description
scene Scene
time JulianDate The current simulation time.
See:

update(scene, time)
engine/Source/Scene/Controllers/Controller.js 48

Invoked once per frame. Implement update to modify the camera or other parts of the scene.
Name Type Description
scene Scene
time JulianDate The current simulation time.
See:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets