Package com.navmii.sdk.routenavigation

Class RouteNavigator.CppProxy

java.lang.Object

com.navmii.sdk.routenavigation.RouteNavigator.CppProxy

All Implemented Interfaces:

RouteNavigator

Enclosing interface:

RouteNavigator

public static final class RouteNavigator.CppProxy
extends java.lang.Object
implements RouteNavigator

Nested Class Summary

Nested classes/interfaces inherited from interface com.navmii.sdk.routenavigation.RouteNavigator

RouteNavigator.CppProxy

Method Summary

Modifier and Type	Method	Description
void	_djinni_private_destroy()
void	addDestinationReachedListener(DestinationReachedListener listener)	Adds destination reached listener.
void	addDistanceToNextDirectionChangedListener(DistanceToNextDirectionChangedListener listener)	Adds distance to next direction changed listener.
void	addGuidanceListener(GuidanceListener listener)	Adds route navigation listener.
void	addNavigationInfoChangedListener(NavigationInfoChangedListener listener)	Adds navigation info changed listener.
void	addNextDirectionChangedListener(NextDirectionChangedListener listener)	Adds next direction changed listener.
void	addOnRouteStateChangedListener(OnRouteStateChangedListener listener)	Adds OnRouteState listener.
void	addPositionOnRouteChangedListener(PositionOnRouteChangedListener listener)	Adds position on route changed listener.
void	addReroutingByTrafficListener(ReroutingByTrafficListener listener)	Adds rerouting by traffic events listener.
void	addReroutingListener(ReroutingListener listener)	Adds rerouting events listener.
void	addRouteVisualizerRequestListener(RouteVisualizerRequestListener listener)	Adds route visualizer request listener.
void	addWaypointsPassedListener(WaypointsPassedListener listener)	Adds waypoints passed listener.
int	getDistanceToNextDirectionInMeters()	Returns the distance to the next direction for the route loaded into the navigator.
GuidanceSettings	getGuidanceSettings()	Returns guidance module settings.
int	getMaxServerRoutesSnappingDistanceInMeters()	Defines the maximal distance of server routes snapping if automatic rerouting or rerouting by traffic occurs.
Direction	getNextDirection()	Returns the next direction info for the route loaded into the navigator.
OnRouteState	getOnRouteState()	Returns OnRouteState for the route being navigated if available.
PositionOnRoute	getPositionOnRoute()	Returns the current position on the route loaded into the navigator.
java.util.ArrayList<RoutePlanPoint>	getRemainingWaypoints()	Returns the remaining waypoint list if route is loaded into the navigator or 'null' otherwise.
boolean	getReroutingByTrafficEnabled()	Specifies whether automatic rerouting by traffic is enabled.
boolean	getReroutingEnabled()	Specifies whether automatic rerouting handling is enabled.
ReroutingSettings	getReroutingSettings()	Specifies settings to be used during automatic rerouting handling.
Route	getRoute()	Returns the route loaded into the navigator if available or 'null' otherwise.
RouteVisualizationSettings	getRouteVisualizationSettings()	Specifies route visualization settings to be used to generate route visualizer requests.
RouteVisualizerRequest	getRouteVisualizerRequest()	A route visualizer request which needs to be performed to display the current route navigator state on map.
boolean	hasReachedDestination()	Indicates whether the route destination was reached.
boolean	isNavigationActive()	Indicates whether a route is loaded into the navigator.
boolean	isNavigationPaused()	Indicates whether the route navigation is paused.
void	pauseNavigation()	Tells the navigator to pause the route navigation.
void	removeDestinationReachedListener(DestinationReachedListener listener)	Removes destination reached listener.
void	removeDistanceToNextDirectionChangedListener(DistanceToNextDirectionChangedListener listener)	Removes distance to next direction changed listener.
void	removeGuidanceListener(GuidanceListener listener)	Removes route navigation listener.
void	removeNavigationInfoChangedListener(NavigationInfoChangedListener listener)	Removes navigation info changed listener.
void	removeNextDirectionChangedListener(NextDirectionChangedListener listener)	Removes next direction changed listener.
void	removeOnRouteStateChangedListener(OnRouteStateChangedListener listener)	Removes OnRouteState listener.
void	removePositionOnRouteChangedListener(PositionOnRouteChangedListener listener)	Removes position on route changed listener.
void	removeReroutingByTrafficListener(ReroutingByTrafficListener listener)	Removes rerouting by traffic events listener.
void	removeReroutingListener(ReroutingListener listener)	Removes rerouting events listener.
void	removeRouteVisualizerRequestListener(RouteVisualizerRequestListener listener)	Removes route visualizer request listener.
void	removeWaypointsPassedListener(WaypointsPassedListener listener)	Removes waypoints passed listener.
void	resumeNavigation()	Tells the navigator to resume the route navigation.
void	setMaxServerRoutesSnappingDistanceInMeters(int distanceInMeters)	Defines the maximal distance of server routes snapping if automatic rerouting or rerouting by traffic occurs.
void	setReroutingByTrafficEnabled(boolean reroutingByTrafficEnabled)	Specifies whether automatic rerouting by traffic is enabled.
void	setReroutingEnabled(boolean reroutingEnabled)	Specifies whether automatic rerouting handling is enabled.
void	setReroutingSettings(ReroutingSettings settings)	Specifies settings to be used during automatic rerouting handling.
void	setRouteVisualizationSettings(RouteVisualizationSettings settings)	Specifies route visualization settings to be used to generate route visualizer requests.
void	startNavigatingTheRoute(Route route, boolean isCalculatedFromCurrentPosition)	Loads a route into the navigator.
void	stopNavigation()	Stops navigating the route previously loaded into the navigator.

