com.atakmap.android.drawing.mapItems

Class DrawingCircle

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.drawing.mapItems.DrawingCircle

All Implemented Interfaces:

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

Direct Known Subclasses:

RangeCircle

public class DrawingCircle
extends Shape
implements Exportable, AnchoredMapItem, ParentMapItem, MapItem.OnGroupChangedListener, PointMapItem.OnPointChangedListener, android.content.SharedPreferences.OnSharedPreferenceChangeListener

A circle with one or more rings, a center marker, and radius marker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DrawingCircle.OnRadiusChangedListener Listeners

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
protected GeoPointMetaData	_center
protected Marker	_centerMarker
protected MapGroup	_childGroup
protected MapView	_mapView
protected UnitPreferences	_prefs
protected double	_radius
protected java.util.Set<DrawingCircle.OnRadiusChangedListener>	_radiusListeners
protected Marker	_radiusMarker
protected java.util.List<Circle>	_rings
static java.lang.String	COT_TYPE
static int	DEFAULT_STYLE
static int	MAX_RINGS
protected static java.util.Set<java.lang.String>	MENU_METADATA

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
DrawingCircle(MapView mapView)
DrawingCircle(MapView mapView, java.lang.String uid)
DrawingCircle(MapView mapView, java.lang.String uid, java.lang.String type)
DrawingCircle(MapView mapView, java.lang.String uid, java.lang.String type, MapGroup childGroup) Create a new drawing circle

Method Summary

Modifier and Type	Method and Description
void	addOnRadiusChangedListener(DrawingCircle.OnRadiusChangedListener l)
protected Circle	createRing(double radius) Create a new ring for this circle
void	drawCanvas(CapturePP cap, android.os.Bundle data) Draw the item to the canvas
PointMapItem	getAnchorItem() The center marker acts as the anchor for this circle
double	getArea() Returns the Area of the shape in meters
GeoBounds	getBounds(MutableGeoBounds bounds) Bounds is equivalent to the bonds of the outermost circle
GeoPointMetaData	getCenter() Provides the center point for the Shape, or null if an error has occurred.
Marker	getCenterMarker() Get the center marker for this circle
GeoPoint	getCenterPoint()
MapGroup	getChildMapGroup() Get this item's child map group
GeoPointMetaData[]	getMetaDataPoints() The array of points that make up the shape with the corresponding metadata.
int	getNumRings() Get the number of rings in this circle
Circle	getOutermostRing() Get the outermost ring
double	getPerimeterOrLength() Returns the perimeter of a shape if closed otherwise will return the length of of the open shape from start to end.
GeoPoint[]	getPoints() Get all points of the outermost ring
double	getRadius() Get the radius of the base circle (first ring)
Marker	getRadiusMarker() Get the radius marker for this center
Circle	getRing(int index) Get the ring at the specified index
double	getRingRadius(int index) Get the radius of a specific ring in this circle
java.util.List<Circle>	getRings() Get the list of rings
boolean	isCenterShapeMarker() Helper method to check if the center marker is a generic shape marker as opposed to a marker explicitly set by the user
boolean	isSupported(java.lang.Class<?> target) Check if this instance supports the specified target class type
protected void	onGroupChanged(boolean added, MapGroup group) Keep the child map group with whichever group this circle is moved to
void	onItemAdded(MapItem item, MapGroup group)
void	onItemRemoved(MapItem item, MapGroup group)
void	onPointChanged(PointMapItem item)
protected void	onRadiusChanged(double oldRadius)
void	onSharedPreferenceChanged(android.content.SharedPreferences sp, java.lang.String key)
protected void	onStrokeStyleChanged() The line/stroke style for this shape has been changed
protected void	onVisibleChanged() Invokes when the visible property changes
android.os.Bundle	preDrawCanvas(CapturePP capture) Export
void	refresh() Refresh all child item states including rings and center marker
void	removeMetaData(java.lang.String key) Removes the metadata associated with the specified key.
void	removeOnRadiusChangedListener(DrawingCircle.OnRadiusChangedListener l)
void	setAltitudeMode(AltitudeMode altitudeMode) Set the altitude mode for this item See AltitudeMode for possible values
void	setCenterMarker(Marker marker) Set the center marker
void	setCenterPoint(GeoPointMetaData point) Set the center point of this circle This will move the anchor marker as well
void	setFillColor(int fillColor) Apply fill color to the outermost ring only
void	setHeight(double height) Set the height of this item
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	setMetaString(java.lang.String key, java.lang.String value) Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key.
int	setNumRings(int numRings)
boolean	setRadius(double radius) Set the radius of the base circle (first ring)
void	setRadiusMarker(Marker marker) Set the radius marker
void	setRadiusPoint(GeoPoint point) Set the radius using a point from the center
void	setStrokeColor(int strokeColor) Apply stroke color to all rings
void	setStrokeWeight(double weight) Set the stroke weight of this shape's lines Minimum = 1.0, maximum = 6.0
void	setStyle(int style) Set the style property value
void	setTitle(java.lang.String title) Set the title of the circle, including the name of its center marker
void	setZOrder(double zOrder) Keep the rings at the same z-order
protected CotEvent	toCot() Generate a CoT event for this circle
protected GPXExportWrapper	toGpx()
Folder	toKml()
protected KMZFolder	toKmz()
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.Shape

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

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

