com.atakmap.android.toolbars

Class RangeAndBearingMapItem

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.maps.Arrow

com.atakmap.android.toolbars.RangeAndBearingMapItem

All Implemented Interfaces:

android.content.SharedPreferences.OnSharedPreferenceChangeListener, URIContent, HashtagContent, Capturable, Exportable, MapEventDispatcher.OnMapEventListener, MapItem.OnGroupChangedListener, MetaDataHolder, PointMapItem.OnPointChangedListener, VisibilityListener

public class RangeAndBearingMapItem
extends Arrow
implements PointMapItem.OnPointChangedListener, MapItem.OnGroupChangedListener, MapEventDispatcher.OnMapEventListener, android.content.SharedPreferences.OnSharedPreferenceChangeListener, Exportable

Nested Class Summary

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

Arrow.OnTextChangedListener

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

Shape.OnBasicLineStyleChangedListener, Shape.OnFillColorChangedListener, Shape.OnPointsChangedListener, Shape.OnStrokeColorChangedListener, Shape.OnStrokeWeightChangedListener, Shape.OnStyleChangedListener

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
static java.lang.String	TAG

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

_hitRadius, _hitRadiusSq, _mapView, _point1, _point2, _textColor, _touchPoint, text

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

BASIC_LINE_STYLE_DASHED, BASIC_LINE_STYLE_DOTTED, BASIC_LINE_STYLE_OUTLINED, BASIC_LINE_STYLE_SOLID, STYLE_FILLED_MASK, STYLE_STROKE_MASK

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
RangeAndBearingMapItem(PointMapItem pt1, PointMapItem pt2, MapView mapView, java.lang.String uid) Range And Bearing Map Item with the ability to make it persist in the database.
RangeAndBearingMapItem(PointMapItem pt1, PointMapItem pt2, MapView mapView, java.lang.String uid, boolean persist) Range And Bearing Map Item with the ability to make it persist in the database.
RangeAndBearingMapItem(PointMapItem pt1, PointMapItem pt2, MapView mapView, java.lang.String type, java.lang.String uid, boolean persist)
RangeAndBearingMapItem(PointMapItem pt1, PointMapItem pt2, MapView mapView, java.lang.String title, java.lang.String uid, int rangeUnits, Angle bearingUnits, NorthReference northRef, int color) Default persistent Range And Bearing Map Item.
RangeAndBearingMapItem(PointMapItem pt1, PointMapItem pt2, MapView mapView, java.lang.String title, java.lang.String uid, int rangeUnits, Angle bearingUnits, NorthReference northRef, int color, boolean persist) Range And Bearing Map Item with the ability to make it persist in the database.

Method Summary

