A camera controller manages the position, orientation, and movement of a Camera in a SceneView. More...
Header: | #include <CameraController.h> |
Since: | Esri::ArcGISRuntime 100.1 |
Inherits: | Esri::ArcGISRuntime::Object |
Inherited By: | Esri::ArcGISRuntime::GlobeCameraController, Esri::ArcGISRuntime::OrbitGeoElementCameraController, Esri::ArcGISRuntime::OrbitLocationCameraController, and Esri::ArcGISRuntime::TransformationMatrixCameraController |
Public Functions
virtual | ~CameraController() override |
Esri::ArcGISRuntime::CameraControllerType | cameraControllerType() const |
Detailed Description
This is a base class for a number of camera controllers. Each type of camera controller is designed to provide a specific user experience for interacting with the scene display. The camera controller and its properties can be changed at run time, so you can provide the scene interaction experience best suited for the current context. The following are examples of camera controllers:
- GlobeCameraController (default) — Provides the default scene view camera behavior. Allows the user to freely move and focus the camera anywhere in the scene.
- OrbitGeoElementCameraController — Locks the scene view's camera to maintain focus on a (possibly moving) OrbitGeoElementCameraController::targetGeoElement. The user can navigate around and zoom in/out on the specific OrbitGeoElementCameraController::targetGeoElement object.
- OrbitLocationCameraController — Locks the scene view's camera to orbit a fixed point location. The camera can only move relative to this point location.
When a camera controller other than GlobeCameraController is active, the scene view's viewpoint cannot be assigned. Attempts to do so are ignored.
Relevant samples:
- Choose camera controller: Control the behavior of the camera in a scene.
- Viewshed (GeoElement): Analyze the viewshed for an object (GeoElement) in a scene.
Member Function Documentation
[override virtual]
CameraController::~CameraController ()
Destructor
Esri::ArcGISRuntime::CameraControllerType CameraController::cameraControllerType () const
Returns the type of camera_controller.
The camera_controller type for a specific camera_controller. Will return -1 if an error occurs.
See also CameraControllerType.