Package globus.glroute

Class GLRoute

java.lang.Object
globus.glmap.GLNativeObject
globus.glroute.GLRoute
public class GLRoute extends GLNativeObject
GLRoute stores route data and exposes maneuvers, length, and duration.

  • Method Details

    • getNumberOfTargetPoints

      public int getNumberOfTargetPoints()
      Returns number of target points
      Returns:
      number of target points

    • getTargetPoint

      public GLRoutePoint getTargetPoint(int index)
      Returns target point
      Parameters:
      index - index of target point
      Returns:
      target point

    • getTrackData

      public GLMapTrackData getTrackData(int trackColor)
      Returns track data that can be used to display track of route
      Parameters:
      trackColor - color of route track (ARGB, 0xAARRGGBB)
      Returns:
      track data of route

    • getTrackCoordinates

      @Nullable public int[] getTrackCoordinates()
      Returns track coordinates as flattened pairs (x, y) in internal map coordinates.

      If the track contains multiple segments, (-1, -1) is used as a separator between segments.

      Returns:
      track coordinates, or null if no geometry is available

    • getLanguage

      @NonNull public String getLanguage()
      Returns language of instructions
      Returns:
      language of instructions

    • getLength

      public double getLength()
      Returns total length of the track
      Returns:
      length of the track in meters

    • getDuration

      public double getDuration()
      Returns estimated duration of the track
      Returns:
      duration of the track in seconds

    • getNumberOfLegs

      public int getNumberOfLegs()
      Returns number of legs
      Returns:
      number of legs

    • getLengthOfLeg

      public double getLengthOfLeg(int index)
      Returns length of leg
      Parameters:
      index - index of leg
      Returns:
      length of leg

    • getDurationOfLeg

      public double getDurationOfLeg(int index)
      Returns duration of leg
      Parameters:
      index - index of leg
      Returns:
      duration of leg

    • getManeuvers

      @NonNull public GLRouteManeuver[] getManeuvers()
      Returns all maneuvers of route
      Returns:
      array of maneuvers

    • getNextManeuver

      @Nullable public GLRouteManeuver getNextManeuver(@NonNull GLRouteManeuver maneuver)
      Returns next maneuver that goes after the given maneuver
      Parameters:
      maneuver - maneuver
      Returns:
      next maneuver after the given maneuver

    • getPreviousManeuver

      @Nullable public GLRouteManeuver getPreviousManeuver(@NonNull GLRouteManeuver maneuver)
      Returns previous maneuver that goes before the given maneuver
      Parameters:
      maneuver - maneuver
      Returns:
      previous maneuver after the given maneuver

    • getFirstManeuver

      @Nullable public GLRouteManeuver getFirstManeuver()
      Returns first maneuver in route
      Returns:
      first maneuver in route

    • getLastManeuver

      @Nullable public GLRouteManeuver getLastManeuver()
      Returns last maneuver in route
      Returns:
      last maneuver in route

    • getHeightData

      @Nullable public GLRouteElevation getHeightData()
      Returns height data that was previously requested for this route
      Returns:
      height data

    • getAlternates

      @NonNull public GLRoute[] getAlternates()
      Alternative routes
      Returns:
      alternative routes

    • ParseFromJSON

      @Nullable public static GLRoute ParseFromJSON(@NonNull String json)
      Creates GLRoute from a JSON string.
      Parameters:
      json - json string that was returned by GLRoute#toJSON
      Returns:
      GLRoute or null if data is invalid

    • toJSON

      public String toJSON()
      Serializes route to JSON.
      Returns:
      json string

    • serializeToJSON

      public static String serializeToJSON(GLRoute[] routes)
      Serializes routes to JSON. Routes after the first will become alternatives.
      Parameters:
      routes - routes to serialize
      Returns:
      json string

    • findInsertionIndex

      public static int findInsertionIndex(@NonNull MapPoint pt, @NonNull MapPoint[] points)
      Finds the index where the given point should be inserted into an array of reference points.

      This is commonly used to add a waypoint to a route.

      Parameters:
      pt - At input, the point to insert. At output, the point adjusted to the nearest position on the route.
      points - An array of reference points that define the route.
      Returns:
      The index where the point should be inserted, or -1 if the point is too far from the track.

    • getNextShortInstruction

      @Nullable public String getNextShortInstruction(@NonNull GLRouteManeuver maneuver)
      Retrieves the first non-empty short instruction starting from the specified maneuver to the end of the route.
      Parameters:
      maneuver - The starting GLRouteManeuver for the search.
      Returns:
      The first non-empty short instruction, or null if no such instruction exists.

    • getApproachAlert

      @Nullable public String getApproachAlert(@NonNull String instruction, double distance)
      Prepends a distance alert (for example, "In 200 m …") to an instruction.
      Parameters:
      instruction - Instruction text
      distance - distance in meters
      Returns:
      instruction with approach alert, or null if the instruction cannot be formatted