Modifier and Type	Method and Description
void	addMetaBooleanListener(DropDownReceiver listener)
void	allowSlantRangeToggle(boolean state) Allows for the toggle of the slant range and is not actually the toggle of the slant range
boolean	containsEndpoint(PointMapItem pmi) Return true if the given point map item is associated with the range and bearing arrow
static RangeAndBearingMapItem	createOrUpdateRABLine(java.lang.String uid, PointMapItem pmi1, PointMapItem pmi2) Creates a persistent Range and Bearing map item.
static RangeAndBearingMapItem	createOrUpdateRABLine(java.lang.String uid, PointMapItem pmi1, PointMapItem pmi2, boolean persist) Create a Range and Bearing map item, with a given uid and a start and end point.
void	dispose() Clean up all of the resources associated with this MapItem, for destruction.
Angle	getBearingUnits() Returns the bearing units for the range and bearing arrow
double	getInclination() Returns the inclination of the range and bearing arrow.
NorthReference	getNorthReference() Returns the north reference for the range and bearing arrow
java.lang.String	getPoint1CotType() Return the type of point currently used as the start point.
PointMapItem	getPoint1Item() Return the start point for the range and bearing arrow
java.lang.String	getPoint1UID() Return the uid of point currently used as the start point.
java.lang.String	getPoint2CotType() Return the type of point currently used as the end point.
PointMapItem	getPoint2Item() Return the end point for the range and bearing arrow
java.lang.String	getPoint2UID() Return the uid of point currently used as the end point.
static RangeAndBearingMapItem	getRABLine(java.lang.String uid) Provided a unique identifier look up a Range and Bearing Map item.
int	getRangeUnits() Returns the range units for the range and bearing arrow
static java.util.List<RangeAndBearingMapItem>	getUsers(PointMapItem point) Retrieve users of an endpoint
boolean	isLocked() Returns true if the range and bearring arrow is length locked.
boolean	isReversed() Returns true if the arrow has been reversed.
boolean	isSupported(java.lang.Class<?> target) Check if this instance supports the specified target class type
void	onItemAdded(MapItem item, MapGroup group)
void	onItemRemoved(MapItem item, MapGroup group)
void	onMapItemMapEvent(MapItem item, MapEvent event)
void	onPointChanged(PointMapItem item)
void	onSharedPreferenceChanged(android.content.SharedPreferences sp, java.lang.String key)
void	persist(MapEventDispatcher dispatcher, android.os.Bundle extras, java.lang.Class<?> clazz) Dispatches a persist event for the MapItem.
void	removePoint(MapItem endpoint) Given a point, remove it from the range and bearing arrow.
void	reverse() Reverse the direction of the arrow.
static boolean	sendAsCot(java.lang.String uid) Dispatch the R+B Line, identified by it's UID, as CoT
void	setBearingUnits(Angle bearingUnits) Set this R&B MapItem's bearing units display option
void	setDisplaySlantRange(boolean bSlantRange) Sets the state of the slant range display to either true or false
void	setMetaBoolean(java.lang.String key, boolean value) Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key.
void	setNorthReference(NorthReference northReference) Set this R&B MapItem's north reference display option NorthReference.TRUE = 0 (deg T) NorthReference.MAGNETIC = 1 (deg M) NorthReference.GRID = 2 (deg G)
void	setPoint1(GeoPointMetaData point) Set the tail point of the arrow when not rendered in reverse.
void	setPoint1(PointMapItem pmi) Sets the map item for the start of the arrow.
void	setPoint2(GeoPointMetaData point) Set the head point of the arrow when not rendered in reverse.
void	setPoint2(PointMapItem pmi) Sets the map item for the start of the arrow.
void	setRangeUnits(int rangeUnits) Set this R&B MapItem's range units display option
void	setTitle(java.lang.String title) Set the title of this map item (display name)
boolean	toggleLock() Toggle length lock for the range and bearing arrow
void	toggleSlantRange() Toggles the current state of the slant range display for the range and bearing arrow.
protected GPXExportWrapper	toGpx()
java.lang.Object	toObjectOf(java.lang.Class<?> target, ExportFilters filters) Export to the specified target class type
protected OGRFeatureExportWrapper	toOgrGeomtry()

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

addOnTextChangedListener, drawCanvas, getBounds, getCenter, getMetaDataPoints, getPoint1, getPoint2, getPoints, getText, getTextColor, preDrawCanvas, removeOnTextChangedListener, setAltitudeMode, setHitRadius, setText, setTextColor, update

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

addOnBasicLineStyleChangedListener, addOnFillColorChangedListener, addOnPointsChangedListener, addOnStrokeColorChangedListener, addOnStrokeWeightChangedListener, addOnStyleChangedListener, addStyleBits, findTouchPoint, getArea, getBasicLineStyle, getClickPoint, getFillColor, getGeoPointMetaData, getIconColor, getPerimeterOrLength, getStrokeColor, getStrokeStyle, getStrokeWeight, getStyle, getTitle, onBasicLineStyleChanged, onFillColorChanged, onPointsChanged, onStrokeColorChanged, onStrokeStyleChanged, onStrokeWeightChanged, onStyleChanged, removeOnBasicLineStyleChangedListener, removeOnFillColorChangedListener, removeOnPointsChangedListener, removeOnStrokeColorChangedListener, removeOnStrokeWeightChangedListener, removeOnStyleChangedListener, removeStyleBits, setBasicLineStyle, setColor, setColor, setFillAlpha, setFillColor, setStrokeColor, setStrokeStyle, setStrokeWeight, setStyle, setTouchPoint, wrap180

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

