VenueLevel (API Reference)
Class VenueLevel
Represents one level of a building or a complex of buildings inside the VenueDrawing.
-
Method Summary
Modifier and TypeMethodDescriptionfilterGeometry(String filter, VenueGeometryFilterType filterType) Gets the filtered geometries in an ascending order.Gets a bounding box of the level.Gets a center of the level.getCrosswalkByCoordinates(GeoCoordinates coordinates) Gets a crosswalk by coordinates.Gets a list of crosswalks of the level.Gets a parent drawing of the level.Gets drawing ID of the level.Gets a list of geometries of the level.getGeometriesByCoordinates(GeoCoordinates coordinates) Gets geometries by coordinates.Gets the geometries mapped by icon names.Gets the geometries ordered by a name in an ascending order.getGeometryByAddress(String geometryAddress) Gets a geometry by theVenueGeometry.InternalAddress.getGeometryByCoordinates(GeoCoordinates coordinates) Gets a geometry by coordinates.getGeometryById(String geometryId) Gets a geometry by an id.Gets an id of the level.getName()Gets a 'name' property of the level from the level properties.Gets properties of the level.Gets a short name of the level.Gets a list of topologies of the level.getTopologyByCoordinates(GeoCoordinates coordinates) Gets a topology by coordinates.intGets an order in the z direction (altitude).booleanIndicates if this level is the main level.
-
Method Details
-
getGeometryByCoordinates
Gets a geometry by coordinates.
- Parameters:
coordinates-The coordinates inside the searching geometry.
- Returns:
The geometry covering the coordinates or
null.
-
getGeometriesByCoordinates
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
Gets a geometry by an id.
- Parameters:
geometryId-The id of the geometry.
- Returns:
The geometry with the given id or
null.
-
getGeometryByAddress
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
Gets a topology by coordinates.
- Parameters:
coordinates-The coordinates inside the searching topology.
- Returns:
The topology covering the coordinates or
null.
-
getCrosswalkByCoordinates
Gets a crosswalk by coordinates.
- Parameters:
coordinates-The coordinates inside the searching crosswalk.
- Returns:
The crosswalk covering the coordinates or
null.
-
getIdentifier
Gets an id of the level.
- Returns:
The
idof 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
Gets properties of the level.
- Returns:
The properties of the level.
-
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
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:
Trueif this is the main level andfalseotherwise.
-
getDrawing
Gets a parent drawing of the level.
- Returns:
The parent drawing of the level.
-
getGeometries
Gets a list of geometries of the level.
- Returns:
The list of geometries of the level.
-
getDrawingID
Gets drawing ID of the level.
- Returns:
The drawing ID of level.
-
getCenter
Gets a center of the level.
- Returns:
The geographic coordinates of the center of the level.
-
getBoundingBox
Gets a bounding box of the level.
- Returns:
The
GeoBoxof the bounding area.
-
getGeometriesByName
Gets the geometries ordered by a name in an ascending order.
- Returns:
The geometries ordered by the name in an ascending order.
-
getGeometriesByIconNames
Gets the geometries mapped by icon names.
- Returns:
The map from the icon names to the geometries in the drawing.
-
getTopologies
Gets a list of topologies of the level.
- Returns:
The list of topologies of the level.
-
getCrosswalks
Gets a list of crosswalks of the level.
- Returns:
The list of crosswalks of the level.
-