A scene view for displaying ARKit/ARCore features on mobile devices using the C++ API. More...
| Header: | #include <ArcGISArView> |
| Since: | Esri::ArcGISRuntime 100.6 |
| Inherits: | Esri::ArcGISRuntime::Toolkit::ArcGISArViewInterface |
- List of all members, including inherited members
- ArcGISArView is part of Augmented Reality integration tools.
Properties
- originCamera : Camera
- sceneView : SceneQuickView*
Public Functions
| ArcGISArView(QQuickItem *parent = nullptr) | |
| virtual | ~ArcGISArView() override |
| double | clippingDistance() const |
| Esri::ArcGISRuntime::Camera | originCamera() const |
| Esri::ArcGISRuntime::SceneQuickView * | sceneView() const |
| Esri::ArcGISRuntime::Point | screenToLocation(const QPoint &screenPoint) const |
| void | setClippingDistance(double clippingDistance) |
| void | setInitialTransformation(const QPoint &screenPoint) |
| void | setOriginCamera(const Esri::ArcGISRuntime::Camera &originCamera) |
| void | setSceneView(Esri::ArcGISRuntime::SceneQuickView *sceneView) |
Signals
| void | clippingDistanceChanged() |
| void | originCameraChanged() |
| void | sceneViewChanged() |
Static Public Members
| void | qmlRegisterTypes() |
Detailed Description
The Augmented Reality (AR) toolkit provides support for ARKit for iOS and ArCore for Android. This toolkit component allows quick and easy integration of AR into your application for a variety of scenarios.
See additional details about using the ArcGISArView toolkit component.
Property Documentation
originCamera : Camera
Sets the origin camera of this ArcGISArView.
Access functions:
| Esri::ArcGISRuntime::Camera | originCamera() const |
| void | setOriginCamera(const Esri::ArcGISRuntime::Camera &originCamera) |
Notifier signal:
| void | originCameraChanged() |
sceneView : SceneQuickView *
Gets the SceneView associated with this ArcGISArView.
Access functions:
| Esri::ArcGISRuntime::SceneQuickView * | sceneView() const |
| void | setSceneView(Esri::ArcGISRuntime::SceneQuickView *sceneView) |
Notifier signal:
| void | sceneViewChanged() |
Member Function Documentation
[explicit] ArcGISArView::ArcGISArView (QQuickItem *parent = nullptr)
A constructor that accepts an optional parent object.
[override virtual] ArcGISArView::~ArcGISArView ()
The destructor.
[since Esri::ArcGISRuntime 100.8] double ArcGISArView::clippingDistance () const
Gets the clipping distance in meters around the originCamera.
The default value is 0.0.
Note: Getter function for property clippingDistance.
This function was introduced in Esri::ArcGISRuntime 100.8.
See also setClippingDistance().
Esri::ArcGISRuntime::Camera ArcGISArView::originCamera () const
Gets the origin camera.
Note: Getter function for property originCamera.
See also setOriginCamera().
[signal] void ArcGISArView::originCameraChanged ()
Signal emitted when the originCamera property changes.
Note: Notifier signal for property originCamera.
[static] void ArcGISArView::qmlRegisterTypes ()
Register the QML-creatable types provided by the AR toolkit.
This static function registers the QML types ArcGISArView and LocationDataSource in the QML engine. This function must be called before using the QML types.
[signal] void ArcGISArView::sceneViewChanged ()
Signal emitted when the sceneView property changes.
Note: Notifier signal for property sceneView.
[invokable] Esri::ArcGISRuntime::Point ArcGISArView::screenToLocation (const QPoint &screenPoint ) const
Gets the location in the real world space corresponding to the screen point screenPoint.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[since Esri::ArcGISRuntime 100.8] void ArcGISArView::setClippingDistance (double clippingDistance )
Sets the clipping distance to clippingDistance in meters around the originCamera.
The default value is 0.0.
When the value is set to 0.0, there is no enforced clipping distance and therefore no limiting of displayed data. Setting the value to 10.0 will only render data 10 meters around the originCamera.
Note: Setter function for property clippingDistance.
This function was introduced in Esri::ArcGISRuntime 100.8.
See also clippingDistance().
[invokable] void ArcGISArView::setInitialTransformation (const QPoint &screenPoint )
Sets the initial transformation used to offset the originCamera.
The initial transformation is based on an AR point determined via existing plane hit detection from `screenPoint`. If an AR point cannot be determined, this method will return false.
- screenPoint - The screen point to determine the initialTransformation from.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
void ArcGISArView::setSceneView (Esri::ArcGISRuntime::SceneQuickView *sceneView )
Sets the scene view to sceneView.
The space effect of the scene view is set to SpaceEffect::Transparent and the atmosphere effect is set to AtmosphereEffect::None.
Note: Setter function for property sceneView.
See also sceneView().