Skip To Content ArcGIS for Developers Sign In Dashboard

OrbitLocationCameraController QML Type

Provides orbital camera navigation around a stationary or moving point object. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.1
Inherits:

CameraController

Properties

Signals

Methods

  • bool cancelTask(string taskId)
  • string moveCamera(double distanceDelta, double headingDelta, double pitchDelta, real duration)

Detailed Description

Camera controllers can be applied to a SceneView to determine the camera interaction and navigation model.

Setting this type as the CameraController for a SceneView will ensure that the camera is always focused on the targetLocation.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
PointtargetLocation

See also CameraController and Cancelable.

Property Documentation

cameraDistance : double

The distance from the target location to the camera in meters.

This value must be greater than 0.


cameraDistanceInteractive : bool

The interactive heading value indicating whether user interactions affect the camera's diatnec from the target.

When true, the user may zoom towards and away from the targetLocation using mouse/touch interactions with the view.

The default setting is true.


cameraHeadingOffset : double

The heading offset of the camera, in degrees, relative to the target object.

A heading of 0° indicates that the camera is positioned to the South of the target, looking North.


cameraHeadingOffsetInteractive : bool

The interactive heading offset value indicating whether user interactions affect the camera's heading.

When interactive heading is true the user is able to manually change the relative heading between the target focal point and the camera.

The default setting is true.


cameraPitchOffset : double

The pitch offset of the camera, in degrees, relative to the target object.

A pitch of 0° indicates that the camera is oriented along the z-axis, that is looking up towards the target object.


cameraPitchOffsetInteractive : bool

The interactive pitch value indicating whether user interactions affect the camera's pitch.

When interactive pitch offset is true the user is able to manually change the relative pitch between the target focal point and the camera.

The default setting is true.


[default] initialCameraLocation : Point

The camera location of the camera controller.

Sets the initial location of the camera. The distance, heading, and pitch will be calculated based on this point and the targetLocation. The target location must also be set before this is added to the scene.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


maxCameraDistance : double

The maximum distance from the camera to the target in meters.


maxCameraHeadingOffset : double

The maximum camera heading offset in degrees.

This value will be wrapped to a clockwise angle in the range: 0° to 360°.


maxCameraPitchOffset : double

The maximum camera pitch offset in degrees.

This value must be in the range: minCameraPitchOffset to 90°.

The default value is 90°.


minCameraDistance : double

The minimum distance from the camera to the target.


minCameraHeadingOffset : double

The minimum camera heading offset in degrees.

This value can be any value (positive or negative) and will be wrapped to a clockwise angle in the range: 0° to 360°.


minCameraPitchOffset : double

The minimum camera pitch offset in degrees.

This value must lie in the range: -90° to maxCameraPitchOffset. The default value is -90°.


moveCameraStatus : Enums.TaskStatus

Returns the status of the moveCamera task (read-only).

See also Enums.TaskStatus.


[default] targetLocation : Point

The target point location of the camera controller.

The target determines the focal point of the camera mananged by this OrbitLocationCameraController.


Signal Documentation

cameraDistanceChanged()

Emitted when the cameraDistance property changes.


cameraDistanceInteractiveChanged()

Emitted when the cameraDistanceInteractive property changes.


cameraHeadingOffsetChanged()

Emitted when the cameraHeadingOffset property changes.


cameraHeadingOffsetInteractiveChanged()

Emitted when the cameraHeadingOffsetInteractive property changes.


cameraPitchOffsetChanged()

Emitted when the cameraPitchOffset property changes.


cameraPitchOffsetInteractiveChanged()

Emitted when the cameraPitchOffsetInteractive property changes.


initialCameraLocationChanged()

Emitted when the initialCameraLocation property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.3.


maxCameraDistanceChanged()

Emitted when the maxCameraDistance property changes.


maxCameraHeadingOffsetChanged()

Emitted when the maxCameraHeadingOffset property changes.


maxCameraPitchOffsetChanged()

Emitted when the maxCameraPitchOffset property changes.


minCameraDistanceChanged()

Emitted when the minCameraDistance property changes.


minCameraHeadingOffsetChanged()

Emitted when the minCameraHeadingOffset property changes.


minCameraPitchOffsetChanged()

Emitted when the minCameraPitchOffset property changes.


moveCameraStatusChanged()

Emitted when the moveCameraStatus property changes.


targetLocationChanged()

Emitted when the targetLocation property changes.


Method Documentation

bool cancelTask(string taskId)

Cancels a moveCamera task.

  • taskId - The ID of the moveCamera task to be canceled.

See also Cancelable.


string moveCamera(double distanceDelta, double headingDelta, double pitchDelta, real duration)

Animate the camera to the new position relative to the target.

  • distanceDelta - The change in distance (meters) to apply in the animation.
  • headingDelta - The change in heading (degrees) to apply in the animation.
  • pitchDelta - The change in pitch (degrees) to apply in the animation.
  • duration - The duration of the animation in seconds.

The moveCameraStatus property shows the status of this operation.



Feedback on this topic?