addOnAltitudeModeChangedListener, addOnClickableChangedListener, addOnGroupChangedListener, addOnHeightChangedListener, addOnMetadataChangedListener, addOnMetadataChangedListener, addOnTypeChangedListener, addOnVisibleChangedListener, addOnZOrderChangedListener, computeDistance, copyMetaData, createSerialId, dispose, 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, onHeightChanged, onMetadataChanged, onRemoved, onTypeChanged, onVisibilityConditions, onZOrderChanged, persist, refresh, removeFromGroup, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setClickable, setClickPoint, setEditable, setHashtags, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaStringArrayList, setMovable, setRadialMenu, setRemarks, setTag, setTouchable, setType, setVisible, setVisible, 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

COT_TYPE

public static final java.lang.String COT_TYPE

See Also:

Constant Field Values

MAX_RINGS

public static final int MAX_RINGS

See Also:

Constant Field Values

DEFAULT_STYLE

public static final int DEFAULT_STYLE

See Also:

Constant Field Values

MENU_METADATA

protected static final java.util.Set<java.lang.String> MENU_METADATA

_mapView

protected final MapView _mapView

_prefs

protected final UnitPreferences _prefs

_childGroup

protected final MapGroup _childGroup

_rings

protected final java.util.List<Circle> _rings

_radius

protected double _radius

_center

protected GeoPointMetaData _center

_centerMarker

protected Marker _centerMarker

_radiusMarker

protected Marker _radiusMarker

_radiusListeners

protected final java.util.Set<DrawingCircle.OnRadiusChangedListener> _radiusListeners

Constructor Detail

DrawingCircle

public DrawingCircle(MapView mapView,
                     java.lang.String uid,
                     java.lang.String type,
                     MapGroup childGroup)

Create a new drawing circle

Parameters:

mapView - Map view instance

uid - UID

type - Circle type

childGroup - The child map group

DrawingCircle

public DrawingCircle(MapView mapView,
                     java.lang.String uid,
                     java.lang.String type)

DrawingCircle

public DrawingCircle(MapView mapView,
                     java.lang.String uid)

DrawingCircle

public DrawingCircle(MapView mapView)

Method Detail

setRadius

public boolean setRadius(double radius)

Set the radius of the base circle (first ring)

Parameters:

radius - Radius in meters

Returns:

True if successful, false if too small/large

getRadius

public double getRadius()

Get the radius of the base circle (first ring)

Returns:

Radius in meters

getRingRadius

public double getRingRadius(int index)

Get the radius of a specific ring in this circle

Parameters:

index - Ring index (starting at 0)

Returns:

Radius of the ring in meters

getNumRings

