com.atakmap.android.drawing.mapItems

Class DrawingEllipse

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.drawing.mapItems.DrawingEllipse

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, Exportable, ParentMapItem, AnchoredMapItem, MapItem.OnGroupChangedListener, MetaDataHolder, PointMapItem.OnPointChangedListener, VisibilityListener

public class DrawingEllipse
extends Shape
implements AnchoredMapItem, ParentMapItem, Exportable, MapItem.OnGroupChangedListener, PointMapItem.OnPointChangedListener

An ellipse with one or more rings of variable radii

Nested Class Summary

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 java.util.List<Ellipse>	_rings
static java.lang.String	COT_TYPE
static int	DEFAULT_STYLE

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

Method Summary

Modifier and Type	Method and Description
PointMapItem	getAnchorItem() The center marker acts as the anchor for this ellipse
double	getAngle() Get angle/heading of this ellipse
double	getArea() Returns the Area of the shape in meters
GeoBounds	getBounds(MutableGeoBounds bounds) Bounds is equivalent to the bonds of the outermost ellipse
GeoPointMetaData	getCenter() Provides the center point for the Shape, or null if an error has occurred.
Marker	getCenterMarker() Get the center marker for this ellipse
GeoPoint	getCenterPoint() Get the center GeoPoint for this ellipse
MapGroup	getChildMapGroup() Get this item's child map group
java.util.List<Ellipse>	getEllipses() Get the list of ellipses part of this group
double	getLength() Get the length of the outer ellipse (parallel to the angle)
GeoPointMetaData[]	getMetaDataPoints() Get all points of the outermost ring
Ellipse	getOutermostEllipse() Get the outer-most ellipse which is used for reading and writing
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	getWidth() Get the width of the outer ellipse (perpendicular to the angle)
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	onClickableChanged() Invokes when the clickable property changes
protected void	onFillColorChanged() Invoked when the fillColor property changes
protected void	onGroupChanged(boolean added, MapGroup group) Keep the child map group with whichever group this ellipse is moved to
protected void	onHeightChanged() Invoked when the height property changes
void	onItemAdded(MapItem item, MapGroup group)
void	onItemRemoved(MapItem item, MapGroup group)
void	onPointChanged(PointMapItem item)
protected void	onStrokeColorChanged() Invoked when the strokeColor property changes
protected void	onStrokeStyleChanged() The line/stroke style for this shape has been changed
protected void	onStrokeWeightChanged() Invoked when the strokeWeight property changes
protected void	onStyleChanged() Invoked when the style property changes
protected void	onVisibleChanged() Invokes when the visible property changes
protected void	onZOrderChanged() Invokes when the zOrder property changes
void	refresh() Refresh child ellipses
void	setAngle(double angle) Set the angle/heading of this ellipse
void	setCenterMarker(Marker marker) Set the center marker
void	setCenterPoint(GeoPointMetaData point) Set the center point of this ellipse This will move the anchor marker as well
void	setDimensions(GeoPointMetaData center, double width, double length, double angle) Set the dimensions of the outer ellipse
void	setEllipses(java.util.List<Ellipse> ellipses) Directly set the ellipses for this group Note: Only the minor axis, major axis, and angle are utilized here Colors and styles must be set directly on parent ellipse
void	setLength(double length) Set the length of the outer ellipse (parallel to the angle)
void	setTitle(java.lang.String title) Set the title of the ellipse, including the name of its center marker
void	setWidth(double width) Set the width of the outer ellipse (perpendicular to the angle)
protected CotEvent	toCot() Generate a CoT event for this ellipse
void	toggleMetaData(java.lang.String key, boolean value)
protected GPXExportWrapper	toGpx()
protected Folder	toKml()
protected KMZFolder	toKmz()
java.lang.Object	toObjectOf(java.lang.Class<?> target, ExportFilters filters) Export to the specified target class type
protected OGRFeatureExportWrapper	toOgrGeometry()

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

addOnBasicLineStyleChangedListener, addOnFillColorChangedListener, addOnPointsChangedListener, addOnStrokeColorChangedListener, addOnStrokeWeightChangedListener, addOnStyleChangedListener, addStyleBits, drawCanvas, findTouchPoint, getBasicLineStyle, getClickPoint, getFillColor, getGeoPointMetaData, getIconColor, getStrokeColor, getStrokeStyle, getStrokeWeight, getStyle, getTitle, onBasicLineStyleChanged, onPointsChanged, preDrawCanvas, 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, 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, onMetadataChanged, onRemoved, onTypeChanged, onVisibilityConditions, 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, 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

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

DEFAULT_STYLE

public static final int DEFAULT_STYLE

See Also:

Constant Field Values

_mapView

protected final MapView _mapView

_childGroup

protected final MapGroup _childGroup

_rings

protected final java.util.List<Ellipse> _rings

_center

protected GeoPointMetaData _center

_centerMarker

protected Marker _centerMarker

Constructor Detail

DrawingEllipse

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

Create a new drawing ellipse

Parameters:

mapView - Map view instance

uid - UID

childGroup - The child map group

DrawingEllipse

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

DrawingEllipse

