Class DirectionManeuver


  • public final class DirectionManeuver
    extends Object
    Represents an individual maneuver in a series of turn-by-turn driving directions.
    Since:
    100.0.0
    See Also:
    Route.getDirectionManeuvers()
    • Method Detail

      • getDirectionText

        public String getDirectionText()
        Gets the text describing the maneuver. The language for this text is based on the device Locale.
        Returns:
        the direction text
        Since:
        100.0.0
      • getDirectionEvents

        public List<DirectionEvent> getDirectionEvents()
        Gets a list of DirectionEvent associated with this DirectionManeuver.
        Returns:
        an unmodifiable list of the direction events
        Since:
        100.0.0
      • getEstimatedArrivalTime

        public Calendar getEstimatedArrivalTime()
        Gets the estimated arrival time.
        Returns:
        the estimated arrival time
        Since:
        100.0.0
      • getEstimatedArrivalTimeShift

        public double getEstimatedArrivalTimeShift()
        Gets shift for estimated arrive time.
        Returns:
        a value of time zone shift in minutes
        Since:
        100.0.0
      • getGeometry

        public Geometry getGeometry()
        Gets the geometry representing the maneuver, be it a turn or travelling in a straight line.

        Different types of geometry represent different types of maneuver; for example a polyline may represent continuing straight on, and a point may represent a stop.

        Returns:
        the geometry representing the maneuver
        Since:
        100.0.0
      • getManeuverMessages

        public List<DirectionMessage> getManeuverMessages()
        Gets the maneuver messages.
        Returns:
        an unmodifiable list of the maneuver messages
        Since:
        100.0.0
      • getManeuverType

        public DirectionManeuverType getManeuverType()
        Gets the maneuver type.
        Returns:
        the maneuver type
        Since:
        100.0.0
      • getFromLevel

        public int getFromLevel()
        Gets the from level value for a direction maneuver.

        This property provides a way to filter directions based on logical level division. For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels. This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the from level field, the property will be set to -1.

        Returns:
        the value of the logical level where the directions line starts, undefined value is -1
        Since:
        100.2.0
      • getToLevel

        public int getToLevel()
        Gets the to level value for a direction maneuver.

        This property provides a way to filter directions based on logical level division. For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels. This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the to level field, the property will be set to -1.

        Returns:
        the value of the logical level where the directions line ends, undefined value is -1
        Since:
        100.2.0
      • getLength

        public double getLength()
        Gets the length of this segment of the route in meters.
        Returns:
        the length in meters
        Since:
        100.0.0
      • getDuration

        public double getDuration()
        Gets the time this segment of the route will take to traverse in minutes.
        Returns:
        the duration in minutes
        Since:
        100.0.0