Package globus.glroute

Class GLRouteManeuver

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

    • 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

      • 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

      • getInstruction

        @NonNull
public java.lang.String getInstruction​(int type)
        Get instruction
        Parameters:
        type - type of instruction
        Returns:
        instruction

      • getShortInstruction

        @NonNull
public java.lang.String getShortInstruction()
        Short instruction for UI. For example "Exit 3A → AZ 202 Loop East"
        Returns:
        short instruction

      • getTransitionInstruction

        @NonNull
public java.lang.String getTransitionInstruction()
        Text for use in UI. For example "Take exit 3A onto AZ 202 Loop East.".
        Returns:
        transition intruction

      • getVerbalPreTransitionInstruction

        @NonNull
public java.lang.String getVerbalPreTransitionInstruction()
        Text suitable for use as a verbal message immediately prior to the maneuver transition. For example "Take exit 3A onto Arizona 2 o2 Loop East.".
        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: "Take exit 3A.".
        Returns:
        instruction for the transition.

      • getVerbalPostTransitionInstruction

        @NonNull
public java.lang.String getVerbalPostTransitionInstruction()
        Text suitable for use as a verbal message immediately after the maneuver transition. For example "Continue for 1 kilometer.".
        Returns:
        message after the maneuver 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