public DrawingEllipse(MapView mapView)

Method Detail

setEllipses

public void setEllipses(java.util.List<Ellipse> ellipses)

Directly set the ellipses for this group Note: Only the minor axis, major axis, and angle are utilized here Colors and styles must be set directly on parent ellipse

Parameters:

ellipses - List of ellipses

getEllipses

public java.util.List<Ellipse> getEllipses()

Get the list of ellipses part of this group

Returns:

List of ellipses

getOutermostEllipse

public Ellipse getOutermostEllipse()

Get the outer-most ellipse which is used for reading and writing

Returns:

Outer-most ellipse

refresh

public void refresh()

Refresh child ellipses

setCenterPoint

public void setCenterPoint(GeoPointMetaData point)

Set the center point of this ellipse 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()

Get the center GeoPoint for this ellipse

Returns:

Center point

setCenterMarker

public void setCenterMarker(Marker marker)

Set the center marker

Parameters:

marker - Center marker

getCenterMarker

public Marker getCenterMarker()

Get the center marker for this ellipse

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

getAngle

public double getAngle()

Get angle/heading of this ellipse

Returns:

Angle in degrees

setAngle

public void setAngle(double angle)

Set the angle/heading of this ellipse

Parameters:

angle - Angle in degrees

getWidth

public double getWidth()

Get the width of the outer ellipse (perpendicular to the angle)

Returns:

Width in meters

setWidth

public void setWidth(double width)

Set the width of the outer ellipse (perpendicular to the angle)

Parameters:

width - Width in meters

getLength

public double getLength()

Get the length of the outer ellipse (parallel to the angle)

Returns:

Length in meters

setLength

public void setLength(double length)

Set the length of the outer ellipse (parallel to the angle)

Parameters:

length - Length in meters

setDimensions

public void setDimensions(GeoPointMetaData center,
                          double width,
                          double length,
                          double angle)

Set the dimensions of the outer ellipse

Parameters:

center - Center point

width - Width of the ellipse in meters

length - Length of the ellipse in meters

angle - Angle/heading in degrees

getAnchorItem

public PointMapItem getAnchorItem()

The center marker acts as the anchor for this ellipse

Specified by:

getAnchorItem in interface AnchoredMapItem

Returns:

Center marker or underlying shape marker

getMetaDataPoints

public GeoPointMetaData[] getMetaDataPoints()

Get all points of the outermost ring

Specified by:

getMetaDataPoints in class Shape

Returns:

Array of points

getPoints

public GeoPoint[] getPoints()

Get all points of the outermost ring

Specified by:

getPoints in class Shape

Returns:

Array of points

getBounds

public GeoBounds getBounds(MutableGeoBounds bounds)

Bounds is equivalent to the bonds of the outermost ellipse

Specified by:

getBounds in class Shape

Parameters:

bounds - a preallocated bounds object

Returns:

the upper left and lower right of the shape.

setTitle

public void setTitle(java.lang.String title)

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

Overrides:

setTitle in class Shape

Parameters:

title - Ellipse title

onStyleChanged

protected void onStyleChanged()

Description copied from class: Shape

Invoked when the style property changes

Overrides:

onStyleChanged in class Shape

onStrokeStyleChanged

protected void onStrokeStyleChanged()

Description copied from class: Shape

The line/stroke style for this shape has been changed

Overrides:

onStrokeStyleChanged in class Shape

onVisibleChanged

protected void onVisibleChanged()

Description copied from class: MapItem

Invokes when the visible property changes

Overrides:

onVisibleChanged in class MapItem

onClickableChanged

protected void onClickableChanged()

Description copied from class: MapItem

Invokes when the clickable property changes

Overrides:

onClickableChanged in class MapItem

onZOrderChanged

protected void onZOrderChanged()

Description copied from class: MapItem

Invokes when the zOrder property changes

Overrides:

onZOrderChanged in class MapItem

onFillColorChanged

protected void onFillColorChanged()

Description copied from class: Shape

Invoked when the fillColor property changes

Overrides:

onFillColorChanged in class Shape

onStrokeColorChanged

protected void onStrokeColorChanged()

Description copied from class: Shape

Invoked when the strokeColor property changes

Overrides:

onStrokeColorChanged in class Shape

onStrokeWeightChanged

protected void onStrokeWeightChanged()

Description copied from class: Shape

Invoked when the strokeWeight property changes

Overrides:

onStrokeWeightChanged in class Shape

onHeightChanged

protected void onHeightChanged()

Description copied from class: MapItem

Invoked when the height property changes

Overrides:

onHeightChanged in class MapItem

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

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

toggleMetaData

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

Overrides:

toggleMetaData in class FilterMetaDataHolder

onGroupChanged

protected void onGroupChanged(boolean added,
                              MapGroup group)

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

Overrides:

onGroupChanged in class MapItem

Parameters:

added - True if ellipse 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

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 ellipse

Returns:

New CoT event or null if failed

toKml

protected Folder toKml()

toKmz

protected KMZFolder toKmz()

toGpx

protected GPXExportWrapper toGpx()

toOgrGeometry

protected OGRFeatureExportWrapper toOgrGeometry()