addOnAltitudeModeChangedListener, addOnClickableChangedListener, addOnGroupChangedListener, addOnHeightChangedListener, addOnMetadataChangedListener, addOnMetadataChangedListener, addOnTypeChangedListener, addOnVisibleChangedListener, addOnZOrderChangedListener, computeDistance, copyMetaData, createSerialId, getAltitudeMode, getClickable, getEditable, getGroup, getHashtags, getHeight, getHitRadius, getIconDrawable, getMetaBoolean, getMetaString, getMovable, getRadialMenuPath, getRemarks, getRemarksKey, getSerialId, getTag, getType, getUID, getUniqueMapItemName, getURI, getVisible, getVisible, getZOrder, isTouchable, notifyMetadataChanged, onAdded, onAltitudeModeChanged, onClickableChanged, onGroupChanged, onHeightChanged, onMetadataChanged, onRemoved, onTypeChanged, onVisibilityConditions, onVisibleChanged, onZOrderChanged, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setClickable, setClickPoint, setEditable, setHashtags, setHeight, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, setMetaStringArrayList, setMovable, setRadialMenu, setRemarks, setTag, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

RangeAndBearingMapItem

public RangeAndBearingMapItem(PointMapItem pt1,
                              PointMapItem pt2,
                              MapView mapView,
                              java.lang.String title,
                              java.lang.String uid,
                              int rangeUnits,
                              Angle bearingUnits,
                              NorthReference northRef,
                              int color)

Default persistent Range And Bearing Map Item.

RangeAndBearingMapItem

public RangeAndBearingMapItem(PointMapItem pt1,
                              PointMapItem pt2,
                              MapView mapView,
                              java.lang.String title,
                              java.lang.String uid,
                              int rangeUnits,
                              Angle bearingUnits,
                              NorthReference northRef,
                              int color,
                              boolean persist)

Range And Bearing Map Item with the ability to make it persist in the database.

Parameters:

pt1 - the start point for the arrow

pt2 - the end point for the arrow

mapView - the map view

title - the title or label of the arrow

uid - the unique identifier

rangeUnits - the range units as one of Span.ENGLISH, Span.METRIC, Span.NM

bearingUnits - the bearing units

northRef - the north reference

color - the color of the arrow

persist - true if it will persist past application restarts

RangeAndBearingMapItem

public RangeAndBearingMapItem(PointMapItem pt1,
                              PointMapItem pt2,
                              MapView mapView,
                              java.lang.String uid)

Range And Bearing Map Item with the ability to make it persist in the database.

Parameters:

pt1 - the start point for the arrow

pt2 - the end point for the arrow

mapView - the map view

uid - the unique identifier

RangeAndBearingMapItem

public RangeAndBearingMapItem(PointMapItem pt1,
                              PointMapItem pt2,
                              MapView mapView,
                              java.lang.String uid,
                              boolean persist)

Range And Bearing Map Item with the ability to make it persist in the database.

Parameters:

pt1 - the start point for the arrow

pt2 - the end point for the arrow

mapView - the map view

uid - the unique identifier

persist - true if it will persist past application restarts

RangeAndBearingMapItem

public RangeAndBearingMapItem(PointMapItem pt1,
                              PointMapItem pt2,
                              MapView mapView,
                              java.lang.String type,
                              java.lang.String uid,
                              boolean persist)

Method Detail

getRABLine

public static RangeAndBearingMapItem getRABLine(java.lang.String uid)

Provided a unique identifier look up a Range and Bearing Map item.

Parameters:

uid - the uid describing the range and bearing map item

Returns:

the associated range and bearing map item or null if one is not found.

createOrUpdateRABLine

public static RangeAndBearingMapItem createOrUpdateRABLine(java.lang.String uid,
                                                           PointMapItem pmi1,
                                                           PointMapItem pmi2)

Creates a persistent Range and Bearing map item.

Parameters:

uid - the unique identifier for the range and bearing line

pmi1 - the map item to attach to the start of the arrow

pmi2 - the map item to attach to the end of the arrow.

createOrUpdateRABLine

public static RangeAndBearingMapItem createOrUpdateRABLine(java.lang.String uid,
                                                           PointMapItem pmi1,
                                                           PointMapItem pmi2,
                                                           boolean persist)

