ScreenSpaceCameraController

external class ScreenSpaceCameraController(scene: Scene)(source)

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

Parameters

scene

The scene.

See also

Constructors

Link copied to clipboard
constructor(scene: Scene)

Properties

Link copied to clipboard

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

Link copied to clipboard

When disabled, the values of maximumZoomDistance and minimumZoomDistance are ignored.

Link copied to clipboard

If true, inputs are allowed conditionally with the flags enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook. If false, all inputs are disabled.

Link copied to clipboard

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.

Link copied to clipboard

If true, allows the user to rotate the world which translates the user's position. This flag only applies in 2D and 3D.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The angle, relative to the ellipsoid normal, restricting the maximum amount that the user can tilt the camera. If undefined, the angle of the camera tilt is unrestricted.

Link copied to clipboard

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

Link copied to clipboard

The minimum height the camera must be before testing for collision with terrain. Default to scene.ellipsoid.minimumRadius * 0.0025 when another ellipsoid than WGS84 is used.

Link copied to clipboard

The minimum distance the camera must be before testing for collision with terrain when zoom with inertia. Default to scene.ellipsoid.minimumRadius * 0.00063 when another ellipsoid than WGS84 is used.

Link copied to clipboard

The minimum height the camera must be before picking the terrain or scene content instead of the ellipsoid. Defaults to scene.ellipsoid.minimumRadius * 0.025 when another ellipsoid than WGS84 is used.

Link copied to clipboard

The minimum height the camera must be before switching from rotating a track ball to free look when clicks originate on the sky or in space. Defaults to ellipsoid.minimumRadius * 1.175 when another ellipsoid than WGS84 is used.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A multiplier for the speed at which the camera will zoom.

Functions

Link copied to clipboard
fun destroy()

Removes mouse listeners held by this object.

Link copied to clipboard

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