Class VenueLevel

java.lang.Object
com.here.NativeBase
com.here.sdk.venue.data.VenueLevel

public final class VenueLevel extends NativeBase

Represents one level of a building or a complex of buildings inside the VenueDrawing.

  • Method Details

    • getGeometryByCoordinates

      @Nullable public VenueGeometry getGeometryByCoordinates(@NonNull GeoCoordinates coordinates)

      Gets a geometry by coordinates.

      Parameters:
      coordinates -

      The coordinates inside the searching geometry.

      Returns:

      The geometry covering the coordinates or null.

    • getGeometriesByCoordinates

      @NonNull public List<VenueGeometry> getGeometriesByCoordinates(@NonNull GeoCoordinates coordinates)

      Gets geometries by coordinates.

      Parameters:
      coordinates -

      The coordinates inside the searching geometries.

      Returns:

      The list of geometries covering the coordinate or an empty list.

    • getGeometryById

      @Nullable public VenueGeometry getGeometryById(@NonNull String geometryId)

      Gets a geometry by an id.

      Parameters:
      geometryId -

      The id of the geometry.

      Returns:

      The geometry with the given id or null.

    • getGeometryByAddress

      @Nullable public VenueGeometry getGeometryByAddress(@NonNull String geometryAddress)

      Gets a geometry by the VenueGeometry.InternalAddress.

      Parameters:
      geometryAddress -

      The internal address as a String.

      Returns:

      The geometry with the given address or null.

    • filterGeometry

      @NonNull public List<VenueGeometry> filterGeometry(@NonNull String filter, @NonNull VenueGeometryFilterType filterType)

      Gets the filtered geometries in an ascending order.

      Parameters:
      filter -

      The filter string.

      filterType -

      The filter type.

      Returns:

      The list of the filtered geometries or an empty list.

    • getTopologyByCoordinates

      @Nullable public VenueTopology getTopologyByCoordinates(@NonNull GeoCoordinates coordinates)

      Gets a topology by coordinates.

      Parameters:
      coordinates -

      The coordinates inside the searching topology.

      Returns:

      The topology covering the coordinates or null.

    • getCrosswalkByCoordinates

      @Nullable public Crosswalk getCrosswalkByCoordinates(@NonNull GeoCoordinates coordinates)

      Gets a crosswalk by coordinates.

      Parameters:
      coordinates -

      The coordinates inside the searching crosswalk.

      Returns:

      The crosswalk covering the coordinates or null.

    • getIdentifier

      @NonNull public String getIdentifier()

      Gets an id of the level.

      Returns:

      The id of the level.

    • getZIndex

      public int getZIndex()

      Gets an order in the z direction (altitude).

      Z index 0 represents a ground level, negative values represent underground levels, positive values - levels above ground.

      Returns:

      The Z index of the level, an order in the z direction (altitude).

    • getProperties

      @NonNull public Map<String,Property> getProperties()

      Gets properties of the level.

      Returns:

      The properties of the level.

    • getName

      @NonNull public String getName()

      Gets a 'name' property of the level from the level properties.

      If the 'name' property is missing in the properties, the string will be empty.

      Returns:

      The name property of the level.

    • getShortName

      @NonNull public String getShortName()

      Gets a short name of the level.

      Returns:

      The short name of the level.

    • isMainLevel

      public boolean isMainLevel()

      Indicates if this level is the main level.

      Returns:

      True if this is the main level and false otherwise.

    • getDrawing

      @NonNull public VenueDrawing getDrawing()

      Gets a parent drawing of the level.

      Returns:

      The parent drawing of the level.

    • getGeometries

      @NonNull public List<VenueGeometry> getGeometries()

      Gets a list of geometries of the level.

      Returns:

      The list of geometries of the level.

    • getDrawingID

      @NonNull public String getDrawingID()

      Gets drawing ID of the level.

      Returns:

      The drawing ID of level.

    • getCenter

      @NonNull public GeoCoordinates getCenter()

      Gets a center of the level.

      Returns:

      The geographic coordinates of the center of the level.

    • getBoundingBox

      @NonNull public GeoBox getBoundingBox()

      Gets a bounding box of the level.

      Returns:

      The GeoBox of the bounding area.

    • getGeometriesByName

      @NonNull public List<VenueGeometry> getGeometriesByName()

      Gets the geometries ordered by a name in an ascending order.

      Returns:

      The geometries ordered by the name in an ascending order.

    • getGeometriesByIconNames

      @NonNull public Map<String,List<VenueGeometry>> getGeometriesByIconNames()

      Gets the geometries mapped by icon names.

      Returns:

      The map from the icon names to the geometries in the drawing.

    • getTopologies

      @NonNull public List<VenueTopology> getTopologies()

      Gets a list of topologies of the level.

      Returns:

      The list of topologies of the level.

    • getCrosswalks

      @NonNull public List<Crosswalk> getCrosswalks()

      Gets a list of crosswalks of the level.

      Returns:

      The list of crosswalks of the level.