Create a Range and Bearing map item, with a given uid and a start and end point. Additionally, this could be persistent (true) or transient (false)

Parameters:

uid - the unique identifier for the range and bearing line

pmi1 - the point map item for the start of the arrow

pmi2 - the point map item for the end of the arrow

persist - if the arrow is to persist after a restart.

containsEndpoint

public boolean containsEndpoint(PointMapItem pmi)

Return true if the given point map item is associated with the range and bearing arrow

Parameters:

pmi - the point map item to check

Returns:

true if it is either attached to the start or the end of the range and bearing arrow

sendAsCot

public static boolean sendAsCot(java.lang.String uid)

Dispatch the R+B Line, identified by it's UID, as CoT

Parameters:

uid - UID of the RangeAndBearingMapItem line to send as CoT

Returns:

Indicator of success: True - CoT dispatched, False - failure line likely not found

setPoint1

public void setPoint1(PointMapItem pmi)

Sets the map item for the start of the arrow.

Overrides:

setPoint1 in class Arrow

Parameters:

pmi - the map item to be associated with the start of the arrow.

setPoint2

public void setPoint2(PointMapItem pmi)

Sets the map item for the start of the arrow.

Overrides:

setPoint2 in class Arrow

Parameters:

pmi - the map item to be associated with the end of the arrow.

setPoint1

public void setPoint1(GeoPointMetaData point)

Description copied from class: Arrow

Set the tail point of the arrow when not rendered in reverse.

Overrides:

setPoint1 in class Arrow

Parameters:

point - the point for the tail to start at.

setPoint2

public void setPoint2(GeoPointMetaData point)

Description copied from class: Arrow

Set the head point of the arrow when not rendered in reverse.

Overrides:

setPoint2 in class Arrow

Parameters:

point - the point for the head to point to.

isReversed

public boolean isReversed()

Returns true if the arrow has been reversed.

Returns:

true if reversed.

reverse

public void reverse()

Reverse the direction of the arrow.

toggleSlantRange

public void toggleSlantRange()

Toggles the current state of the slant range display for the range and bearing arrow. Slant range is the true distance (hypotenuse) where as range is just the distance as the crow flies between two points on a flat model.

toggleLock

public boolean toggleLock()

Toggle length lock for the range and bearing arrow

Returns:

true if lock is enabled, false if the result is not locked.

isLocked

public boolean isLocked()

Returns true if the range and bearring arrow is length locked.

Returns:

true if length locked

setBearingUnits

public void setBearingUnits(Angle bearingUnits)

Set this R&B MapItem's bearing units display option

Parameters:

bearingUnits - - The constant int associated with the bearing units preference.

setRangeUnits

public void setRangeUnits(int rangeUnits)

Set this R&B MapItem's range units display option

Parameters:

rangeUnits - - The constant int associated with the range units preference. Can be one of Span.METRIC, Span.ENGLISH, or Span.NM

Throws:

java.lang.IllegalStateException - if the range unit is not one of the following

setNorthReference

public void setNorthReference(NorthReference northReference)

Set this R&B MapItem's north reference display option

NorthReference.TRUE = 0 (deg T)
NorthReference.MAGNETIC = 1 (deg M)
NorthReference.GRID = 2 (deg G)

Parameters:

northReference - - The constant int associated with the north reference preference.

allowSlantRangeToggle

public void allowSlantRangeToggle(boolean state)

Allows for the toggle of the slant range and is not actually the toggle of the slant range

Parameters:

state - the state togglable or not.

setDisplaySlantRange

public void setDisplaySlantRange(boolean bSlantRange)

Sets the state of the slant range display to either true or false

Parameters:

bSlantRange - true shows the distance as slant range.

getInclination

public double getInclination()

Returns the inclination of the range and bearing arrow.

Returns:

the inclination in degrees

getBearingUnits

public Angle getBearingUnits()

Returns the bearing units for the range and bearing arrow

Returns:

the bearing units

getRangeUnits

public int getRangeUnits()

Returns the range units for the range and bearing arrow

Returns:

the range unit as one of Span.METRIC, Span.ENGLISH, or Span.NM

getNorthReference

public NorthReference getNorthReference()

Returns the north reference for the range and bearing arrow