Methods inherited from class java.lang.Object

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

Method Details

_djinni_private_destroy

public void _djinni_private_destroy()

isNavigationActive

public boolean isNavigationActive()

Description copied from interface: RouteNavigator

Indicates whether a route is loaded into the navigator.

Specified by:

isNavigationActive in interface RouteNavigator

getRoute

public Route getRoute()

Description copied from interface: RouteNavigator

Returns the route loaded into the navigator if available or 'null' otherwise.

Specified by:

getRoute in interface RouteNavigator

isNavigationPaused

public boolean isNavigationPaused()

Description copied from interface: RouteNavigator

Indicates whether the route navigation is paused.

Specified by:

isNavigationPaused in interface RouteNavigator

getOnRouteState

public OnRouteState getOnRouteState()

Description copied from interface: RouteNavigator

Returns OnRouteState for the route being navigated if available. Returns OnRouteState.Undefined if no route is loaded into the navigator.

Specified by:

getOnRouteState in interface RouteNavigator

hasReachedDestination

public boolean hasReachedDestination()

Description copied from interface: RouteNavigator

Indicates whether the route destination was reached. Returns 'false' if no route is loaded into the navigator.

Specified by:

hasReachedDestination in interface RouteNavigator

getRemainingWaypoints

public java.util.ArrayList<RoutePlanPoint> getRemainingWaypoints()

Description copied from interface: RouteNavigator

Returns the remaining waypoint list if route is loaded into the navigator or 'null' otherwise.

Specified by:

getRemainingWaypoints in interface RouteNavigator

getNextDirection

public Direction getNextDirection()

Description copied from interface: RouteNavigator

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.

Specified by:

getNextDirection in interface RouteNavigator

getDistanceToNextDirectionInMeters

public int getDistanceToNextDirectionInMeters()

Description copied from interface: RouteNavigator

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.

Specified by:

getDistanceToNextDirectionInMeters in interface RouteNavigator

getPositionOnRoute

public PositionOnRoute getPositionOnRoute()

Description copied from interface: RouteNavigator

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.

Specified by:

getPositionOnRoute in interface RouteNavigator

getRouteVisualizationSettings

public RouteVisualizationSettings getRouteVisualizationSettings()

Description copied from interface: RouteNavigator

Specifies route visualization settings to be used to generate route visualizer requests.

Specified by:

getRouteVisualizationSettings in interface RouteNavigator

setRouteVisualizationSettings

public void setRouteVisualizationSettings(RouteVisualizationSettings settings)

Description copied from interface: RouteNavigator

Specifies route visualization settings to be used to generate route visualizer requests.

Specified by:

setRouteVisualizationSettings in interface RouteNavigator

getRouteVisualizerRequest

public RouteVisualizerRequest getRouteVisualizerRequest()