public int getNumRings()

Get the number of rings in this circle

Returns:

Number of rings

getRings

public java.util.List<Circle> getRings()

Get the list of rings

Returns:

Non-mutable list of rings

getRing

public Circle getRing(int index)

Get the ring at the specified index

Parameters:

index - Index (starting at 0)

Returns:

Ring circle

getOutermostRing

public Circle getOutermostRing()

Get the outermost ring

Returns:

Outermost ring

setNumRings

public int setNumRings(int numRings)

createRing

protected Circle createRing(double radius)

Create a new ring for this circle

Parameters:

radius - The radius of the new circle

Returns:

New circle object or null if failed

refresh

public void refresh()

Refresh all child item states including rings and center marker

setTitle

public void setTitle(java.lang.String title)

Set the title of the circle, including the name of its center marker

Overrides:

setTitle in class Shape

Parameters:

title - Circle title

setStyle

public void setStyle(int style)

Description copied from class: Shape

Set the style property value

Overrides:

setStyle in class Shape

Parameters:

style - a bitfield of any STYLE_*_MASK flags from Shape or specific subclass

onVisibleChanged

protected void onVisibleChanged()

Description copied from class: MapItem

Invokes when the visible property changes

Overrides:

onVisibleChanged in class MapItem

setMetaString

public void setMetaString(java.lang.String key,
                          java.lang.String value)

Description copied from interface: MetaDataHolder

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

Specified by:

setMetaString in interface MetaDataHolder

Overrides:

setMetaString in class MapItem

Parameters:

key - a String, or null

value - a String, or null

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

removeMetaData

public void removeMetaData(java.lang.String key)

Description copied from interface: MetaDataHolder

Removes the metadata associated with the specified key.

Specified by:

removeMetaData in interface MetaDataHolder

Overrides:

removeMetaData in class MapItem

setCenterPoint

public void setCenterPoint(GeoPointMetaData point)

Set the center point of this circle This will move the anchor marker as well

Parameters:

point - Center point

getCenter

public GeoPointMetaData getCenter()

Description copied from class: Shape

Provides the center point for the Shape, or null if an error has occurred.

Overrides:

getCenter in class Shape

getCenterPoint

public GeoPoint getCenterPoint()

setCenterMarker

public void setCenterMarker(Marker marker)

Set the center marker

Parameters:

marker - Center marker

getCenterMarker

public Marker getCenterMarker()

Get the center marker for this circle

Returns:

Center marker

isCenterShapeMarker

public boolean isCenterShapeMarker()

Helper method to check if the center marker is a generic shape marker as opposed to a marker explicitly set by the user

Returns:

True if the center marker is a generic shape marker

setRadiusPoint

public void setRadiusPoint(GeoPoint point)

Set the radius using a point from the center

Parameters:

point - Point

setRadiusMarker

public void setRadiusMarker(Marker marker)

Set the radius marker

Parameters:

marker - Radius marker

getRadiusMarker

public Marker getRadiusMarker()

Get the radius marker for this center

Returns:

Radius marker

getAnchorItem

public PointMapItem getAnchorItem()

The center marker acts as the anchor for this circle

Specified by:

getAnchorItem in interface AnchoredMapItem

Returns:

Center marker or underlying shape marker

getPoints

public GeoPoint[] getPoints()

Get all points of the outermost ring

Specified by:

getPoints in class Shape

Returns:

Array of points

getMetaDataPoints

public GeoPointMetaData[] getMetaDataPoints()

Description copied from class: Shape

The array of points that make up the shape with the corresponding metadata.

Specified by:

getMetaDataPoints in class Shape

Returns:

the points.

getBounds

public GeoBounds getBounds(MutableGeoBounds bounds)

Bounds is equivalent to the bonds of the outermost circle

Specified by:

getBounds in class Shape

Parameters:

bounds - a preallocated bounds object

Returns:

the upper left and lower right of the shape.

setZOrder

public void setZOrder(double zOrder)

Keep the rings at the same z-order

Overrides:

