VenueDrawing (API Reference)
Class VenueDrawing
Represents a drawing inside the VenueModel. The drawing can be
a separate building in a complex of buildings, or show a different
view of a venue. For example, in an airport, one drawing can be used
as an overview of all buildings in this venue, while other drawings
contains details for each terminal in this airport.
-
Method Summary
Modifier and TypeMethodDescriptionfilterGeometry(String filter, VenueGeometryFilterType filterType) Gets filtered geometries in an ascending order.Gets a bounding box of the drawing.Gets a center of the drawing.Gets geometries mapped by icon names.Gets geometries ordered by a name in an ascending order.getGeometryByAddress(String geometryAddress) Gets a geometry by theVenueGeometry.InternalAddress.getGeometryById(String geometryId) Gets a geometry by an id.Gets an id of the drawing.Gets levels of the drawing.Gets properties of the drawing.Gets a list of topologies of the drawing.Gets a parent venue model.booleanisRoot()Checks if this is a root drawing of the venue.
-
Method Details
-
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 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.
-
getIdentifier
Gets an id of the drawing.
This describes the identifier for drawing.
- Returns:
The
idof the drawing.
-
isRoot
public boolean isRoot()Checks if this is a root drawing of the venue.
This can be used to check if this is top level drawing in venue.
- Returns:
Trueif this is the root drawing andfalseotherwise.
-
getVenueModel
Gets a parent venue model.
It can be used to get the
VenueModelwhere this Drawing belong.- Returns:
The parent venue model.
-
getLevels
Gets levels of the drawing.
This describes for which all level this drawing belongs.
- Returns:
The array with Level objects.
-
getCenter
Gets a center of the drawing.
It can be used to get center coordinates of drawing.
- Returns:
The Geographic coordinates of the center of the drawing.
-
getBoundingBox
Gets a bounding box of the drawing.
This is used to check if at certain zoom level and inside view this GeoBox belongs, then need to render.
- Returns:
The
GeoBoxof the bounding area of the drawing.
-
getProperties
Gets properties of the drawing.
This can be used to get different properties like name belonging to Drawing.
- Returns:
The key-value pairs of properties.
-
getGeometriesByName
Gets geometries ordered by a name in an ascending order.
This can be used to search geometries by name.
- Returns:
The geometries ordered by the name.
-
getGeometriesByIconNames
Gets geometries mapped by icon names.
This can be used to search the geometries by icon names.
- Returns:
The map from the icon names to the geometries in the drawing.
-
getTopologies
Gets a list of topologies of the drawing.
This can be used to check for which all topologies are realted to Drawing.
- Returns:
The list of topologies of the drawing.
-