com.atakmap.android.routes

Class RouteNavigationManager

java.lang.Object

com.atakmap.android.routes.RouteNavigationManager

public final class RouteNavigationManager
extends java.lang.Object

ROLE/RESPONSIBILITIES: -> Thread safe -> Owns RouteNavigatorEngine -> Manages Navigation State (Current Nav Point, Next Nav Point, etc.) -> Fires State Related Events -> Tracks ASSUMPTIONS: -> Only Navigating Forward -> Route CANNOT be Edited While Navigating

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouteNavigationManager.RouteNavigationManagerEventListener

Constructor Summary

Constructors

Constructor and Description
RouteNavigationManager(Route route) Constructs a new RouteNavigatorManager instance.

Method Summary

Modifier and Type	Method and Description
void	dispose()
double	getBubbleRadius()
NavigationCue	getCueFromItem(PointMapItem item)
android.util.Pair<java.lang.Integer,PointMapItem>	getCurrentObjective()
double	getDistanceBetweenTwoPoints(GeoPoint pt1, GeoPoint pt2)
double	getDistanceFromRoute(GeoPoint location)
boolean	getIsOffRoute()
GeoPoint	getLocation()
PointMapItem	getNextPointWithTrigger(GeoPoint location)
PointMapItem	getObjectiveAfter(int index)
PointMapItem	getObjectiveBefore(int index)
double	getOffRouteBubbleRadius() Gets the bubble radius for being considered off route, in meters.
Route	getRoute()
java.util.List<GeoPoint>	getSurroundingGeometry(GeoPoint point, double beforeDistance, double afterDistance)
boolean	hasArrivedAtPoint(int index)
boolean	hasDepartedPoint(int index)
boolean	hasEnteredTrigger(int index, int triggerIndex)
boolean	isEngineInitialized() Methods
boolean	isPointWithinItemTrigger(GeoPoint point, PointMapItem targetPoint)
boolean	isPointWithinTrigger(GeoPoint point)
void	moveCurrentObjectiveBackward()
void	moveCurrentObjectiveForward()
void	registerListener(RouteNavigationManager.RouteNavigationManagerEventListener listener) Registers a new event listener.
void	setBubbleRadius(double bubbleRadius)
boolean	setCurrentObjective(int index, PointMapItem item, boolean isFromRouteProgression)
void	setGpsStatus(boolean found) Could be any number of things, but should indicate to the user that their has been a change in the positional status that would impact navigation GPS lost/GPS found, etc.
void	setLocation(GeoPoint location)
void	setOffRouteBubbleRadius(double bubbleRadius) Sets the bubble radius to be considered off the route.
void	unregisterListener(RouteNavigationManager.RouteNavigationManagerEventListener listener) Unregisters the given event listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteNavigationManager

public RouteNavigationManager(Route route)

Constructs a new RouteNavigatorManager instance.

Parameters:

route - The route we are navigating

Method Detail

getBubbleRadius

public double getBubbleRadius()

setBubbleRadius

public void setBubbleRadius(double bubbleRadius)

getOffRouteBubbleRadius

public double getOffRouteBubbleRadius()

Gets the bubble radius for being considered off route, in meters.

Returns:

setOffRouteBubbleRadius

public void setOffRouteBubbleRadius(double bubbleRadius)

Sets the bubble radius to be considered off the route.

Parameters:

bubbleRadius - bubble radius in meters

hasArrivedAtPoint

public boolean hasArrivedAtPoint(int index)

hasDepartedPoint

public boolean hasDepartedPoint(int index)

hasEnteredTrigger

public boolean hasEnteredTrigger(int index,
                                 int triggerIndex)

getCurrentObjective

public android.util.Pair<java.lang.Integer,PointMapItem> getCurrentObjective()

setCurrentObjective

public boolean setCurrentObjective(int index,
                                   PointMapItem item,
                                   boolean isFromRouteProgression)

getObjectiveBefore

public PointMapItem getObjectiveBefore(int index)

moveCurrentObjectiveForward

public void moveCurrentObjectiveForward()

moveCurrentObjectiveBackward

public void moveCurrentObjectiveBackward()

getObjectiveAfter

public PointMapItem getObjectiveAfter(int index)

getRoute

public Route getRoute()

getIsOffRoute

public boolean getIsOffRoute()

getLocation

public GeoPoint getLocation()

setGpsStatus

public void setGpsStatus(boolean found)

Could be any number of things, but should indicate to the user that their has been a change in the positional status that would impact navigation GPS lost/GPS found, etc.

setLocation

public void setLocation(GeoPoint location)

isEngineInitialized

public boolean isEngineInitialized()

Methods

getSurroundingGeometry

public java.util.List<GeoPoint> getSurroundingGeometry(GeoPoint point,
                                                       double beforeDistance,
                                                       double afterDistance)

isPointWithinItemTrigger

public boolean isPointWithinItemTrigger(GeoPoint point,
                                        PointMapItem targetPoint)

isPointWithinTrigger

public boolean isPointWithinTrigger(GeoPoint point)

getNextPointWithTrigger

public PointMapItem getNextPointWithTrigger(GeoPoint location)

getCueFromItem

public NavigationCue getCueFromItem(PointMapItem item)

getDistanceBetweenTwoPoints

public double getDistanceBetweenTwoPoints(GeoPoint pt1,
                                          GeoPoint pt2)

getDistanceFromRoute

public double getDistanceFromRoute(GeoPoint location)

dispose

public void dispose()

registerListener

public void registerListener(RouteNavigationManager.RouteNavigationManagerEventListener listener)

Registers a new event listener.

Parameters:

listener -

unregisterListener

public void unregisterListener(RouteNavigationManager.RouteNavigationManagerEventListener listener)

Unregisters the given event listener.

Parameters:

listener -