setZOrder in class MapItem

Parameters:

zOrder - Z-order

setHeight

public void setHeight(double height)

Description copied from class: MapItem

Set the height of this item

Overrides:

setHeight in class MapItem

Parameters:

height - the height in meters or Double.NaN if unknown.

setAltitudeMode

public void setAltitudeMode(AltitudeMode altitudeMode)

Description copied from class: MapItem

Set the altitude mode for this item See AltitudeMode for possible values

Overrides:

setAltitudeMode in class MapItem

Parameters:

altitudeMode - Altitude mode

setFillColor

public void setFillColor(int fillColor)

Apply fill color to the outermost ring only

Overrides:

setFillColor in class Shape

Parameters:

fillColor - An argb packed by Color

setStrokeColor

public void setStrokeColor(int strokeColor)

Apply stroke color to all rings

Overrides:

setStrokeColor in class Shape

Parameters:

strokeColor - An argb packed by Color

setStrokeWeight

public void setStrokeWeight(double weight)

Description copied from class: Shape

Set the stroke weight of this shape's lines Minimum = 1.0, maximum = 6.0

Overrides:

setStrokeWeight in class Shape

Parameters:

weight - a stroke line width

onStrokeStyleChanged

protected void onStrokeStyleChanged()

Description copied from class: Shape

The line/stroke style for this shape has been changed

Overrides:

onStrokeStyleChanged in class Shape

getChildMapGroup

public MapGroup getChildMapGroup()

Description copied from interface: ParentMapItem

Get this item's child map group

Specified by:

getChildMapGroup in interface ParentMapItem

Returns:

Child map group

onGroupChanged

protected void onGroupChanged(boolean added,
                              MapGroup group)

Keep the child map group with whichever group this circle is moved to

Overrides:

onGroupChanged in class MapItem

Parameters:

added - True if circle added to group

group - Map group it was added to

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

onPointChanged

public void onPointChanged(PointMapItem item)

Specified by:

onPointChanged in interface PointMapItem.OnPointChangedListener

onSharedPreferenceChanged

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

Specified by:

onSharedPreferenceChanged in interface android.content.SharedPreferences.OnSharedPreferenceChangeListener

addOnRadiusChangedListener

public void addOnRadiusChangedListener(DrawingCircle.OnRadiusChangedListener l)

removeOnRadiusChangedListener

public void removeOnRadiusChangedListener(DrawingCircle.OnRadiusChangedListener l)

onRadiusChanged

protected void onRadiusChanged(double oldRadius)

preDrawCanvas

public android.os.Bundle preDrawCanvas(CapturePP capture)

Export

Specified by:

preDrawCanvas in interface Capturable

Overrides:

preDrawCanvas in class Shape

Parameters:

capture - Capture instance (use forward() to convert)

Returns:

Metadata containing point data (or anything else relevant to ortho)

drawCanvas

public void drawCanvas(CapturePP cap,
                       android.os.Bundle data)

Description copied from interface: Capturable

Draw the item to the canvas

Specified by:

drawCanvas in interface Capturable

Overrides:

drawCanvas in class Shape

Parameters:

cap - Canvas to draw to (use getCanvas())

data - Point data saved in preDrawCanvas

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

toCot

protected CotEvent toCot()

Generate a CoT event for this circle

Returns:

New CoT event or null if failed

toKml

public Folder toKml()

toKmz

protected KMZFolder toKmz()

toGpx

protected GPXExportWrapper toGpx()

toOgrGeomtry

protected OGRFeatureExportWrapper toOgrGeomtry()

getArea

public double getArea()

Description copied from class: Shape

Returns the Area of the shape in meters

Overrides:

getArea in class Shape

Returns:

the area in meters or double NaN is area is not implemented or in the case of an unclosed shape.

getPerimeterOrLength

public double getPerimeterOrLength()

Description copied from class: Shape

Returns the perimeter of a shape if closed otherwise will return the length of of the open shape from start to end.

Overrides:

getPerimeterOrLength in class Shape