org.cesiumjs.cs.scene

Class ScreenSpaceCameraController

java.lang.Object

org.cesiumjs.cs.scene.ScreenSpaceCameraController

@JsType(isNative=true,
        namespace="Cesium",
        name="ScreenSpaceCameraController")
public class ScreenSpaceCameraController
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	bounceAnimationTime Sets the duration, in seconds, of the bounce back animations in 2D and Columbus view.
Boolean	enableCollisionDetection Enables or disables camera collision detection with terrain.
Boolean	enableInputs If true, inputs are allowed conditionally with the flags enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook.
Boolean	enableLook If true, allows the user to use free-look.
Boolean	enableRotate If true, allows the user to rotate the camera.
Boolean	enableTilt If true, allows the user to tilt the camera.
Boolean	enableTranslate If true, allows the user to pan around the map.
Boolean	enableZoom If true, allows the user to zoom in and out.
Number	inertiaSpin A parameter in the range [0, 1) used to determine how long the camera will continue to spin because of inertia.
Number	inertiaTranslate A parameter in the range [0, 1) used to determine how long the camera will continue to translate because of inertia.
Number	inertiaZoom A parameter in the range [0, 1) used to determine how long the camera will continue to zoom because of inertia.
CameraEventType[]	lookEventTypes The input that allows the user to change the direction the camera is viewing.
Number	maximumMovementRatio 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.
Number	maximumZoomDistance The maximum magnitude, in meters, of the camera position when zooming.
Number	minimumCollisionTerrainHeight The minimum height the camera must be before testing for collision with terrain.
Number	minimumPickingTerrainHeight The minimum height the camera must be before picking the terrain instead of the ellipsoid.
Number	minimumTrackBallHeight 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.
Number	minimumZoomDistance The minimum magnitude, in meters, of the camera position when zooming.
CameraEventType[]	rotateEventTypes The input that allows the user to rotate around the globe or another object.
CameraEventType[]	tiltEventTypes The input that allows the user to tilt in 3D and Columbus view or twist in 2D.
CameraEventType[]	translateEventTypes The input that allows the user to pan around the map.
CameraEventType[]	zoomEventTypes The input that allows the user to zoom in/out.

Constructor Summary

Constructors

Constructor and Description
ScreenSpaceCameraController(Scene scene) Modifies the camera position and orientation based on mouse input to a canvas.

Method Summary

Modifier and Type	Method and Description
void	destroy() Removes mouse listeners held by this object.
Boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bounceAnimationTime

@JsProperty
public Number bounceAnimationTime

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

enableCollisionDetection

@JsProperty
public Boolean enableCollisionDetection

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

enableInputs

@JsProperty
public Boolean enableInputs

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: true

enableLook

@JsProperty
public Boolean enableLook

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: true

enableRotate

@JsProperty
public Boolean enableRotate

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: true

enableTilt

@JsProperty
public Boolean enableTilt

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: true

enableTranslate

@JsProperty
public Boolean enableTranslate

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: true

enableZoom

@JsProperty
public Boolean enableZoom

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

inertiaSpin

@JsProperty
public Number inertiaSpin

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: 0.9

inertiaTranslate

@JsProperty
public Number inertiaTranslate

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: 0.9

inertiaZoom

@JsProperty
public Number inertiaZoom

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: 0.8

lookEventTypes

@JsProperty
public CameraEventType[] lookEventTypes

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: { eventType : CameraEventType.LEFT_DRAG, modifier : KeyboardEventModifier.SHIFT }

maximumMovementRatio

@JsProperty
public Number maximumMovementRatio

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: 0.1

maximumZoomDistance

@JsProperty
public Number maximumZoomDistance

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

minimumCollisionTerrainHeight

@JsProperty
public Number minimumCollisionTerrainHeight

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

minimumPickingTerrainHeight

@JsProperty
public Number minimumPickingTerrainHeight

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

minimumTrackBallHeight

@JsProperty
public Number minimumTrackBallHeight

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: 7500000.0

minimumZoomDistance

@JsProperty
public Number minimumZoomDistance

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

rotateEventTypes

@JsProperty
public CameraEventType[] rotateEventTypes

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: CameraEventType.LEFT_DRAG()

tiltEventTypes

@JsProperty
public CameraEventType[] tiltEventTypes

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: [CameraEventType.MIDDLE_DRAG, CameraEventType.PINCH, { eventType : CameraEventType.LEFT_DRAG, modifier : KeyboardEventModifier.CTRL }, { eventType : CameraEventType.RIGHT_DRAG, modifier : KeyboardEventModifier.CTRL }]

translateEventTypes

@JsProperty
public CameraEventType[] translateEventTypes

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: CameraEventType.LEFT_DRAG

zoomEventTypes

@JsProperty
public CameraEventType[] zoomEventTypes

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: [CameraEventType.RIGHT_DRAG, CameraEventType.WHEEL, CameraEventType.PINCH]

Constructor Detail

ScreenSpaceCameraController

@JsConstructor
public ScreenSpaceCameraController(Scene scene)

Modifies the camera position and orientation based on mouse input to a canvas.

Parameters:

scene - The scene.

Method Detail

destroy

public void destroy()

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.

See Also:

isDestroyed()

isDestroyed

public Boolean isDestroyed()

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 Also:

destroy()