Description copied from interface: RouteNavigator

A route visualizer request which needs to be performed to display the current route navigator state on map.

Specified by:

getRouteVisualizerRequest in interface RouteNavigator

getGuidanceSettings

public GuidanceSettings getGuidanceSettings()

Description copied from interface: RouteNavigator

Returns guidance module settings.

Specified by:

getGuidanceSettings in interface RouteNavigator

getMaxServerRoutesSnappingDistanceInMeters

public int getMaxServerRoutesSnappingDistanceInMeters()

Description copied from interface: RouteNavigator

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.

Specified by:

getMaxServerRoutesSnappingDistanceInMeters in interface RouteNavigator

setMaxServerRoutesSnappingDistanceInMeters

public void setMaxServerRoutesSnappingDistanceInMeters(int distanceInMeters)

Description copied from interface: RouteNavigator

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.

Specified by:

setMaxServerRoutesSnappingDistanceInMeters in interface RouteNavigator

getReroutingSettings

public ReroutingSettings getReroutingSettings()

Description copied from interface: RouteNavigator

Specifies settings to be used during automatic rerouting handling.

Specified by:

getReroutingSettings in interface RouteNavigator

setReroutingSettings

public void setReroutingSettings(ReroutingSettings settings)

Description copied from interface: RouteNavigator

Specifies settings to be used during automatic rerouting handling.

Specified by:

setReroutingSettings in interface RouteNavigator

getReroutingEnabled

public boolean getReroutingEnabled()

Description copied from interface: RouteNavigator

Specifies whether automatic rerouting handling is enabled. Default value is 'true'.

Specified by:

getReroutingEnabled in interface RouteNavigator

setReroutingEnabled

public void setReroutingEnabled(boolean reroutingEnabled)

Description copied from interface: RouteNavigator

Specifies whether automatic rerouting handling is enabled.

Specified by:

setReroutingEnabled in interface RouteNavigator

getReroutingByTrafficEnabled

public boolean getReroutingByTrafficEnabled()

Description copied from interface: RouteNavigator

Specifies whether automatic rerouting by traffic is enabled. Default value is 'true'.

Specified by:

getReroutingByTrafficEnabled in interface RouteNavigator

setReroutingByTrafficEnabled

public void setReroutingByTrafficEnabled(boolean reroutingByTrafficEnabled)

Description copied from interface: RouteNavigator

Specifies whether automatic rerouting by traffic is enabled.

Specified by:

setReroutingByTrafficEnabled in interface RouteNavigator

startNavigatingTheRoute

public void startNavigatingTheRoute(Route route, boolean isCalculatedFromCurrentPosition)

Description copied from interface: RouteNavigator

Loads a route into the navigator.

Specified by:

startNavigatingTheRoute in interface RouteNavigator

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

public void stopNavigation()

Description copied from interface: RouteNavigator

Stops navigating the route previously loaded into the navigator.

Specified by:

stopNavigation in interface RouteNavigator

pauseNavigation

public void pauseNavigation()

Description copied from interface: RouteNavigator

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.

Specified by:

pauseNavigation in interface RouteNavigator

resumeNavigation

public void resumeNavigation()

Description copied from interface: RouteNavigator

Tells the navigator to resume the route navigation.

Specified by:

resumeNavigation in interface RouteNavigator

addOnRouteStateChangedListener

public void addOnRouteStateChangedListener(OnRouteStateChangedListener listener)

Description copied from interface: RouteNavigator

Adds OnRouteState listener.

Specified by:

addOnRouteStateChangedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeOnRouteStateChangedListener

public void removeOnRouteStateChangedListener(OnRouteStateChangedListener listener)

Description copied from interface: RouteNavigator

Removes OnRouteState listener.

Specified by:

removeOnRouteStateChangedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addDestinationReachedListener

public void addDestinationReachedListener(DestinationReachedListener listener)

Description copied from interface: RouteNavigator

Adds destination reached listener.

Specified by:

addDestinationReachedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeDestinationReachedListener

public void removeDestinationReachedListener(DestinationReachedListener listener)

Description copied from interface: RouteNavigator

Removes destination reached listener.

Specified by:

removeDestinationReachedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addWaypointsPassedListener

public void addWaypointsPassedListener(WaypointsPassedListener listener)

