Venue
The class Venue is a member of com.here.android.mpa.venues3d .
Class Summary
public final class Venue
extends java.lang.Object
This class represents a public building or a group of public buildings on a map.
[For complete information, see the section Class Details]
See also:
Method Summary
| Methods |
|---|
| |
| This method retrieves the bounding box of the given |
| This method retrieves the center of the bounding box of the given venue. |
| This method retrieves the Content object the given |
| This method retrieves a string which uniquely identifies the given venue. |
| This method retrieves a list of Level objects for the given |
| This method retrieves spaces that intersect a circle around the center of a space. |
| This method retrieves the alphabetically ordered array of Space objects for the given |
| This method retrieves the space or the facility as the Space object based on the given identifier inside this |
| |
Class Details
This class represents a public building or a group of public buildings on a map. Examples of public buildings are shopping malls and airports. Venue objects are based on models stored by the back-end service and constructed as necessary, for example when the map pans to an area where a venue exists. Similarly, when the map is panned away from that area, the venue object is removed from the map view to free up the memory reserved for the venues.
A Venue instance includes one or more Level objects. A Level in turn consists of one or more OuterArea objects. An OuterArea represents a physical form of an outer area of a level in the building. An OuterArea typically contains Space objects that represent, for example, single shops inside the venue.
A Venue cannot be instantiated directly. Instead, an instance can be obtained by calling getVenue().
See also:
Method Details
public boolean equals (Object o)
Parameters:
-
o
public GeoBoundingBox getBoundingBox ()
This method retrieves the bounding box of the given Venue instance.
Returns:
An object representing the bounding box that encloses the given venue.
public GeoCoordinate getCenter ()
This method retrieves the center of the bounding box of the given venue.
Returns:
An object containing the geographic coordinates of the center of the bounding box of the given venue.
public Content getContent ()
This method retrieves the Content object the given Venue instance.
Returns:
An object representing the venue content.
public String getId ()
This method retrieves a string which uniquely identifies the given venue.
Returns:
The unique identifier of the given Venue object.
public java.util.List <Level> getLevels ()
This method retrieves a list of Level objects for the given Venue . A Level consist of one or more OuterArea objects.
Returns:
The list of Level objects.
public java.util.List <Space> getNearbySpaces (Space space, float radius)
This method retrieves spaces that intersect a circle around the center of a space.
Parameters:
-
spaceThe Space for which to find nearby spaces.
-
radiusThe radius in meters of the circle around the center of the space inside of which to search for nearby spaces.
Returns:
A (possibly empty) list of nearby spaces.
public java.util.List <Space> getSortedSpaces ()
This method retrieves the alphabetically ordered array of Space objects for the given Venue .
Returns:
The list of Space objects ordered alphabetically per level, starting from the lowest level.
public Space getSpace (String id)
This method retrieves the space or the facility as the Space object based on the given identifier inside this Venue .
Parameters:
-
idThe string containing the
Spaceidentifier.
Returns:
An object representing the requested space or null if there is no match for the identifier.
See also:
public int hashCode ()