A 3D scene implemented as a QQuickItem component. More...
| Header | #include <Local |
| Since | Esri |
| Inherits | Esri |
Properties
- attributionRect : const QRectF
- attributionTop : const QVariant
Public Functions
| Local | |
| Local | |
| virtual | ~ |
| QVariant | attribution |
Signals
| void | attribution |
| void | attribution |
| void | attribution |
| void | critical |
| void | draw |
| void | error |
(since Esri void | geo |
| void | hover |
| void | hover |
| void | hover |
| void | key |
| void | key |
| void | layer |
| void | mouse |
| void | mouse |
| void | mouse |
| void | mouse |
| void | mouse |
| void | mouse |
| void | mouse |
| void | navigating |
| void | rect |
| void | scene |
| void | spatial |
| void | touched(QTouch |
| void | viewpoint |
| void | warnings |
Detailed Description
A LocalSceneQuickView renders data in a 3D local scene and allows users to interact with the scene. In an MVC architecture, a SceneQuickView represents the view and a scene represents the model.
A SceneQuickView implements a scene view as a QQuickItem component. This allows it to be used in a user interface coded in QML while being controlled by C++ code.
See also Scene, LocalSceneView, and GeoView.
Property Documentation
[read-only] attributionRect : const QRectF
This property holds the bounding rectangle of the attribution text (read-only).
This bounding rectangle can be used when calculating where items can be displayed on the screen so they are not overlapping the attribution text.
Notifier signal:
| void | attribution |
[read-only] attributionTop : const QVariant
This property holds the top anchor line of the attribution bounding rectangle as an AnchorLine variant (read-only).
Other QtQuick items can be anchored to this property so that they display above the attribution text.
Access functions:
| QVariant | attribution |
Notifier signal:
| void | attribution |
Member Function Documentation
[explicit] LocalSceneQuickView::LocalSceneQuickView (QQuickItem *parent = nullptr)
Default constructor that takes an optional parent.
[explicit] LocalSceneQuickView::LocalSceneQuickView (Esri::ArcGISRuntime::Scene *scene, QQuickItem *parent = nullptr)
Constructor that takes a scene and an optional parent.
[override virtual noexcept] LocalSceneQuickView::~LocalSceneQuickView ()
Destructor.
[signal] void LocalSceneQuickView::attributionRectChanged ()
Emitted when the attribution bounding rectangle changes.
Note: Notifier signal for property attributionRect.
[signal] void LocalSceneQuickView::attributionTextChanged ()
Emitted when the attribution text changes.
QVariant LocalSceneQuickView::attributionTop () const
Gets the top anchor line of the attribution bounding rectangle as an AnchorLine variant.
Other QtQuick items can be anchored to this property so that they display above the attribution text.
Note: Getter function for property attributionTop.
[signal] void LocalSceneQuickView::attributionTopChanged ()
Emitted when the attributionTop anchor line changes.
Note: Notifier signal for property attributionTop.
[signal] void LocalSceneQuickView::criticalErrorChanged (const Esri::ArcGISRuntime::Error &criticalError )
Signal emitted when a critical error has occurred on the view.
A critical error means that the view has reached an unusable state from which it cannot recover. This signal is only emitted once.
Examples of a critical error include:
- The graphics driver doesn't meet the minimum requirements.
- A critical rendering exception is thrown.
- criticalError - The critical error on the view.
[signal] void LocalSceneQuickView::drawStatusChanged (Esri::ArcGISRuntime::DrawStatus status)
Signal emitted when the DrawStatus changes.
- status - The new DrawStatus.
[signal] void LocalSceneQuickView::errorOccurred (const Esri::ArcGISRuntime::Error &error)
Signal emitted when an error occurs.
- error - Details about the error.
[signal, since Esri::ArcGISRuntime 300.0] void LocalSceneQuickView::geoModelErrorChanged (const Esri::ArcGISRuntime::Error &error)
Signal emitted when the geo model error changes.
This error is used to indicate that the geo model assigned to the view had an issue loading or didn't meet the requirements after loading, resulting in nothing rendering on screen.
This signal can be emitted multiple times but only one error can be active at a time. It will be emitted when there is an error and when that error gets cleared. When the error is cleared, then the error is represented as empty.
Examples of a possible error include:
- Geo model has a Loadable::loadError.
- Incompatible Scene::viewingMode.
- Geo model has an incompatible spatial reference.
- Geo model has incompatible vertical and horizontal datums.
- error - The geo model error associated with the view.
This function was introduced in Esri::ArcGISRuntime 300.0.
[signal] void LocalSceneQuickView::hoverEntered (QHoverEvent &hoverEvent )
Emitted when the cursor enters.
- hoverEvent - The hover event.
[signal] void LocalSceneQuickView::hoverLeft (QHoverEvent &hoverEvent )
Emitted when the cursor leaves.
- hoverEvent - The hover event.
[signal] void LocalSceneQuickView::hoverMoved (QHoverEvent &hoverEvent )
Emitted when the cursor moves.
- hoverEvent - The hover event.
[signal] void LocalSceneQuickView::keyPressed (QKeyEvent &keyEvent )
Emitted when a key pressed has been detected.
- keyEvent - The key event.
[signal] void LocalSceneQuickView::keyReleased (QKeyEvent &keyEvent )
Emitted when a key release has been detected.
- keyEvent - The key event.
[signal] void LocalSceneQuickView::layerViewStateChanged (Esri::ArcGISRuntime::Layer *layer, const Esri::ArcGISRuntime::LayerViewState &layerViewState )
Signal emitted when the LayerViewState changes.
- layer - The layer that had a state change.
- layerViewState - The LayerViewState with the new state information.
The returned Layer object has the LocalSceneQuickView as its parent.
See also Returned QObjects Parenting.
[signal] void LocalSceneQuickView::mouseClicked (QMouseEvent &mouseEvent )
Emitted when mouse is pressed and released over the same location.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mouseDoubleClicked (QMouseEvent &mouseEvent )
Emitted when a double click even is detected.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mouseMoved (QMouseEvent &mouseEvent )
Emitted when mouse is moved.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mousePressed (QMouseEvent &mouseEvent )
Emitted when mouse is pressed.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mousePressedAndHeld (QMouseEvent &mouseEvent )
Emitted when there is a long press and hold (currently 800ms) on the same point.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mouseReleased (QMouseEvent &mouseEvent )
Emitted when mouse is release.
- mouseEvent - The mouse event.
[signal] void LocalSceneQuickView::mouseWheelChanged (QWheelEvent &wheelEvent )
Emitted when mouse wheel movement has been detected.
- wheelEvent - The wheel event.
[signal] void LocalSceneQuickView::navigatingChanged ()
Signal emitted when the view has started or completed navigating.
[signal] void LocalSceneQuickView::rectChanged (const QRectF &rect)
Emitted when the visible area changes.
- rect - The new rect representing the visible area.
[signal] void LocalSceneQuickView::sceneChanged ()
Emitted when the scene changes.
[signal] void LocalSceneQuickView::spatialReferenceChanged ()
Signal emitted when the SpatialReference changed.
[signal] void LocalSceneQuickView::touched(QTouchEvent &event)
Emitted when a touch event has been detected.
Accept the event to prevent the SceneQuickView from performing its default gesture interaction behavior.
- event - The touch event.
[signal] void LocalSceneQuickView::viewpointChanged ()
Emitted when the viewpoint changes.
[signal] void LocalSceneQuickView::warningsChanged (const QList<Esri::ArcGISRuntime::Error > &warnings)
Signal emitted when the warnings on the view change.
- warnings - The warnings on the view.