HERE Android SDK Developer's Guide

VenueManeuver

The class VenueManeuver is a member of com.here.android.mpa.venues3d .

Class Summary

public class VenueManeuver

extends java.lang.Object

This class represents a single route maneuver of an indoor route section.

[For complete information, see the section Class Details]

See also:

VenueRoute

Nested Class Summary

Table 1. Nested Classes in VenueManeuver
Nested Classes

public static final enumeration VenueManeuver.ActionType

This enumeration defines identifiers for enter/exit action types.

public static final enumeration VenueManeuver.ConnectorType

This enumeration defines values that describe a connector type from one space to other.

public static final enumeration VenueManeuver.LevelChangeType

This enumeration defines the vertical directionality of a maneuver.

Method Summary

Table 2. Methods in VenueManeuver
Methods

public boolean equals (Object o)

public ActionType getActionType ()

Returns an VenueManeuver.ActionType for this maneuver.

public int getAngle ()

The angle in degrees from end of the start road to the start of the end road.

public GeoBoundingBox getBoundingBox ()

Gets the GeoBoundingBox of the route subsegment the VenueManeuver belongs to.

public ConnectorType getConnectorType ()

Returns a VenueManeuver.ConnectorType for this maneuver.

public float getDistanceFromPreviousManeuver ()

Returns a distance of this maneuver from possible previous maneuver.

public float getDistanceFromStart ()

Returns a distance of this maneuver from the start of the route section.

public float getDistanceToNextManeuver ()

Returns a distance of this maneuver to possible next maneuver.

public int getFloorIndex ()

Returns a floor index where maneuver happens.

public GeoCoordinate getGeoCoordinate ()

Returns a location a GeoCoordinate of this maneuver.

public java.util.List <GeoCoordinate> getGeometry ()

Returns the geometry of this maneuver.

public LevelChangeType getLevelChangeType ()

Returns a VenueManeuver.LevelChangeType for this maneuver.

public MapObject getMapObject ()

The map object, which is displayed on the geoCoordinates of this maneuver.

public int getMapOrientation ()

Gets the map orientation at the start of the maneuver, in degrees.

public String getNaturalGuidancePOI ()

Gets the name of the natural guidance POI.

public static float getNaturalGuidanceRadius ()

Gets the search radius for natural guidance.

public Space getSpace ()

Returns an Space object related to this maneuver.

public VenueManeuver getTargetManeuver ()

Returns a target VenueManeuver for a series of connectors of the same type (elevator, escalator etc.) which are going in the same direction.

public Turn getTurn ()

Gets the Maneuver.Turn required to complete the maneuver.

public int hashCode ()

public boolean setMapObject (MapObject mapObject)

Sets the current map object, which will be displayed on the geoCoordinates of maneuver.

public static void setNaturalGuidanceRadius (float radius)

Sets the search radius for natural guidance.

Class Details

This class represents a single route maneuver of an indoor route section.

See also:

VenueRoute

Method Details

public boolean equals (Object o)

Parameters:

  • o

public ActionType getActionType ()

Returns an VenueManeuver.ActionType for this maneuver.

Returns:

An action id.

public int getAngle ()

The angle in degrees from end of the start road to the start of the end road. Angle has a value from 0, 360, north is up, clockwise.

Note: a returned value of zero represents the end road that continues in the same direction as the start road.

Returns:

The angle in degrees

public GeoBoundingBox getBoundingBox ()

Gets the GeoBoundingBox of the route subsegment the VenueManeuver belongs to.

Returns:

A GeoBoundingBox object.

public ConnectorType getConnectorType ()

Returns a VenueManeuver.ConnectorType for this maneuver.

Returns:

A connector type.

public float getDistanceFromPreviousManeuver ()

Returns a distance of this maneuver from possible previous maneuver.

Returns:

A distance in meters.

public float getDistanceFromStart ()

Returns a distance of this maneuver from the start of the route section.

Returns:

A distance in meters.

public float getDistanceToNextManeuver ()

Returns a distance of this maneuver to possible next maneuver.

Returns:

A distance in meters.

public int getFloorIndex ()

Returns a floor index where maneuver happens.

Returns:

A floor index.

public GeoCoordinate getGeoCoordinate ()

Returns a location a GeoCoordinate of this maneuver.

Returns:

A geolocation of the maneuver.

public java.util.List <GeoCoordinate> getGeometry ()

Returns the geometry of this maneuver.

Returns:

The geometry of the maneuver.

public LevelChangeType getLevelChangeType ()

Returns a VenueManeuver.LevelChangeType for this maneuver.

Returns:

A level change type id.

public MapObject getMapObject ()

The map object, which is displayed on the geoCoordinates of this maneuver.

Returns:

The map object, which is displayed on the getGeoCoordinate() position of this maneuver. The returned mapObject will be instance of either MapMarker or MapLocalModel.

public int getMapOrientation ()

Gets the map orientation at the start of the maneuver, in degrees.

Note: a returned value of zero represents true-north, with increasing values representing a clockwise progression of map orientation.

Returns:

The orientation

public String getNaturalGuidancePOI ()

Gets the name of the natural guidance POI.

Returns:

The name of the natural guidance POI or the empty string.

public static float getNaturalGuidanceRadius ()

Gets the search radius for natural guidance.

Returns:

The search radius for natural guidance in meters.

public Space getSpace ()

Returns an Space object related to this maneuver.

Returns:

An space object.

public VenueManeuver getTargetManeuver ()

Returns a target VenueManeuver for a series of connectors of the same type (elevator, escalator etc.) which are going in the same direction. We accept some links between connectors, like in case of stairs or escalators. For example, if the user enters an elevator, then the target maneuver will be the exit from it. Otherwise returns null.

Returns:

An VenueManeuver object.

public Turn getTurn ()

Gets the Maneuver.Turn required to complete the maneuver.

Returns:

The Maneuver.Turn

public int hashCode ()

public boolean setMapObject (MapObject mapObject)

Sets the current map object, which will be displayed on the geoCoordinates of maneuver.

Parameters:

  • mapObject

    The instance of MapMarker or MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If mapObject is null, the default map object will be used for this maneuver depending on the type of the getConnectorType().

Returns:

Whether the changing of maneuver was successful.

public static void setNaturalGuidanceRadius (float radius)

Sets the search radius for natural guidance.

Parameters:

  • radius

    The search radius for natural guidance in meters.