Description copied from interface: RouteNavigator

Adds waypoints passed listener.

Specified by:

addWaypointsPassedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeWaypointsPassedListener

public void removeWaypointsPassedListener(WaypointsPassedListener listener)

Description copied from interface: RouteNavigator

Removes waypoints passed listener.

Specified by:

removeWaypointsPassedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addNextDirectionChangedListener

public void addNextDirectionChangedListener(NextDirectionChangedListener listener)

Description copied from interface: RouteNavigator

Adds next direction changed listener.

Specified by:

addNextDirectionChangedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeNextDirectionChangedListener

public void removeNextDirectionChangedListener(NextDirectionChangedListener listener)

Description copied from interface: RouteNavigator

Removes next direction changed listener.

Specified by:

removeNextDirectionChangedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addDistanceToNextDirectionChangedListener

public void addDistanceToNextDirectionChangedListener(DistanceToNextDirectionChangedListener listener)

Description copied from interface: RouteNavigator

Adds distance to next direction changed listener.

Specified by:

addDistanceToNextDirectionChangedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeDistanceToNextDirectionChangedListener

public void removeDistanceToNextDirectionChangedListener(DistanceToNextDirectionChangedListener listener)

Description copied from interface: RouteNavigator

Removes distance to next direction changed listener.

Specified by:

removeDistanceToNextDirectionChangedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addPositionOnRouteChangedListener

public void addPositionOnRouteChangedListener(PositionOnRouteChangedListener listener)

Description copied from interface: RouteNavigator

Adds position on route changed listener.

Specified by:

addPositionOnRouteChangedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removePositionOnRouteChangedListener

public void removePositionOnRouteChangedListener(PositionOnRouteChangedListener listener)

Description copied from interface: RouteNavigator

Removes position on route changed listener.

Specified by:

removePositionOnRouteChangedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addNavigationInfoChangedListener

public void addNavigationInfoChangedListener(NavigationInfoChangedListener listener)

Description copied from interface: RouteNavigator

Adds navigation info changed listener.

Specified by:

addNavigationInfoChangedListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeNavigationInfoChangedListener

public void removeNavigationInfoChangedListener(NavigationInfoChangedListener listener)

Description copied from interface: RouteNavigator

Removes navigation info changed listener.

Specified by:

removeNavigationInfoChangedListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addRouteVisualizerRequestListener

public void addRouteVisualizerRequestListener(RouteVisualizerRequestListener listener)

Description copied from interface: RouteNavigator

Adds route visualizer request listener.

Specified by:

addRouteVisualizerRequestListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeRouteVisualizerRequestListener

public void removeRouteVisualizerRequestListener(RouteVisualizerRequestListener listener)

Description copied from interface: RouteNavigator

Removes route visualizer request listener.

Specified by:

removeRouteVisualizerRequestListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addGuidanceListener

public void addGuidanceListener(GuidanceListener listener)

Description copied from interface: RouteNavigator

Adds route navigation listener.

Specified by:

addGuidanceListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeGuidanceListener

public void removeGuidanceListener(GuidanceListener listener)

Description copied from interface: RouteNavigator

Removes route navigation listener.

Specified by:

removeGuidanceListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addReroutingListener

public void addReroutingListener(ReroutingListener listener)

Description copied from interface: RouteNavigator

Adds rerouting events listener.

Specified by:

addReroutingListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeReroutingListener

public void removeReroutingListener(ReroutingListener listener)

Description copied from interface: RouteNavigator

Removes rerouting events listener.

Specified by:

removeReroutingListener in interface RouteNavigator

Parameters:

listener - Listener to remove.

addReroutingByTrafficListener

public void addReroutingByTrafficListener(ReroutingByTrafficListener listener)

Description copied from interface: RouteNavigator

Adds rerouting by traffic events listener.

Specified by:

addReroutingByTrafficListener in interface RouteNavigator

Parameters:

listener - Listener to add.

removeReroutingByTrafficListener

public void removeReroutingByTrafficListener(ReroutingByTrafficListener listener)

Description copied from interface: RouteNavigator

Removes rerouting by traffic events listener.

Specified by:

removeReroutingByTrafficListener in interface RouteNavigator

Parameters:

listener - Listener to remove.