Package com.esri.arcgisruntime.mapping.floor

Class FloorLevel

  • public final class FloorLevel
extends Object
    A floor level within a facility for a floor-aware map or scene.

    A floor level describes the footprint of each floor contained in a FloorFacility. You can get the floor levels from the FloorManager associated with a floor-aware map or scene.

    Since:
    100.12.0
    See Also:
    FloorManager.getLevels()

    • Method Detail

      • getFacility

        public FloorFacility getFacility()
        Gets the facility that contains the floor level.

        This property will be null for orphan levels (those not contained in a facility).

        Returns:
        the facility that contains the floor level, or null if none
        Since:
        100.12.0

      • getGeometry

        public Geometry getGeometry()
        Gets the geometry of this level.
        Returns:
        the geometry of this level, or null if none
        Since:
        100.12.0

      • getLevelId

        public String getLevelId()
        Gets the level ID.
        Returns:
        the level ID
        Since:
        100.12.0

      • isVisible

        public boolean isVisible()
        Gets the level's visibility.

        The level visibility, true if the level is visible; false otherwise. The default value is true in 3D and for the ground floor in 2D.

        Returns:
        the level's visibility
        Since:
        100.12.0

      • setVisible

        public void setVisible​(boolean isVisible)
        Sets the level's visibility.

        The level visibility, true if the level is visible; false otherwise. The default value is true in 3D and for the ground floor in 2D.

        Parameters:
        isVisible - the level's visibility
        Since:
        100.12.0

      • getLevelNumber

        public int getLevelNumber()
        Gets the floor number of this level in the facility.
        Returns:
        the floor number of this level in the facility
        Since:
        100.12.0

      • getLongName

        public String getLongName()
        Gets the long name of this level.

        The long name supports floor filtering in floor-aware apps. Some floor-aware apps only display a long name (e.g. "Level 1") in the floor filtering UI, others may use the getShortName() (e.g. "L1") or allow toggling between the two.

        Returns:
        the long name of this level
        Since:
        100.12.0

      • getShortName

        public String getShortName()
        Gets the short name of this level.

        The short name supports floor filtering in floor-aware apps. Some floor-aware apps only display a short name (e.g. "L1") in the floor filtering UI, others may use the getLongName() (e.g. "Level 1") or allow toggling between the two.

        Returns:
        the short name of this level
        Since:
        100.12.0

      • getVerticalOrder

        public int getVerticalOrder()
        Gets the vertical order within the collection of levels for the facility.

        The default value is 0, which represents the ground floor.

        Returns:
        the vertical order within the collection of levels for the facility
        Since:
        100.12.0