com.atakmap.android.maps

Class Ellipse

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.maps.Polyline

com.atakmap.android.maps.Ellipse

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, MetaDataHolder, VisibilityListener

public class Ellipse
extends Polyline

An ellipse with a width, length, and angle Angle - The "heading" of the ellipse in true north Length - The diameter of the ellipse that runs parallel to the angle Width - The diameter of the ellipse that runs perpendicular to the angle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Ellipse.OnEllipseFillTypeChangedListener Listen for property fill changes on the Ellipse.
static interface	Ellipse.OnEllipsePropertiesChangedListener Listen for property changes on the Ellipse.

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

Polyline.OnAltitudeModeChangedListener, Polyline.OnHeightStyleChangedListener, Polyline.OnLabelsChangedListener, Polyline.OnLabelTextSizeChanged

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.OnClickableChangedListener, MapItem.OnGroupChangedListener, MapItem.OnHeightChangedListener, MapItem.OnMetadataChangedListener, MapItem.OnTypeChangedListener, MapItem.OnVisibleChangedListener, MapItem.OnZOrderChangedListener

Field Summary

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

_points, DEFAULT_MAX_LABEL_RENDER_RESOLUTION, DEFAULT_MAX_LINE_RENDER_RESOLUTION, DEFAULT_MIN_LABEL_RENDER_RESOLUTION, DEFAULT_MIN_LINE_RENDER_RESOLUTION, HEIGHT_EXTRUDE_CENTER_ALT, HEIGHT_EXTRUDE_DEFAULT, HEIGHT_EXTRUDE_MAX_ALT, HEIGHT_EXTRUDE_MIN_ALT, HEIGHT_EXTRUDE_PER_POINT, HEIGHT_STYLE_NONE, HEIGHT_STYLE_OUTLINE, HEIGHT_STYLE_OUTLINE_SIMPLE, HEIGHT_STYLE_POLYGON, HEIGHT_STYLE_TOP_ONLY, minimumBoundingBox, PARTITION_SIZE, STYLE_CLOSED_MASK, STYLE_OUTLINE_HALO_MASK, STYLE_OUTLINE_STROKE_MASK

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
Ellipse(long serialId, MetaDataHolder metadata, java.lang.String uid)
Ellipse(java.lang.String uid)

Method Summary

Modifier and Type	Method and Description
void	addOnEllipseFillTypeChangedListener(Ellipse.OnEllipseFillTypeChangedListener l) Add a listener to know when the fill type for an ellipse is changed.
void	addOnEllipsePropChangedListener(Ellipse.OnEllipsePropertiesChangedListener l) Add a listener to know when any of the ellipse properties are changed.
double	getAngle() Returns the angle for the ellipse
double	getArea() Returns the Area of the shape in meters
GeoPointMetaData	getCenter() Provides the center point for the Shape, or null if an error has occurred.
int	getFillStyle() Returns the fill style for this ellipse.
double	getLength() Returns the length (parallel diameter) of the ellipse
double	getMajorAxis() Get the major axis diameter
double	getMajorRadius() Get the major axis radius
double	getMinorAxis() Get the minor axis diameter
double	getMinorRadius() Get the minor axis radius
double	getPerimeterOrLength() Returns the perimeter of a shape if closed otherwise will return the length of of the open shape from start to end.
int	getSweepEnd() Returns the sweep end.
int	getSweepStart() Returns the sweep start.
double	getWidth() Returns the width (perpendicular diameter) of the ellipse
void	removeOnEllipseFillTypeChangedListener(Ellipse.OnEllipseFillTypeChangedListener l) Remove a listener registered to listen when the fill type is changed.
void	removeOnEllipsePropChangedListener(Ellipse.OnEllipsePropertiesChangedListener l) Remove a listener when any of the ellipse properties are changed.
void	setAltitudeMode(AltitudeMode altMode) Set the altitude mode for this item See AltitudeMode for possible values
void	setAngle(double newAngle) Set the new angle of rotation for the ellipse
protected boolean	setAngleImpl(double newAngle)
void	setCenter(GeoPointMetaData newCenter) Set the new center point for the ellipse.
void	setCenterHeightWidth(GeoPointMetaData newCenter, double newH, double newW) Deprecated. Use setDimensions(GeoPointMetaData, double, double)
void	setCenterHeightWidthAngle(GeoPointMetaData newCenter, double newH, double newW, double newAngle) Deprecated. Use setDimensions(GeoPointMetaData, double, double, double)
protected boolean	setCenterImpl(GeoPointMetaData newCenter)
void	setDimensions(double minorRadius, double majorRadius) Sets the dimensions of the ellipse using the minor and major values in meters
void	setDimensions(GeoPointMetaData center, double minorRadius, double majorRadius) Sets the dimensions and location of the ellipse using the minor and major values in meters
void	setDimensions(GeoPointMetaData center, double minorRadius, double majorRadius, double angle) Sets the dimensions and location of the ellipse using the minor and major values in meters Based on the CoT Shape Schema, the angle represents the orientation of the major axis.
void	setFillStyle(int newFill) Sets the fill style
void	setHeightWidth(double newH, double newW) Deprecated. Use setDimensions(double, double)
void	setLength(double length) Sets the length (parallel diameter) of the ellipse
void	setMajorRadius(double radius) Set the radius of the major axis The major axis is the longer diameter in the ellipse It's recommended to use setWidth(double) or setLength(double) instead
protected boolean	setMajorRadiusImpl(double radius)
void	setMinorRadius(double radius) Set the radius of the minor axis The minor axis is the shorter diameter in the ellipse It's recommended to use setWidth(double) or setLength(double) instead
protected boolean	setMinorRadiusImpl(double radius)
void	setSweep(int start, int end) Sets a sweep for a ellipse.
void	setWidth(double width) Sets the width (perpendicular diameter) of the ellipse

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

