Interface RouteNavigator

  • All Known Implementing Classes:
    RouteNavigator.CppProxy

    public interface RouteNavigator
    Interface allowing to access altering information about the route being navigated.
    • Method Detail

      • isNavigationActive

        boolean isNavigationActive()
        Indicates whether a route is loaded into the navigator.
      • getRoute

        Route getRoute()
        Returns the route loaded into the navigator if available or 'null' otherwise.
      • isNavigationPaused

        boolean isNavigationPaused()
        Indicates whether the route navigation is paused.
      • getOnRouteState

        OnRouteState getOnRouteState()
        Returns OnRouteState for the route being navigated if available. Returns OnRouteState.Undefined if no route is loaded into the navigator.
      • hasReachedDestination

        boolean hasReachedDestination()
        Indicates whether the route destination was reached. Returns 'false' if no route is loaded into the navigator.
      • getRemainingWaypoints

        java.util.ArrayList<RoutePlanPoint> getRemainingWaypoints()
        Returns the remaining waypoint list if route is loaded into the navigator or 'null' otherwise.
      • getNextDirection

        Direction getNextDirection()
        Returns the next direction info for the route loaded into the navigator. Returns 'null' if no next direction info is available (i.e. GPS position is missing etc.) or no route is loaded into the navigator.
      • getDistanceToNextDirectionInMeters

        int getDistanceToNextDirectionInMeters()
        Returns the distance to the next direction for the route loaded into the navigator. Returns -1 if the distance is unavailable (i.e. GPS position is missing etc.) or no route is loaded into the navigator.
      • getPositionOnRoute

        PositionOnRoute getPositionOnRoute()
        Returns the current position on the route loaded into the navigator. Returns 'null' if no current position is available (i.e. GPS position is missing etc.) or no route is loaded into the navigator.
      • getRouteVisualizationSettings

        RouteVisualizationSettings getRouteVisualizationSettings()
        Specifies route visualization settings to be used to generate route visualizer requests.
      • setRouteVisualizationSettings

        void setRouteVisualizationSettings​(RouteVisualizationSettings settings)
        Specifies route visualization settings to be used to generate route visualizer requests.
      • getRouteVisualizerRequest

        RouteVisualizerRequest getRouteVisualizerRequest()
        A route visualizer request which needs to be performed to display the current route navigator state on map.
      • getGuidanceSettings

        GuidanceSettings getGuidanceSettings()
        Returns guidance module settings.
      • getMaxServerRoutesSnappingDistanceInMeters

        int getMaxServerRoutesSnappingDistanceInMeters()
        Defines the maximal distance of server routes snapping if automatic rerouting or rerouting by traffic occurs. For more information see RouteCalculationOptions.setMaxServerRoutesSnappingDistanceInMeters method in RouteCalculationOptions class. If zero value is specified, the default value of maxServerRoutesSnappingDistanceInMeters property of RouteCalculationOptions is used. Default value is 0.
      • setMaxServerRoutesSnappingDistanceInMeters

        void setMaxServerRoutesSnappingDistanceInMeters​(int distanceInMeters)
        Defines the maximal distance of server routes snapping if automatic rerouting or rerouting by traffic occurs. For more information see RouteCalculationOptions.setMaxServerRoutesSnappingDistanceInMeters method in RouteCalculationOptions class. If zero value is specified, the default value of maxServerRoutesSnappingDistanceInMeters property of RouteCalculationOptions is used. Default value is 0.
      • getReroutingSettings

        ReroutingSettings getReroutingSettings()
        Specifies settings to be used during automatic rerouting handling.
      • setReroutingSettings

        void setReroutingSettings​(ReroutingSettings settings)
        Specifies settings to be used during automatic rerouting handling.
      • getReroutingEnabled

        boolean getReroutingEnabled()
        Specifies whether automatic rerouting handling is enabled. Default value is 'true'.
      • setReroutingEnabled

        void setReroutingEnabled​(boolean reroutingEnabled)
        Specifies whether automatic rerouting handling is enabled.
      • getReroutingByTrafficEnabled

        boolean getReroutingByTrafficEnabled()
        Specifies whether automatic rerouting by traffic is enabled. Default value is 'true'.
      • setReroutingByTrafficEnabled

        void setReroutingByTrafficEnabled​(boolean reroutingByTrafficEnabled)
        Specifies whether automatic rerouting by traffic is enabled.
      • startNavigatingTheRoute

        void startNavigatingTheRoute​(Route route,
                                     boolean isCalculatedFromCurrentPosition)
        Loads a route into the navigator.
        Parameters:
        route - A route for navigation.
        isCalculatedFromCurrentPosition - Specifies whether the first point of the passed route should be treated as current position. Passing TRUE specifies that if, after passing the route to the navigator, the real current device position notably differs from the first point of the route, the first point of the route will be removed and the route will be recalculated from the real current device position. All other route plan points will remain unchanged. Passing FALSE on the other hand behaves differently depending on the method used to obtain the route. If the route was obtained using calculateRoute(ArrayList, RouteCalculationOptions, RouteCalculationListener) or snapRoute(ExternalRoute, SnappingOptions, RouteCalculationListener) methods of RoutingManager, passing FALSE may cause calculation of additional route leg from the current device position to the first point of the passed route, if the first route point notably differs from the current device position. If the route was obtained using snapRouteFromPosition(ExternalRoutePoint, ExternalRoute, SnappingOptions, RouteCalculationListener) method of RoutingManager, passing FALSE will have no effect and the route will be treated as calculated from current position.
      • stopNavigation

        void stopNavigation()
        Stops navigating the route previously loaded into the navigator.
      • pauseNavigation

        void pauseNavigation()
        Tells the navigator to pause the route navigation. The route navigation stays paused until resumeNavigation method is called. While route navigation is paused, position on current route (if one is available) is NOT updated and you don't get any listeners called as well.
      • resumeNavigation

        void resumeNavigation()
        Tells the navigator to resume the route navigation.
      • addOnRouteStateChangedListener

        void addOnRouteStateChangedListener​(OnRouteStateChangedListener listener)
        Adds OnRouteState listener.
        Parameters:
        listener - Listener to add.
      • removeOnRouteStateChangedListener

        void removeOnRouteStateChangedListener​(OnRouteStateChangedListener listener)
        Removes OnRouteState listener.
        Parameters:
        listener - Listener to remove.
      • addDestinationReachedListener

        void addDestinationReachedListener​(DestinationReachedListener listener)
        Adds destination reached listener.
        Parameters:
        listener - Listener to add.
      • removeDestinationReachedListener

        void removeDestinationReachedListener​(DestinationReachedListener listener)
        Removes destination reached listener.
        Parameters:
        listener - Listener to remove.
      • addWaypointsPassedListener

        void addWaypointsPassedListener​(WaypointsPassedListener listener)
        Adds waypoints passed listener.
        Parameters:
        listener - Listener to add.
      • removeWaypointsPassedListener

        void removeWaypointsPassedListener​(WaypointsPassedListener listener)
        Removes waypoints passed listener.
        Parameters:
        listener - Listener to remove.
      • addNextDirectionChangedListener

        void addNextDirectionChangedListener​(NextDirectionChangedListener listener)
        Adds next direction changed listener.
        Parameters:
        listener - Listener to add.
      • removeNextDirectionChangedListener

        void removeNextDirectionChangedListener​(NextDirectionChangedListener listener)
        Removes next direction changed listener.
        Parameters:
        listener - Listener to remove.
      • addDistanceToNextDirectionChangedListener

        void addDistanceToNextDirectionChangedListener​(DistanceToNextDirectionChangedListener listener)
        Adds distance to next direction changed listener.
        Parameters:
        listener - Listener to add.
      • removeDistanceToNextDirectionChangedListener

        void removeDistanceToNextDirectionChangedListener​(DistanceToNextDirectionChangedListener listener)
        Removes distance to next direction changed listener.
        Parameters:
        listener - Listener to remove.
      • addPositionOnRouteChangedListener

        void addPositionOnRouteChangedListener​(PositionOnRouteChangedListener listener)
        Adds position on route changed listener.
        Parameters:
        listener - Listener to add.
      • removePositionOnRouteChangedListener

        void removePositionOnRouteChangedListener​(PositionOnRouteChangedListener listener)
        Removes position on route changed listener.
        Parameters:
        listener - Listener to remove.
      • addNavigationInfoChangedListener

        void addNavigationInfoChangedListener​(NavigationInfoChangedListener listener)
        Adds navigation info changed listener.
        Parameters:
        listener - Listener to add.
      • removeNavigationInfoChangedListener

        void removeNavigationInfoChangedListener​(NavigationInfoChangedListener listener)
        Removes navigation info changed listener.
        Parameters:
        listener - Listener to remove.
      • addRouteVisualizerRequestListener

        void addRouteVisualizerRequestListener​(RouteVisualizerRequestListener listener)
        Adds route visualizer request listener.
        Parameters:
        listener - Listener to add.
      • removeRouteVisualizerRequestListener

        void removeRouteVisualizerRequestListener​(RouteVisualizerRequestListener listener)
        Removes route visualizer request listener.
        Parameters:
        listener - Listener to remove.
      • addGuidanceListener

        void addGuidanceListener​(GuidanceListener listener)
        Adds route navigation listener.
        Parameters:
        listener - Listener to add.
      • removeGuidanceListener

        void removeGuidanceListener​(GuidanceListener listener)
        Removes route navigation listener.
        Parameters:
        listener - Listener to remove.
      • addReroutingListener

        void addReroutingListener​(ReroutingListener listener)
        Adds rerouting events listener.
        Parameters:
        listener - Listener to add.
      • removeReroutingListener

        void removeReroutingListener​(ReroutingListener listener)
        Removes rerouting events listener.
        Parameters:
        listener - Listener to remove.
      • addReroutingByTrafficListener

        void addReroutingByTrafficListener​(ReroutingByTrafficListener listener)
        Adds rerouting by traffic events listener.
        Parameters:
        listener - Listener to add.
      • removeReroutingByTrafficListener

        void removeReroutingByTrafficListener​(ReroutingByTrafficListener listener)
        Removes rerouting by traffic events listener.
        Parameters:
        listener - Listener to remove.