Returns:

the north reference

setTitle

public void setTitle(java.lang.String title)

Description copied from class: MapItem

Set the title of this map item (display name)

Overrides:

setTitle in class Shape

Parameters:

title - Item title

persist

public void persist(MapEventDispatcher dispatcher,
                    android.os.Bundle extras,
                    java.lang.Class<?> clazz)

Description copied from class: MapItem

Dispatches a persist event for the MapItem. The refresh event will signal interested components that the item should be persisted to its storage.

By default, the event will be dispatched with the extra, "internal", set to true. This may be overridden by setting the parameter in persistExtras to an alternate value.

Overrides:

persist in class MapItem

Parameters:

dispatcher - The event dispatcher

extras - An optional bundle of extras to be sent with the event; may be null

clazz - the class that made this persist call See MapEvent.ITEM_PERSIST

getPoint1Item

public PointMapItem getPoint1Item()

Return the start point for the range and bearing arrow

Returns:

getPoint2Item

public PointMapItem getPoint2Item()

Return the end point for the range and bearing arrow

Returns:

dispose

public void dispose()

Description copied from class: MapItem

Clean up all of the resources associated with this MapItem, for destruction.

Overrides:

dispose in class MapItem

onItemAdded

public void onItemAdded(MapItem item,
                        MapGroup group)

Specified by:

onItemAdded in interface MapItem.OnGroupChangedListener

onItemRemoved

public void onItemRemoved(MapItem item,
                          MapGroup group)

Specified by:

onItemRemoved in interface MapItem.OnGroupChangedListener

getUsers

public static java.util.List<RangeAndBearingMapItem> getUsers(PointMapItem point)

Retrieve users of an endpoint

Parameters:

point - The point to check for users

Returns:

userList the list of range and bearing items that contain the given point

onPointChanged

public void onPointChanged(PointMapItem item)

Specified by:

onPointChanged in interface PointMapItem.OnPointChangedListener

onMapItemMapEvent

public void onMapItemMapEvent(MapItem item,
                              MapEvent event)

Specified by:

onMapItemMapEvent in interface MapEventDispatcher.OnMapEventListener

onSharedPreferenceChanged

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

Specified by:

onSharedPreferenceChanged in interface android.content.SharedPreferences.OnSharedPreferenceChangeListener

removePoint

public void removePoint(MapItem endpoint)

Given a point, remove it from the range and bearing arrow.

Parameters:

endpoint - the point to remove

getPoint1CotType

public java.lang.String getPoint1CotType()

Return the type of point currently used as the start point.

Returns:

the type for the point.

getPoint2CotType

public java.lang.String getPoint2CotType()

Return the type of point currently used as the end point.

Returns:

the type for the point.

getPoint1UID

public java.lang.String getPoint1UID()

Return the uid of point currently used as the start point.

Returns:

the uid for the point.

getPoint2UID

public java.lang.String getPoint2UID()

Return the uid of point currently used as the end point.

Returns:

the uid for the point.

toOgrGeomtry

protected OGRFeatureExportWrapper toOgrGeomtry()

toGpx

protected GPXExportWrapper toGpx()

isSupported

public boolean isSupported(java.lang.Class<?> target)

Description copied from interface: Exportable

Check if this instance supports the specified target class type

Specified by:

isSupported in interface Exportable

Parameters:

target - the target class

Returns:

true if this instance supports the target.

toObjectOf

public java.lang.Object toObjectOf(java.lang.Class<?> target,
                                   ExportFilters filters)

Description copied from interface: Exportable

Export to the specified target class type

Specified by:

toObjectOf in interface Exportable

Parameters:

target - the target class

filters - Allows ExportMarshal instances to filter e.g. based on geographic region or other criteria

Returns:

the object that represents the instance based on the target and filter

addMetaBooleanListener

public void addMetaBooleanListener(DropDownReceiver listener)

setMetaBoolean

public void setMetaBoolean(java.lang.String key,
                           boolean value)

Description copied from interface: MetaDataHolder

Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Specified by:

setMetaBoolean in interface MetaDataHolder

Overrides:

setMetaBoolean in class MapItem

Parameters:

key - a String, or null

value - a boolean