com.atakmap.android.maps

Class CrumbTrail

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.CrumbTrail

All Implemented Interfaces:

android.content.SharedPreferences.OnSharedPreferenceChangeListener, URIContent, HashtagContent, FOVFilter.Filterable, MetaDataHolder, VisibilityListener

public class CrumbTrail
extends MapItem
implements FOVFilter.Filterable, android.content.SharedPreferences.OnSharedPreferenceChangeListener

CrumbTrail manages crumbs for a map item using a dedicated trackThread The intervalMillis is configurable and specifies how often to store crumbs in the CrumbDatabase Crumbs are only stored if the map item has moved by distThreshold Crumbs are sent to the UI no more than once every 2 seconds

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CrumbTrail.CrumbLogListener
static interface	CrumbTrail.OnCrumbTrailUpdateListener

Nested classes/interfaces inherited from class com.atakmap.android.maps.MapItem

MapItem.OnAltitudeModeChangedListener, MapItem.OnClickableChangedListener, MapItem.OnGroupChangedListener, MapItem.OnHeightChangedListener, MapItem.OnMetadataChangedListener, MapItem.OnTypeChangedListener, MapItem.OnVisibleChangedListener, MapItem.OnZOrderChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
boolean	drawLineToSurface
Crumb	first
Crumb	last
int	size

Fields inherited from class com.atakmap.android.maps.MapItem

CLICKABLE_DEFAULT, EDITABLE_DEFAULT, EMPTY_TYPE, HIT_RATIO_DEFAULT, MOVABLE_DEFAULT, VISIBLE_DEFAULT, ZORDER_DEFAULT, ZORDER_HITTEST_COMPARATOR, ZORDER_RENDER_COMPARATOR

Fields inherited from class com.atakmap.android.maps.FilterMetaDataHolder

metadata

Constructor Summary

Constructors

Constructor and Description
CrumbTrail(long serialId, MetaDataHolder metadata, MapView mapView, android.content.SharedPreferences prefs, java.lang.String uid) Deprecated.
CrumbTrail(MapView mapView, PointMapItem target, android.content.SharedPreferences prefs, java.lang.String uid)
CrumbTrail(MapView mapView, PointMapItem target, android.content.SharedPreferences prefs, java.lang.String uid, boolean circles, boolean unlimited) Creates a new crumb trail.

Method Summary

Modifier and Type	Method and Description
boolean	accept(FOVFilter.MapState fov)
void	addCrumbLogListener(CrumbTrail.CrumbLogListener l)
void	addOnCrumbTrailUpdateListener(CrumbTrail.OnCrumbTrailUpdateListener l)
void	clearAllCrumbs()
void	crumb(CrumbDatabase cdb) add another breadcrumb assuming it's far enough away from the last one, and set the color based on the CoT type
boolean	equals(java.lang.Object o)
PointMapItem	getTarget() Return the current point map item that this crumb trail represents.
boolean	getTracking() Whether this crumb trail should be tracked (new crumbs added)
double	getZOrder() Get the item zOrder.
int	hashCode()
void	onAdded(MapGroup newParent)
void	onRemoved(MapGroup oldParent)
void	onSharedPreferenceChanged(android.content.SharedPreferences prefs, java.lang.String key)
protected void	onVisibleChanged() Invokes when the visible property changes
void	persist() Persist this crumb trail to the track DB
static void	persistTrails(java.util.List<CrumbTrail> trails) Convenience method for persisting a list of trails
void	removeCrumbLogListener(CrumbTrail.CrumbLogListener l)
void	removeOnCrumbTrailUpdateListener(CrumbTrail.OnCrumbTrailUpdateListener l)
void	setColor(int color) Sets the color for the crumb trail.
void	setTarget(PointMapItem target) Sets the point map item for an existing crumb trail
void	setTracking(boolean tracking) Set the tracking state of this trail Tracking controls whether BreadcrumbReceiver adds new crumbs
static boolean	toggleCrumbTrail(CrumbTrail trail)

Methods inherited from class com.atakmap.android.maps.MapItem

addOnAltitudeModeChangedListener, addOnClickableChangedListener, addOnGroupChangedListener, addOnHeightChangedListener, addOnMetadataChangedListener, addOnMetadataChangedListener, addOnTypeChangedListener, addOnVisibleChangedListener, addOnZOrderChangedListener, computeDistance, copyMetaData, createSerialId, dispose, getAltitudeMode, getClickable, getClickPoint, getEditable, getGroup, getHashtags, getHeight, getHitRadius, getIconColor, getIconDrawable, getMetaBoolean, getMetaString, getMovable, getRadialMenuPath, getRemarks, getRemarksKey, getSerialId, getTag, getTitle, getType, getUID, getUniqueMapItemName, getURI, getVisible, getVisible, isTouchable, notifyMetadataChanged, onAltitudeModeChanged, onClickableChanged, onGroupChanged, onHeightChanged, onMetadataChanged, onTypeChanged, onVisibilityConditions, onZOrderChanged, persist, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setAltitudeMode, setClickable, setClickPoint, setEditable, setHashtags, setHeight, setMetaBoolean, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, setMetaStringArrayList, setMovable, setRadialMenu, setRemarks, setTag, setTitle, setTouchable, setType, setVisible, setVisible, setZOrder, testOrthoHit, toString

Methods inherited from class com.atakmap.android.maps.FilterMetaDataHolder

get, getMetaData, getMetaDouble, getMetaIntArray, getMetaInteger, getMetaLong, getMetaMap, getMetaParcelable, getMetaSerializable, getMetaStringArrayList, hasMetaValue, setMetaDataImpl, toggleMetaData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

first

public Crumb first

last

public Crumb last

size

public int size

drawLineToSurface

public boolean drawLineToSurface

Constructor Detail

CrumbTrail

@Deprecated
public CrumbTrail(long serialId,
                              MetaDataHolder metadata,
                              MapView mapView,
                              android.content.SharedPreferences prefs,
                              java.lang.String uid)

Deprecated.

CrumbTrail

public CrumbTrail(MapView mapView,
                  PointMapItem target,
                  android.content.SharedPreferences prefs,
                  java.lang.String uid)

CrumbTrail

public CrumbTrail(MapView mapView,
                  PointMapItem target,
                  android.content.SharedPreferences prefs,
                  java.lang.String uid,
                  boolean circles,
                  boolean unlimited)

Creates a new crumb trail.

Parameters:

mapView - the map view for the crumb trail

target - the target to produce the crumb trail for

prefs - the preferences to query

uid - the uid for the trail

circles - render the trail as circles instead of arrows

unlimited - if the trail should ignore the system default max

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

accept

public boolean accept(FOVFilter.MapState fov)

Specified by:

accept in interface FOVFilter.Filterable

getTarget

public PointMapItem getTarget()

Return the current point map item that this crumb trail represents.

Returns:

the point map item

setTarget

public void setTarget(PointMapItem target)

Sets the point map item for an existing crumb trail

Parameters:

target - the point map item that will be used for the next crumbs in the crumb trail.

setColor

public void setColor(int color)

Sets the color for the crumb trail. This applies to the entire trail.

Parameters:

color - the color as a ARGB value.

onSharedPreferenceChanged

public void onSharedPreferenceChanged(android.content.SharedPreferences prefs,
                                      java.lang.String key)

Specified by:

onSharedPreferenceChanged in interface android.content.SharedPreferences.OnSharedPreferenceChangeListener

crumb

public void crumb(CrumbDatabase cdb)

add another breadcrumb assuming it's far enough away from the last one, and set the color based on the CoT type

addOnCrumbTrailUpdateListener

public void addOnCrumbTrailUpdateListener(CrumbTrail.OnCrumbTrailUpdateListener l)

removeOnCrumbTrailUpdateListener

public void removeOnCrumbTrailUpdateListener(CrumbTrail.OnCrumbTrailUpdateListener l)

addCrumbLogListener

public void addCrumbLogListener(CrumbTrail.CrumbLogListener l)

removeCrumbLogListener

public void removeCrumbLogListener(CrumbTrail.CrumbLogListener l)

clearAllCrumbs

public void clearAllCrumbs()

onAdded

public void onAdded(MapGroup newParent)

Overrides:

onAdded in class MapItem

onRemoved

public void onRemoved(MapGroup oldParent)

Overrides:

onRemoved in class MapItem

getZOrder

public double getZOrder()

Description copied from class: MapItem

Get the item zOrder.

Overrides:

getZOrder in class MapItem

Returns:

onVisibleChanged

protected void onVisibleChanged()

Description copied from class: MapItem

Invokes when the visible property changes

Overrides:

onVisibleChanged in class MapItem

setTracking

public void setTracking(boolean tracking)

Set the tracking state of this trail Tracking controls whether BreadcrumbReceiver adds new crumbs

Parameters:

tracking - True to enable tracking

getTracking

public boolean getTracking()

Whether this crumb trail should be tracked (new crumbs added)

Returns:

True if tracking is enabled

persist

public void persist()

Persist this crumb trail to the track DB

persistTrails

public static void persistTrails(java.util.List<CrumbTrail> trails)

Convenience method for persisting a list of trails

Parameters:

trails - List of crumb trails

toggleCrumbTrail

public static boolean toggleCrumbTrail(CrumbTrail trail)