addHeightStyle, addOnHeightStyleChangedListener, addOnLabelsChangedListener, addOnLabelTextSizeChangedListener, drawCanvas, getBounds, getHeightExtrudeMode, getHeightStyle, getLabels, getLabelTextSize, getLabelTypeface, getLineLabel, getMetaDataPoints, getPoints, getPoints, getPoints, getRelativeBounds, getTotalDistance, onHeightStyleChanged, onLabelsChanged, onLabelTextSizeChanged, onMetadataChanged, onPointsChanged, preDrawCanvas, removeHeightStyle, removeOnHeightStyleChangedListener, removeOnLabelsChangedListener, removeOnLabelTextSizeChangedListner, setHeightExtrudeMode, setHeightStyle, setLabels, setLabelTextSize, setLabelTextSize, setLabelTextTypeface, setLineLabel, setMaxLabelRenderResolution, setMaxRenderResolution, setMinLabelRenderResolution, setMinRenderResolution, setPoints, setPoints, setPoints, setPoints

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, onStrokeColorChanged, onStrokeStyleChanged, onStrokeWeightChanged, onStyleChanged, removeOnBasicLineStyleChangedListener, removeOnFillColorChangedListener, removeOnPointsChangedListener, removeOnStrokeColorChangedListener, removeOnStrokeWeightChangedListener, removeOnStyleChangedListener, removeStyleBits, setBasicLineStyle, setColor, setColor, setFillAlpha, setFillColor, setStrokeColor, setStrokeStyle, setStrokeWeight, setStyle, setTitle, 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, onGroupChanged, onHeightChanged, onRemoved, onTypeChanged, onVisibilityConditions, onVisibleChanged, onZOrderChanged, persist, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, 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, toggleMetaData

Methods inherited from class java.lang.Object

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

Constructor Detail

Ellipse

public Ellipse(java.lang.String uid)

Ellipse

public Ellipse(long serialId,
               MetaDataHolder metadata,
               java.lang.String uid)

Method Detail

addOnEllipsePropChangedListener

public void addOnEllipsePropChangedListener(Ellipse.OnEllipsePropertiesChangedListener l)

Add a listener to know when any of the ellipse properties are changed.

Parameters:

l - the listener to add

removeOnEllipsePropChangedListener

public void removeOnEllipsePropChangedListener(Ellipse.OnEllipsePropertiesChangedListener l)

Remove a listener when any of the ellipse properties are changed.

Parameters:

l - the listener to remove

addOnEllipseFillTypeChangedListener

public void addOnEllipseFillTypeChangedListener(Ellipse.OnEllipseFillTypeChangedListener l)

Add a listener to know when the fill type for an ellipse is changed.

Parameters:

l - the listener to add

removeOnEllipseFillTypeChangedListener

public void removeOnEllipseFillTypeChangedListener(Ellipse.OnEllipseFillTypeChangedListener l)

Remove a listener registered to listen when the fill type is changed.

Parameters:

l - the listener to add

setAngle

public void setAngle(double newAngle)

Set the new angle of rotation for the ellipse

Parameters:

newAngle - the angle of rotation in degrees true north.

setAngleImpl

protected boolean setAngleImpl(double newAngle)

getAngle

public double getAngle()

Returns the angle for the ellipse

Returns:

the angle for the ellipse in degrees true north.

getWidth

public double getWidth()

Returns the width (perpendicular diameter) of the ellipse

Returns:

Width in meters

setWidth

public void setWidth(double width)

Sets the width (perpendicular diameter) of the ellipse

Parameters:

width - Width in meters

getLength

public double getLength()

Returns the length (parallel diameter) of the ellipse

Returns:

Length in meters

setLength

