ScreenSpaceCameraController

new Cesium.ScreenSpaceCameraController(scene)
Scene/ScreenSpaceCameraController.js 63

Modifies the camera position and orientation based on mouse input to a canvas.
Name Type Description
scene Scene The scene.

Members

bounceAnimationTime : Number
Scene/ScreenSpaceCameraController.js 154

Sets the duration, in seconds, of the bounce back animations in 2D and Columbus view.
Default Value: 3.0

enableCollisionDetection : Boolean
Scene/ScreenSpaceCameraController.js 264

Enables or disables camera collision detection with terrain.
Default Value: true

enableInputs : Boolean
Scene/ScreenSpaceCameraController.js 82

If true, inputs are allowed conditionally with the flags enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook. If false, all inputs are disabled. NOTE: This setting is for temporary use cases, such as camera flights and drag-selection of regions (see Picking demo). It is typically set to false at the start of such events, and set true on completion. To keep inputs disabled past the end of camera flights, you must use the other booleans (enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook).
Default Value: true

enableLook : Boolean
Scene/ScreenSpaceCameraController.js 116

If true, allows the user to use free-look. If false, the camera view direction can only be changed through translating or rotating. This flag only applies in 3D and Columbus view modes.
Default Value: true

enableRotate : Boolean
Scene/ScreenSpaceCameraController.js 102

If true, allows the user to rotate the camera. If false, the camera is locked to the current heading. This flag only applies in 2D and 3D.
Default Value: true

enableTilt : Boolean
Scene/ScreenSpaceCameraController.js 109

If true, allows the user to tilt the camera. If false, the camera is locked to the current heading. This flag only applies in 3D and Columbus view.
Default Value: true

enableTranslate : Boolean
Scene/ScreenSpaceCameraController.js 89

If true, allows the user to pan around the map. If false, the camera stays locked at the current position. This flag only applies in 2D and Columbus view modes.
Default Value: true

enableZoom : Boolean
Scene/ScreenSpaceCameraController.js 95

If true, allows the user to zoom in and out. If false, the camera is locked to the current distance from the ellipsoid.
Default Value: true

inertiaSpin : Number
Scene/ScreenSpaceCameraController.js 124

A parameter in the range [0, 1) used to determine how long the camera will continue to spin because of inertia. With value of zero, the camera will have no inertia.
Default Value: 0.9

inertiaTranslate : Number
Scene/ScreenSpaceCameraController.js 132

A parameter in the range [0, 1) used to determine how long the camera will continue to translate because of inertia. With value of zero, the camera will have no inertia.
Default Value: 0.9

inertiaZoom : Number
Scene/ScreenSpaceCameraController.js 140

A parameter in the range [0, 1) used to determine how long the camera will continue to zoom because of inertia. With value of zero, the camera will have no inertia.
Default Value: 0.8

lookEventTypes : CameraEventType|Array|undefined
Scene/ScreenSpaceCameraController.js 233

The input that allows the user to change the direction the camera is viewing. This only applies in 3D and Columbus view modes.

The type came be a CameraEventType, undefined, an object with eventType and modifier properties with types CameraEventType and KeyboardEventModifier, or an array of any of the preceding.

Default Value: { eventType : CameraEventType.LEFT_DRAG, modifier : KeyboardEventModifier.SHIFT }

maximumMovementRatio : Number
Scene/ScreenSpaceCameraController.js 148

A parameter in the range [0, 1) used to limit the range of various user inputs to a percentage of the window width/height per animation frame. This helps keep the camera under control in low-frame-rate situations.
Default Value: 0.1

maximumZoomDistance : Number
Scene/ScreenSpaceCameraController.js 166

The maximum magnitude, in meters, of the camera position when zooming. Defaults to positive infinity.
Default Value: Number.POSITIVE_INFINITY

minimumCollisionTerrainHeight : Number
Scene/ScreenSpaceCameraController.js 249

The minimum height the camera must be before testing for collision with terrain.
Default Value: 10000.0

minimumPickingTerrainHeight : Number
Scene/ScreenSpaceCameraController.js 242

The minimum height the camera must be before picking the terrain instead of the ellipsoid.
Default Value: 150000.0

minimumTrackBallHeight : Number
Scene/ScreenSpaceCameraController.js 257

The minimum height the camera must be before switching from rotating a track ball to free look when clicks originate on the sky on in space.
Default Value: 7500000.0

minimumZoomDistance : Number
Scene/ScreenSpaceCameraController.js 160

The minimum magnitude, in meters, of the camera position when zooming. Defaults to 1.0.
Default Value: 1.0

rotateEventTypes : CameraEventType|Array|undefined
Scene/ScreenSpaceCameraController.js 199

The input that allows the user to rotate around the globe or another object. This only applies in 3D and Columbus view modes.

The type came be a CameraEventType, undefined, an object with eventType and modifier properties with types CameraEventType and KeyboardEventModifier, or an array of any of the preceding.

Default Value: CameraEventType.LEFT_DRAG

tiltEventTypes : CameraEventType|Array|undefined
Scene/ScreenSpaceCameraController.js 216

The input that allows the user to tilt in 3D and Columbus view or twist in 2D.

The type came be a CameraEventType, undefined, an object with eventType and modifier properties with types CameraEventType and KeyboardEventModifier, or an array of any of the preceding.

Default Value: [CameraEventType.MIDDLE_DRAG, CameraEventType.PINCH, { eventType : CameraEventType.LEFT_DRAG, modifier : KeyboardEventModifier.CTRL }, { eventType : CameraEventType.RIGHT_DRAG, modifier : KeyboardEventModifier.CTRL }]

translateEventTypes : CameraEventType|Array|undefined
Scene/ScreenSpaceCameraController.js 177

The input that allows the user to pan around the map. This only applies in 2D and Columbus view modes.

The type came be a CameraEventType, undefined, an object with eventType and modifier properties with types CameraEventType and KeyboardEventModifier, or an array of any of the preceding.

Default Value: CameraEventType.LEFT_DRAG

zoomEventTypes : CameraEventType|Array|undefined
Scene/ScreenSpaceCameraController.js 188

The input that allows the user to zoom in/out.

The type came be a CameraEventType, undefined, an object with eventType and modifier properties with types CameraEventType and KeyboardEventModifier, or an array of any of the preceding.

Default Value: [CameraEventType.RIGHT_DRAG, CameraEventType.WHEEL, CameraEventType.PINCH]

Methods

destroy() → undefined
Scene/ScreenSpaceCameraController.js 1940

Removes mouse listeners held by this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Returns:
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
controller = controller && controller.destroy();
See:

isDestroyed() → Boolean
Scene/ScreenSpaceCameraController.js 1919

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See: