The controller part of a OverviewMap. This class handles the management of the inset MapView, including symbol styling and navigation. More...
| Header: | #include <OverviewMapController> |
| Inherits: | QObject |
Properties
- geoView : QObject*
- insetView : QObject* const
- scaleFactor : double
Public Functions
| OverviewMapController(QObject *parent = nullptr) | |
| virtual | ~OverviewMapController() override |
| QObject * | geoView() const |
| Esri::ArcGISRuntime::Toolkit::MapViewToolkit * | insetView() const |
| double | scaleFactor() const |
| void | setGeoView(QObject *geoView) |
| void | setScaleFactor(double scaleFactor) |
| void | setSymbol(Esri::ArcGISRuntime::Symbol *symbol) |
| Esri::ArcGISRuntime::Symbol * | symbol() const |
Signals
| void | geoViewChanged() |
| void | scaleFactorChanged() |
| void | symbolChanged() |
Detailed Description
Property Documentation
geoView : QObject*
This property holds the geoview the controller is listening to for viewpoint changes.
Access functions:
| QObject * | geoView() const |
| void | setGeoView(QObject *geoView) |
Notifier signal:
| void | geoViewChanged() |
See also Esri::ArcGISRuntime::Toolkit::OverviewMapController::geoView().
[read-only] insetView : QObject* const
MapView which represents an overview/inset of the current viewpoint of the geoView.
Access functions:
| Esri::ArcGISRuntime::Toolkit::MapViewToolkit * | insetView() const |
See also Esri::ArcGISRuntime::Toolkit::OverviewMapController::insetView().
scaleFactor : double
This property holds the scaleFactor between the geoView's viewpoint and the insetView's viewpoint.
Access functions:
| double | scaleFactor() const |
| void | setScaleFactor(double scaleFactor) |
Notifier signal:
| void | scaleFactorChanged() |
See also Esri::ArcGISRuntime::Toolkit::OverviewMapController::scaleFactor().
Member Function Documentation
[invokable] OverviewMapController::OverviewMapController (QObject *parent = nullptr)
Constructs a new OverviewMapController object with a given parent.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[override virtual] OverviewMapController::~OverviewMapController ()
Destructor.
QObject *OverviewMapController::geoView () const
Returns the GeoView as a QObject.
Note: Getter function for property geoView.
See also setGeoView().
[signal] void OverviewMapController::geoViewChanged ()
Emitted when the geoView has changed.
Note: Notifier signal for property geoView.
Esri::ArcGISRuntime::Toolkit::MapViewToolkit *OverviewMapController::insetView () const
Returns a MapView owned by this controller which represents the underlying inset of the OverviewMap tool.
For the C++/Quick toolkit this is a MapQuickView, for the C++/Widgets toolkit this is a MapGraphicsView.
Note: Getter function for property insetView.
double OverviewMapController::scaleFactor () const
Returns the amount to scale the OverviewMap compared to the geoView. Defaults to 25.0.
Note: Getter function for property scaleFactor.
See also setScaleFactor().
[signal] void OverviewMapController::scaleFactorChanged ()
Emitted when the scaleFactor has changed.
Note: Notifier signal for property scaleFactor.
void OverviewMapController::setGeoView (QObject *geoView )
Set the GeoView object this Controller uses.
Internally this is cast to a MapView or SceneView using qobject_cast, which is why the paremeter is of form QObject and not GeoView.
- geoView
Objectwhich must inherit fromGeoView*andQObject*.
Note: Setter function for property geoView.
See also geoView().
void OverviewMapController::setScaleFactor (double scaleFactor )
Sets the amount to scale the OverviewMap compared to the geoView.
- scaleFactor The scale factor. Defaults to 25.0.
Note: Setter function for property scaleFactor.
See also scaleFactor().
void OverviewMapController::setSymbol (Esri::ArcGISRuntime::Symbol *symbol)
Sets the symbol used to represent the GeoView's current viewpoint.
For MapView, the default is an empty SimpleFillSymbol with a 1 point red outline; for SceneView, it will be a red, cross-hair SimpleMarkerSymbol.
See also symbol().
Esri::ArcGISRuntime::Symbol *OverviewMapController::symbol() const
Returns the symbol used to represent the GeoView's current viewpoint.
If OverviewMapController::geoView is not set, then the symbol will return nullptr by default.
If OverviewMapController::geoView is set, and a custom symbol was not applied, then a default will be provided.
For MapView, the default is an empty SimpleFillSymbol with a 1 point red outline; for SceneView, it will be a red, cross-hair SimpleMarkerSymbol.
See also setSymbol().
[signal] void OverviewMapController::symbolChanged ()
Emitted when the symbol has changed.