Package com.esri.arcgisruntime.mapping.floor

Class FloorManager

  • All Implemented Interfaces:
    Loadable
    public final class FloorManager
extends Object
implements Loadable
    Manages the data displayed by a floor-aware map or scene, allowing filtering based on floor levels.

    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 scenarios where FloorManager fails to load include:

    • The map/scene associated with the floor manager is not floor-aware.
    • The mandatory facility or level layer doesn't 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.
    Since:
    100.12.0
    See Also:
    ArcGISMap

    • Method Detail

      • getFacilities

        public List<FloorFacility> getFacilities()
        Gets an unmodifiable list of facilities.

        The facilities in the floor-aware map or scene. These are obtained from getFacilityLayer(). This property is initialized after the FloorManager is loaded. Otherwise, an empty list will be returned.

        Returns:
        an unmodifiable list of facilities
        Since:
        100.12.0

      • getFacilityLayer

        public Layer getFacilityLayer()
        Gets the layer containing features that represent facilities - that is, the footprint of each facility represented by FloorFacility.

        This property is initialized after the FloorManager is loaded. Otherwise, null will be returned.

        Returns:
        the facility layer, or null if none
        Since:
        100.12.0

      • getLevelLayer

        public Layer getLevelLayer()
        Gets the level layer containing features that represent floor levels — that is, the footprint of each floor level represented by FloorLevel.

        This property is initialized after the FloorManager is loaded. Otherwise, null will be returned.

        Returns:
        the level layer, or null if none
        Since:
        100.12.0

      • getLevels

        public List<FloorLevel> getLevels()
        Gets an unmodifiable list of floor levels in the floor-aware map or scene. These are obtained from getLevelLayer().

        This property is initialized after the FloorManager is loaded. Otherwise, an empty list will be returned.

        Returns:
        an unmodifiable list of floor levels
        Since:
        100.12.0

      • getSiteLayer

        public Layer getSiteLayer()
        Gets the site layer containing features that represent sites - that is, the boundary of each site represented by FloorSite.

        This property is initialized after the FloorManager is loaded. Otherwise, null will be returned.

        Returns:
        the site layer, or null if none
        Since:
        100.12.0

      • getSites

        public List<FloorSite> getSites()
        Gets an unmodifiable list of sites, sorted by name. These are the sites in the floor-aware map or scene; they are obtained from getSiteLayer() and sorted based on name.

        This property is initialized after the FloorManager is loaded. Otherwise, an empty list will be returned.

        Returns:
        an unmodifiable list of sites, sorted by name
        Since:
        100.12.0

      • getLoadStatus

        public LoadStatus getLoadStatus()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        Returns:
        the LoadStatus of the loadable resource

      • cancelLoad

        public void cancelLoad()
        Description copied from interface: Loadable
        Cancels loading metadata for the object.

        Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

        A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.getLoadError().

        Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

        This method does nothing if the resource is not in LoadStatus.LOADING state.

        Specified by:
        cancelLoad in interface Loadable

      • loadAsync

        public void loadAsync()
        Description copied from interface: Loadable
        Loads the metadata of the loadable resource asynchronously.

        The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via Loadable.addDoneLoadingListener(java.lang.Runnable) that is invoked upon completion of the asynchronous load operation.

        If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

        If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling Loadable.getLoadError().

        This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

        If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, Loadable.retryLoadAsync() needs to be used.

        A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling Loadable.cancelLoad().

        Specified by:
        loadAsync in interface Loadable

      • retryLoadAsync

        public void retryLoadAsync()
        Description copied from interface: Loadable
        Loads or retries loading metadata for the object asynchronously.

        Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

        For more details on the load process see Loadable.loadAsync().

        Specified by:
        retryLoadAsync in interface Loadable

      • addDoneLoadingListener

        public void addDoneLoadingListener​(Runnable runner)
        Description copied from interface: Loadable
        Adds a listener to the loadable resource that is invoked when loading has completed.

        The listener may be added at any point, whether the loadable resource has already completed loading or not.

        • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
        • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

        Alternatively, to be notified when there is any change in the load status, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method instead.

        Specified by:
        addDoneLoadingListener in interface Loadable
        Parameters:
        runner - a Runnable that is invoked upon completion of the load operation

      • removeDoneLoadingListener

        public boolean removeDoneLoadingListener​(Runnable runner)
        Description copied from interface: Loadable
        Removes a done loading listener from the loadable resource.
        Specified by:
        removeDoneLoadingListener in interface Loadable
        Parameters:
        runner - the listener to be removed
        Returns:
        true if the listener was removed, otherwise false

      • addLoadStatusChangedListener

        public void addLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

        Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

        The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the Loadable.addDoneLoadingListener(Runnable) method.

        Specified by:
        addLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be added

      • removeLoadStatusChangedListener

        public boolean removeLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Removes a LoadStatusChangedListener from the loadable resource.
        Specified by:
        removeLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be removed
        Returns:
        true if the listener was removed, otherwise false