com.atakmap.android.routes

Class RouteNavigator

java.lang.Object

com.atakmap.android.routes.RouteNavigator

public class RouteNavigator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouteNavigator.RouteNavigatorListener Interface allowing key navigation events to be listened for.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAV_TO_NEXT_INTENT
static java.lang.String	NAV_TO_PREV_INTENT
static java.lang.String	QUIT_NAV_INTENT
static java.lang.String	TAG

Method Summary

Modifier and Type	Method and Description
static int	getBubbleRadius(Route.RouteMethod routeMethod, android.content.SharedPreferences prefs, boolean forOffRoute)
static RouteNavigator	getInstance() Obtain the current instantiation of the route navigator that can be used to register a callback listener.
MapView	getMapView()
MapGroup	getNavGroup()
RouteNavigationManager	getNavManager()
static PointMapItem	getNextWaypoint(PointMapItem pmi, double range, MapView mapView, android.content.SharedPreferences prefs) Get the next waypoint marker in the route, if applicable
Route	getRoute()
boolean	isNavigating()
void	registerRouteNavigatorListener(RouteNavigator.RouteNavigatorListener listener) Registers a route navigation listener
boolean	startNavigating(Route route, int startingIndex)
void	stopNavigating() Cleans up just the internal aspects of navigating
void	unregisterRouteNavigatorListener(RouteNavigator.RouteNavigatorListener listener) Unregisters a route navigation listener
boolean	updateNavigation(Route updatedRoute) Updates the navigator to begin navigating a different route in place without tearing down all of the UI navigation components.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

NAV_TO_NEXT_INTENT

public static final java.lang.String NAV_TO_NEXT_INTENT

See Also:

Constant Field Values

NAV_TO_PREV_INTENT

public static final java.lang.String NAV_TO_PREV_INTENT

See Also:

Constant Field Values

QUIT_NAV_INTENT

public static final java.lang.String QUIT_NAV_INTENT

See Also:

Constant Field Values

Method Detail

isNavigating

public boolean isNavigating()

getRoute

public Route getRoute()

getNavGroup

public MapGroup getNavGroup()

getMapView

public MapView getMapView()

getNavManager

public RouteNavigationManager getNavManager()

getInstance

public static RouteNavigator getInstance()

Obtain the current instantiation of the route navigator that can be used to register a callback listener.

updateNavigation

public boolean updateNavigation(Route updatedRoute)

Updates the navigator to begin navigating a different route in place without tearing down all of the UI navigation components.

Parameters:

updatedRoute - New route to navigate

Returns:

true if able to update navigation successfully

startNavigating

public boolean startNavigating(Route route,
                               int startingIndex)

stopNavigating

public void stopNavigating()

Cleans up just the internal aspects of navigating

getBubbleRadius

public static int getBubbleRadius(Route.RouteMethod routeMethod,
                                  android.content.SharedPreferences prefs,
                                  boolean forOffRoute)

getNextWaypoint

public static PointMapItem getNextWaypoint(PointMapItem pmi,
                                           double range,
                                           MapView mapView,
                                           android.content.SharedPreferences prefs)

Get the next waypoint marker in the route, if applicable

Parameters:

pmi - Waypoint item

range - Range from src marker to target waypoint

mapView - Map view instance

prefs - Shared preferences

Returns:

Next waypoint marker or null if N/A

registerRouteNavigatorListener

public void registerRouteNavigatorListener(RouteNavigator.RouteNavigatorListener listener)

Registers a route navigation listener

Parameters:

listener - the listener fired during route navigation

unregisterRouteNavigatorListener

public void unregisterRouteNavigatorListener(RouteNavigator.RouteNavigatorListener listener)

Unregisters a route navigation listener

Parameters:

listener - the listener fired during route navigation