Provides orbital camera navigation around a stationary or moving point object. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- cameraDistance : double
- cameraDistanceInteractive : bool
- cameraHeadingOffset : double
- cameraHeadingOffsetInteractive : bool
- cameraPitchOffset : double
- cameraPitchOffsetInteractive : bool
- initialCameraLocation : Point
- maxCameraDistance : double
- maxCameraHeadingOffset : double
- maxCameraPitchOffset : double
- minCameraDistance : double
- minCameraHeadingOffset : double
- minCameraPitchOffset : double
- moveCameraStatus : Enums.TaskStatus
- targetLocation : Point
Signals
- cameraDistanceChanged()
- cameraDistanceInteractiveChanged()
- cameraHeadingOffsetChanged()
- cameraHeadingOffsetInteractiveChanged()
- cameraPitchOffsetChanged()
- cameraPitchOffsetInteractiveChanged()
- initialCameraLocationChanged()
- maxCameraDistanceChanged()
- maxCameraHeadingOffsetChanged()
- maxCameraPitchOffsetChanged()
- minCameraDistanceChanged()
- minCameraHeadingOffsetChanged()
- minCameraPitchOffsetChanged()
- moveCameraStatusChanged()
- targetLocationChanged()
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.
| Type | Default Property |
|---|---|
| Point | targetLocation |
See also CameraController and Cancelable.
Property Documentation
The distance from the target location to the camera in meters.
This value must be greater than 0.
The interactive heading value indicating whether user interactions affect the camera's distance 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.
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.
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.
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.
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.
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 property was introduced in Esri.ArcGISRuntime 100.3.
The maximum distance from the camera to the target in meters.
There is no limit on this maximum distance. Animations and interactions are bounded by this limit.
The maximum camera heading offset in degrees.
This value will be wrapped to a clockwise angle in the range: 0° to 360°.
The maximum camera pitch offset in degrees.
This value must be in the range: minCameraPitchOffset to 90°.
The default value is 90°.
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°.
The minimum camera pitch offset in degrees.
This value must lie in the range: -90° to maxCameraPitchOffset. The default value is -90°.
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 managed by this OrbitLocationCameraController.
Signal Documentation
Emitted when the cameraDistance property changes.
Note: The corresponding handler is onCameraDistanceChanged.
Emitted when the cameraDistanceInteractive property changes.
Note: The corresponding handler is onCameraDistanceInteractiveChanged.
Emitted when the cameraHeadingOffset property changes.
Note: The corresponding handler is onCameraHeadingOffsetChanged.
Emitted when the cameraHeadingOffsetInteractive property changes.
Note: The corresponding handler is onCameraHeadingOffsetInteractiveChanged.
Emitted when the cameraPitchOffset property changes.
Note: The corresponding handler is onCameraPitchOffsetChanged.
Emitted when the cameraPitchOffsetInteractive property changes.
Note: The corresponding handler is onCameraPitchOffsetInteractiveChanged.
Emitted when the initialCameraLocation property changes.
Note: The corresponding handler is onInitialCameraLocationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the maxCameraDistance property changes.
Note: The corresponding handler is onMaxCameraDistanceChanged.
Emitted when the maxCameraHeadingOffset property changes.
Note: The corresponding handler is onMaxCameraHeadingOffsetChanged.
Emitted when the maxCameraPitchOffset property changes.
Note: The corresponding handler is onMaxCameraPitchOffsetChanged.
Emitted when the minCameraDistance property changes.
Note: The corresponding handler is onMinCameraDistanceChanged.
Emitted when the minCameraHeadingOffset property changes.
Note: The corresponding handler is onMinCameraHeadingOffsetChanged.
Emitted when the minCameraPitchOffset property changes.
Note: The corresponding handler is onMinCameraPitchOffsetChanged.
Emitted when the moveCameraStatus property changes.
Note: The corresponding handler is onMoveCameraStatusChanged.
Emitted when the targetLocation property changes.
Note: The corresponding handler is onTargetLocationChanged.
Method Documentation
Cancels a moveCamera task.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
- taskId - The ID of the moveCamera task to be canceled.
See also Cancelable.
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.