Manages the data displayed by a floor-aware map or scene, allowing filtering based on floor levels. More...
| Header: | #include <FloorManager.h> |
| Since: | Esri::ArcGISRuntime 100.12 |
| Inherits: | Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable |
Public Functions
| virtual | ~FloorManager() override |
| QList<Esri::ArcGISRuntime::FloorFacility *> | facilities() const |
| Esri::ArcGISRuntime::Layer * | facilityLayer() const |
| Esri::ArcGISRuntime::Layer * | levelLayer() const |
| QList<Esri::ArcGISRuntime::FloorLevel *> | levels() const |
| Esri::ArcGISRuntime::Layer * | siteLayer() const |
| QList<Esri::ArcGISRuntime::FloorSite *> | sites() const |
Reimplemented Public Functions
| virtual void | cancelLoad() override |
| virtual void | load() override |
| virtual Esri::ArcGISRuntime::Error | loadError() const override |
| virtual Esri::ArcGISRuntime::LoadStatus | loadStatus() const override |
| virtual void | retryLoad() override |
Signals
| void | doneLoading(const Esri::ArcGISRuntime::Error &loadError) |
| void | loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus) |
Detailed Description
A FloorManager must be loaded before you can access its site, facility, and level properties. When a map's floor manager is loaded, floor-aware layers display only data associated with the ground floor by default. When a scene's floor manager is loaded, floor-aware layers display data from all floors by default.
You can filter the data displayed by floor-aware layers by toggling the FloorLevel::isVisible property of levels in the floor manager.
The FloorManager will fail to load if:
- The map/scene associated with the floor manager is not floor-aware.
- The mandatory facility or level layer does not exist.
- It is unable to get the facilities or levels from their respective layers.
- It is unable to get the sites from a specified site layer.
Relevant samples:
- Browse building floors: Display and browse through building floors from a floor-aware web map.
See also Map.
Member Function Documentation
[override virtual] FloorManager::~FloorManager ()
Destructor.
[override virtual] void FloorManager::cancelLoad ()
Reimplements: Loadable::cancelLoad().
Cancels loading metadata for the object.
Cancels loading the metadata if the object is loading and always calls doneLoading.
[signal] void FloorManager::doneLoading (const Esri::ArcGISRuntime::Error &loadError )
Signal emitted when this object is done loading.
- loadError - Details about any error that may have occurred
Note: If there is a load error, it will also be emitted on the errorOccurred signal.
QList<Esri::ArcGISRuntime::FloorFacility *> FloorManager::facilities() const
Returns the collection of facilities in the floor-aware map or scene.
These are obtained from FloorManager::facilityLayer.
This property is initialized after the FloorManager is loaded.
Esri::ArcGISRuntime::Layer *FloorManager::facilityLayer () const
Returns the layer containing features that represent facilities.
This property is initialized after the FloorManager is loaded.
Esri::ArcGISRuntime::Layer *FloorManager::levelLayer () const
Returns the layer containing features that represent floor levels.
This property is initialized after the FloorManager is loaded.
QList<Esri::ArcGISRuntime::FloorLevel *> FloorManager::levels() const
Returns floor levels in the floor-aware map or scene.
These are obtained from FloorManager::levelLayer.
This property is initialized after the FloorManager is loaded.
[override virtual] void FloorManager::load()
Reimplements: Loadable::load().
Loads the metadata for the object asynchronously.
Loads the metadata if the object is not loaded and always calls doneLoading.
[override virtual] Esri::ArcGISRuntime::Error FloorManager::loadError () const
Reimplements: Loadable::loadError() const.
Returns the load error.
See also Error.
[override virtual] Esri::ArcGISRuntime::LoadStatus FloorManager::loadStatus () const
Reimplements: Loadable::loadStatus() const.
Returns the load status.
See also LoadStatus.
[signal] void FloorManager::loadStatusChanged (Esri::ArcGISRuntime::LoadStatus loadStatus )
Signal emitted when the load status changes for this object.
- loadStatus - The LoadStatus
See also Loadable.
[override virtual] void FloorManager::retryLoad ()
Reimplements: Loadable::retryLoad().
Loads or retries loading metadata for the object asynchronously.
Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.
Esri::ArcGISRuntime::Layer *FloorManager::siteLayer () const
Returns the layer containing features that represent sites.
This property is initialized after the FloorManager is loaded.
QList<Esri::ArcGISRuntime::FloorSite *> FloorManager::sites() const
Returns the layer containing features that represent sites in the floor-aware map or scene.
These are obtained from FloorManager::siteLayer and sorted based on name.
This property is initialized after the FloorManager is loaded.