Package globus.glroute

Class GLRoute

  • @ParametersAreNonnullByDefault
public class GLRoute
extends globus.glmap.GLNativeObject
    GLMapRouteData used store route data.

    • Method Detail

      • CreateFromNativePtr

        public static GLRoute CreateFromNativePtr​(long nativePtr)

      • GetNativeFunctions

        public static long GetNativeFunctions()

      • ReleaseNativePtr

        public static void ReleaseNativePtr​(long nativePtr)

      • getNativePtr

        public long getNativePtr()

      • 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 globus.glmap.GLMapTrackData getTrackData​(int trackColor)
        Returns track data that can be used to display track of route
        Parameters:
        trackColor - color of route track
        Returns:
        track data of route

      • getTrackCoordinates

        @Nullable
public int[] getTrackCoordinates()
        Returns track coordinates in pairs (x, y) If track contains several lines - (-1, -1) split one segment from other
        Returns:
        track coordinates

      • 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

      • getNextManeuver

        @Nullable
public GLRouteManeuver getNextManeuver​(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​(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 last maneuver in route
        Returns:
        last 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

      • getServerResponse

        @NonNull
public java.lang.String getServerResponse()
        Returns server response string
        Returns:
        server response string

      • ParseServerResponse

        @Nullable
public static GLRoute ParseServerResponse​(java.lang.String serverResponse)
        Creates GLMapRouteData from string
        Parameters:
        serverResponse - string that was returned by GLMapRouteData#getServerResponse
        Returns:
        GLMapRouteData or null if data is invalid

      • findInsertionIndex

        public static int findInsertionIndex​(globus.glmap.MapPoint point,
                                     globus.glmap.MapPoint[] points)
        Finds index where given point must be inserted to array of reference points. It's used, for example, to add way point to route.
        Parameters:
        point - At input defines point to insert. At output contains point that is located on route.
        points - Array of reference points
        Returns:
        -1 if given point is too far from track.

      • getNextStreetNames

        @Nullable
public java.lang.String[] getNextStreetNames​(GLRouteManeuver maneuver)
        Parameters:
        maneuver - First maneuver to start search
        Returns:
        First non empty array of streetNames from given maneuver to the end of route