ScreenSpaceTiltOrbitCameraController
ScreenSpaceTiltOrbitCameraController tilts and orbits the camera around a pivot, which
suits inspecting an asset from every side. It is one of the alternative camera controllers
added in Cesium 1.144, built on the composable Controller framework.
By default the pivot is the position at the center of the screen; set
useDragPosition to orbit around the position under the pointer when the drag starts.
Cesium’s built-in camera controller keeps handling input unless it is turned off, so
mount ScreenSpaceCameraController with
enableInputs={false} and enableCollisionDetection={false} alongside this component.
- Cesium element: ScreenSpaceTiltOrbitCameraController
- Example: ScreenSpaceTiltOrbitCameraController
Availability
Section titled “Availability”Inside Viewer or CesiumWidget components.
The controller is registered with the scene’s ControllerHost.
Properties
Section titled “Properties”Cesium properties
Section titled “Cesium properties”| Property | Type | Description |
|---|---|---|
| enabled | boolean | |
| maximumMovementRatio | number | |
| pickWorldPosition | (…params: any[]) => any | |
| dampingEnabled | boolean | |
| maximumOrbitVelocity | number | |
| maximumTiltVelocity | number | |
| orbitAnimationDuration | number | |
| orbitEnabled | boolean | |
| orbitMagnitude | number | |
| tiltAnimationDuration | number | |
| tiltEnabled | boolean | |
| tiltMagnitude | number | |
| useDragPosition | boolean |
Cesium read-only properties
Section titled “Cesium read-only properties”| Property | Type | Description |
|---|---|---|
| dragInputs | InputBinding[] | undefined | Mouse button and optional keyboard modifier combinations that start a tilt or orbit. Bindings are attached once when the controller is registered, so changing this prop re-creates the controller rather than mutating it in place. |
Cesium events
Section titled “Cesium events”N/A
Other properties
Section titled “Other properties”| Property | Type | Description |
|---|---|---|
| priority | number | undefined | Precedence relative to other registered controllers. 0 applies before every other controller; omitting it makes this controller the highest priority. Changing this prop re-registers the controller. |