Package globus.glroute

Class GLRouteManeuver

  • public class GLRouteManeuver
extends globus.glmap.GLNativeObject
    GLMapRouteManeuver holds data for the route manuver

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  GLRouteManeuver.Type  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      globus.glmap.MapPoint getEndPoint()
      Start point of maneuver
      double getEqualLength​(GLRouteManeuver other)
      Calculates equal length with other maneuver
      double getLength()
      Maneuver length in meters
      globus.glmap.MapPoint getStartPoint()
      Start point of maneuver
      java.lang.String[] getStreetNames()
      List of street names that are consistent along the entire maneuver.
      double getTime()
      Estimated time along the maneuver in seconds.
      int getType()
      Type of the maneuver see https://github.com/valhalla/valhalla-docs/blob/master/api-reference.md for details
      java.lang.String getVerbalPostTransitionInstruction()
      Text suitable for use as a verbal message immediately after the maneuver transition.
      java.lang.String getVerbalPreTransitionInstruction()
      Text suitable for use as a verbal message immediately prior to the maneuver transition.
      java.lang.String getVerbalTransitionInstruction()
      Text suitable for use as a verbal alert in a navigation application.

      • Methods inherited from class globus.glmap.GLNativeObject

        dispose

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getType

        public int getType()
        Type of the maneuver see https://github.com/valhalla/valhalla-docs/blob/master/api-reference.md for details
        Returns:
        type of maneuver

      • getStreetNames

        @NonNull
public java.lang.String[] getStreetNames()
        List of street names that are consistent along the entire maneuver.
        Returns:
        array of street names

      • getLength

        public double getLength()
        Maneuver length in meters
        Returns:
        length in meters

      • getEqualLength

        public double getEqualLength​(GLRouteManeuver other)
        Calculates equal length with other maneuver
        Parameters:
        other - Other maneuver
        Returns:
        length of equal part in internal coordinates

      • getTime

        public double getTime()
        Estimated time along the maneuver in seconds.
        Returns:
        time in seconds

      • getVerbalPostTransitionInstruction

        @NonNull
public java.lang.String getVerbalPostTransitionInstruction()
        Text suitable for use as a verbal message immediately after the maneuver transition. For example "Continue on U.S. 2 22 for 3.9 miles".
        Returns:
        message after the maneuver transition.

      • getVerbalPreTransitionInstruction

        @NonNull
public java.lang.String getVerbalPreTransitionInstruction()
        Text suitable for use as a verbal message immediately prior to the maneuver transition. For example "Turn right onto North Prince Street, U.S. 2 22".
        Returns:
        message prior to the maneuver transition.

      • getVerbalTransitionInstruction

        @NonNull
public java.lang.String getVerbalTransitionInstruction()
        Text suitable for use as a verbal alert in a navigation application. The transition alert instruction will prepare the user for the forthcoming transition. For example: "Turn right onto North Prince Street".
        Returns:
        instruction for the transition.

      • getStartPoint

        @NonNull
public globus.glmap.MapPoint getStartPoint()
        Start point of maneuver
        Returns:
        start point of maneuver

      • getEndPoint

        @NonNull
public globus.glmap.MapPoint getEndPoint()
        Start point of maneuver
        Returns:
        start point of maneuver