public void setLength(double length)

Sets the length (parallel diameter) of the ellipse

Parameters:

length - Length in meters

setMajorRadius

public void setMajorRadius(double radius)

Set the radius of the major axis The major axis is the longer diameter in the ellipse It's recommended to use setWidth(double) or setLength(double) instead

Parameters:

radius - Radius in meters

setMajorRadiusImpl

protected boolean setMajorRadiusImpl(double radius)

getMajorRadius

public double getMajorRadius()

Get the major axis radius

Returns:

Radius in meters

getMajorAxis

public double getMajorAxis()

Get the major axis diameter

Returns:

Diameter in meters

setMinorRadius

public void setMinorRadius(double radius)

Set the radius of the minor axis The minor axis is the shorter diameter in the ellipse It's recommended to use setWidth(double) or setLength(double) instead

Parameters:

radius - Radius in meters

setMinorRadiusImpl

protected boolean setMinorRadiusImpl(double radius)

getMinorRadius

public double getMinorRadius()

Get the minor axis radius

Returns:

Radius in meters

getMinorAxis

public double getMinorAxis()

Get the minor axis diameter

Returns:

Diameter in meters

setCenter

public void setCenter(GeoPointMetaData newCenter)

Set the new center point for the ellipse.

Parameters:

newCenter - the new centerpoint.

setCenterImpl

protected boolean setCenterImpl(GeoPointMetaData newCenter)

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 Polyline

setDimensions

public void setDimensions(double minorRadius,
                          double majorRadius)

Sets the dimensions of the ellipse using the minor and major values in meters

Parameters:

minorRadius - the minor radius in meters

majorRadius - the major radius in meters

setDimensions

public void setDimensions(GeoPointMetaData center,
                          double minorRadius,
                          double majorRadius)

Sets the dimensions and location of the ellipse using the minor and major values in meters

Parameters:

center - the center of the elipse

minorRadius - the minor radius in meters

majorRadius - the major radius in meters

setDimensions

public void setDimensions(GeoPointMetaData center,
                          double minorRadius,
                          double majorRadius,
                          double angle)

Sets the dimensions and location of the ellipse using the minor and major values in meters Based on the CoT Shape Schema, the angle represents the orientation of the major axis. Therefore the major radius in this context always corresponds to the length of the ellipse.

Parameters:

center - the center of the ellipse

minorRadius - the minor radius in meters

majorRadius - the major radius in meters

angle - the angle of the ellipse in degrees clock wise.

getSweepStart

public int getSweepStart()

Returns the sweep start. In the case of a full ellipse start will equal end or start = 0 and end = 360.

getSweepEnd

public int getSweepEnd()

Returns the sweep end. In the case of a full ellipse start will equal end or start = 0 and end = 360.

setSweep

public void setSweep(int start,
                     int end)

Sets a sweep for a ellipse.

Parameters:

start - must be a number ranging from [0, 360].

end - must be a number ranging from [0, 360].

setFillStyle

public void setFillStyle(int newFill)

Sets the fill style

Parameters:

newFill - the fill style one 1 for filled or 0 for unfilled.

getFillStyle

public int getFillStyle()

Returns the fill style for this ellipse.

Returns:

fill style which can be either 1 for filled or 0 for unfilled.

setAltitudeMode

public void setAltitudeMode(AltitudeMode altMode)

Description copied from class: MapItem

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

Overrides:

setAltitudeMode in class MapItem

Parameters:

altMode - Altitude mode

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 Polyline

setHeightWidth

@Deprecated
public void setHeightWidth(double newH,
                                       double newW)

Deprecated. Use setDimensions(double, double)

Sets the height and width of the ellipse. Calling this will reduce the number of full calculations performed when setting height and width separately.

Parameters:

newW - the width in meters.

newH - the height in meters.

setCenterHeightWidth

@Deprecated
public void setCenterHeightWidth(GeoPointMetaData newCenter,
                                             double newH,
                                             double newW)

Deprecated. Use setDimensions(GeoPointMetaData, double, double)

Sets the height, width and center point of the ellipse. Calling this will reduce the number of full calculations performed when setting height and width and center separately.

Parameters:

newCenter - the center of the ellipse.

newW - the width in meters.

newH - the height in meters.

setCenterHeightWidthAngle

@Deprecated
public void setCenterHeightWidthAngle(GeoPointMetaData newCenter,
                                                  double newH,
                                                  double newW,
                                                  double newAngle)

Deprecated. Use setDimensions(GeoPointMetaData, double, double, double)

Sets the height, width and center point of the ellipse. Calling this will reduce the number of full calculations performed when setting height, width, center and angle separately.

Parameters:

newCenter - the center of the ellipse.

newW - the width in meters.

newH - the height in meters.

newAngle - the angle in degrees