com.atakmap.android.routes.nav

Class ObjectivePairingService

java.lang.Object

com.atakmap.android.routes.nav.ObjectivePairingService

All Implemented Interfaces:

RouteNavigationManager.RouteNavigationManagerEventListener, RouteNavigator.RouteNavigatorListener

public class ObjectivePairingService
extends java.lang.Object
implements RouteNavigator.RouteNavigatorListener, RouteNavigationManager.RouteNavigationManagerEventListener

This class is responsible for drawing a line from the user to their current objective.

Constructor Summary

Constructors

Constructor and Description
ObjectivePairingService()

Method Summary

Modifier and Type	Method and Description
void	onArrivedAtPoint(RouteNavigationManager routeNavigationManager, PointMapItem item) Indicates that the user has arrived at a point (i.e.
void	onDepartedPoint(RouteNavigationManager routeNavigationManager, PointMapItem item) Indicates that the user has departed a point (i.e.
void	onGpsStatusChanged(RouteNavigationManager routeNavigationManager, boolean found) RouteNavigatorListener Interface Implementation
void	onLocationChanged(RouteNavigationManager routeNavigationManager, GeoPoint oldLocation, GeoPoint newLocation) Indicates the location has changed.
void	onNavigationObjectiveChanged(RouteNavigationManager routeNavigationManager, PointMapItem newObjective, boolean isFromRouteProgression) Indicates that the navigation objective has changed.
void	onNavigationStarted(RouteNavigator navigator, Route route) Fires when navigation has started.
void	onNavigationStarting(RouteNavigator navigator) RouteNavigatorListener Interface Implementation
void	onNavigationStopped(RouteNavigator navigator) Fires after navigation has been stopped.
void	onNavigationStopping(RouteNavigator navigator, Route route) Fires when navigation is stopping.
void	onOffRoute(RouteNavigationManager routeNavigationManager) Indicates that the user has gone off route (Note: Only fired the first time the user has gone off route, not continuously).
void	onReturnedToRoute(RouteNavigationManager routeNavigationManager) Indicates that the user has returned to the route.
void	onTriggerEntered(RouteNavigationManager routeNavigationManager, PointMapItem item, int triggerIndex) Indicates that a navigation trigger has been entered.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectivePairingService

public ObjectivePairingService()

Method Detail

onNavigationStarting

public void onNavigationStarting(RouteNavigator navigator)

RouteNavigatorListener Interface Implementation

Specified by:

onNavigationStarting in interface RouteNavigator.RouteNavigatorListener

onNavigationStarted

public void onNavigationStarted(RouteNavigator navigator,
                                Route route)

Description copied from interface: RouteNavigator.RouteNavigatorListener

Fires when navigation has started.

Specified by:

onNavigationStarted in interface RouteNavigator.RouteNavigatorListener

onNavigationStopping

public void onNavigationStopping(RouteNavigator navigator,
                                 Route route)

Description copied from interface: RouteNavigator.RouteNavigatorListener

Fires when navigation is stopping.

Specified by:

onNavigationStopping in interface RouteNavigator.RouteNavigatorListener

onNavigationStopped

public void onNavigationStopped(RouteNavigator navigator)

Description copied from interface: RouteNavigator.RouteNavigatorListener

Fires after navigation has been stopped.

Specified by:

onNavigationStopped in interface RouteNavigator.RouteNavigatorListener

onGpsStatusChanged

public void onGpsStatusChanged(RouteNavigationManager routeNavigationManager,
                               boolean found)

RouteNavigatorListener Interface Implementation

Specified by:

onGpsStatusChanged in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

found - if the gps is found or false if it has been lost.

onLocationChanged

public void onLocationChanged(RouteNavigationManager routeNavigationManager,
                              GeoPoint oldLocation,
                              GeoPoint newLocation)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates the location has changed.

Specified by:

onLocationChanged in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

oldLocation - The previous location.

newLocation - The new location.

onNavigationObjectiveChanged

public void onNavigationObjectiveChanged(RouteNavigationManager routeNavigationManager,
                                         PointMapItem newObjective,
                                         boolean isFromRouteProgression)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that the navigation objective has changed.

Specified by:

onNavigationObjectiveChanged in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

newObjective - The new navigation objective.

isFromRouteProgression - Indicates whether the event was raised due to natural route progression (e.g. the previous checkpoint was hit), or from manual intervention (e.g. the user skipped to this checkpoint).

onOffRoute

public void onOffRoute(RouteNavigationManager routeNavigationManager)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that the user has gone off route (Note: Only fired the first time the user has gone off route, not continuously).

Specified by:

onOffRoute in interface RouteNavigationManager.RouteNavigationManagerEventListener

onReturnedToRoute

public void onReturnedToRoute(RouteNavigationManager routeNavigationManager)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that the user has returned to the route.

Specified by:

onReturnedToRoute in interface RouteNavigationManager.RouteNavigationManagerEventListener

onTriggerEntered

public void onTriggerEntered(RouteNavigationManager routeNavigationManager,
                             PointMapItem item,
                             int triggerIndex)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that a navigation trigger has been entered.

Specified by:

onTriggerEntered in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

item - The PointMapItem that's trigger has been entered.

triggerIndex - The index of the PointMapItem.

onArrivedAtPoint

public void onArrivedAtPoint(RouteNavigationManager routeNavigationManager,
                             PointMapItem item)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that the user has arrived at a point (i.e. they have entered the bubble radius of a particular point).

Specified by:

onArrivedAtPoint in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

item - The item at which the user has arrived at.

onDepartedPoint

public void onDepartedPoint(RouteNavigationManager routeNavigationManager,
                            PointMapItem item)

Description copied from interface: RouteNavigationManager.RouteNavigationManagerEventListener

Indicates that the user has departed a point (i.e. they have passed the point). Note: this will usually follow the `onArrivedAtPoint` event.

Specified by:

onDepartedPoint in interface RouteNavigationManager.RouteNavigationManagerEventListener

Parameters:

routeNavigationManager - The RouteNavigationManager.

item - The item from which the user has just departed.