Shape

java.lang.Object
- com.atakmap.android.maps.FilterMetaDataHolder
- - com.atakmap.android.maps.MapItem
  - - com.atakmap.android.maps.Shape

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, MetaDataHolder, VisibilityListener

Direct Known Subclasses:

Arrow, Association, AutoSizeAngleOverlayShape, DrawingCircle, DrawingEllipse, FahArrowWidget.Item, ImageOverlay, MetaShape, Polyline, SensorFOV
```
public abstract class Shape
extends MapItem
implements Capturable
```
Abstract base for any MapItem with shape-like properties

See Also:

Ellipse

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Shape.OnBasicLineStyleChangedListener`
`static interface`	`Shape.OnFillColorChangedListener` Shape fillColor property listener
`static interface`	`Shape.OnPointsChangedListener` Points property listener
`static interface`	`Shape.OnStrokeColorChangedListener` Shape strokeColor property listener
`static interface`	`Shape.OnStrokeWeightChangedListener` Shape strokeWeight property listener
`static interface`	`Shape.OnStyleChangedListener` Shape style property listener

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 int`	`BASIC_LINE_STYLE_DASHED`
`static int`	`BASIC_LINE_STYLE_DOTTED`
`static int`	`BASIC_LINE_STYLE_OUTLINED`
`static int`	`BASIC_LINE_STYLE_SOLID` Basic line styles.
`static int`	`STYLE_FILLED_MASK`
`static int`	`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
Modifier Constructor and Description

protected Shape(long serialId, MetaDataHolder metadata, java.lang.String uid)

protected Shape(java.lang.String uid)

Constructors
Modifier	Constructor and Description
`protected`	`Shape(long serialId, MetaDataHolder metadata, java.lang.String uid)`
`protected`	`Shape(java.lang.String uid)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addOnBasicLineStyleChangedListener(Shape.OnBasicLineStyleChangedListener listener)` Listen for when the style is changed for the basic line style.
`void`	`addOnFillColorChangedListener(Shape.OnFillColorChangedListener listener)` Add a fillColor property listener
`void`	`addOnPointsChangedListener(Shape.OnPointsChangedListener listener)` Add a point changed property listener
`void`	`addOnStrokeColorChangedListener(Shape.OnStrokeColorChangedListener listener)` Add a strokeColor property listener
`void`	`addOnStrokeWeightChangedListener(Shape.OnStrokeWeightChangedListener listener)` Add a strokeWeight property listener
`void`	`addOnStyleChangedListener(Shape.OnStyleChangedListener listener)` Add a style property listener
`void`	`addStyleBits(int styleBits)`
`void`	`drawCanvas(CapturePP cap, android.os.Bundle data)` Draw the item to the canvas
`GeoPoint`	`findTouchPoint()` Deprecated. `getClickPoint()`
`double`	`getArea()` Returns the Area of the shape in meters
`int`	`getBasicLineStyle()` Returns the current state of the Basic Line Style.
`abstract GeoBounds`	`getBounds(MutableGeoBounds bounds)` The bounds of the shape
`GeoPointMetaData`	`getCenter()` Provides the center point for the Shape, or null if an error has occurred.
`GeoPoint`	`getClickPoint()` Look for the last touched point on this item
`int`	`getFillColor()` Get the fillColor property value
`GeoPointMetaData`	`getGeoPointMetaData()` Get point metadata for this shape, usually at the center point
`int`	`getIconColor()` Get the color this shape should use for its icon Usually this is the stroke color or the "iconColor" meta int
`abstract GeoPointMetaData[]`	`getMetaDataPoints()` The array of points that make up the shape with the corresponding metadata.
`double`	`getPerimeterOrLength()` Returns the perimeter of a shape if closed otherwise will return the length of of the open shape from start to end.
`abstract GeoPoint[]`	`getPoints()` The array of points without any metadata
`int`	`getStrokeColor()` Get the strokeColor property value
`int`	`getStrokeStyle()` Get the line style for this shape For now acts a redirect for `getBasicLineStyle()` for the sake of having a more intuitive API
`double`	`getStrokeWeight()` Get the strokeWeight property value
`int`	`getStyle()` Get the style property value
`java.lang.String`	`getTitle()` Get the title of this map item (display name)
`protected void`	`onBasicLineStyleChanged()`
`protected void`	`onFillColorChanged()` Invoked when the fillColor property changes
`protected void`	`onPointsChanged()`
`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
`android.os.Bundle`	`preDrawCanvas(CapturePP capture)` Save forwarded points to meta data holder These will be used later in drawCanvas
`void`	`removeOnBasicLineStyleChangedListener(Shape.OnBasicLineStyleChangedListener listener)` Remove the listener for the basic line style change
`void`	`removeOnFillColorChangedListener(Shape.OnFillColorChangedListener listener)` Remove a fillColor property listener
`void`	`removeOnPointsChangedListener(Shape.OnPointsChangedListener listener)` Remove a point changed property listener
`void`	`removeOnStrokeColorChangedListener(Shape.OnStrokeColorChangedListener listener)` Remove a strokeColor property listener
`void`	`removeOnStrokeWeightChangedListener(Shape.OnStrokeWeightChangedListener listener)` Remove a strokeWeight property listener
`void`	`removeOnStyleChangedListener(Shape.OnStyleChangedListener listener)` Remove a style property listener
`void`	`removeStyleBits(int styleBits)`
`void`	`setBasicLineStyle(int basicLineStyle)` Change the basic line style for the shape from either SOLID, DASHED or DOTTED
`void`	`setColor(int color)`
`void`	`setColor(int color, boolean includeAlpha)` Sets both the stroke and fill color while maintaining fill alpha
`void`	`setFillAlpha(int alpha)` Set the alpha value for the fill color
`void`	`setFillColor(int fillColor)` Set the fillColor property value
`void`	`setStrokeColor(int strokeColor)` Set the strokeColor property value
`void`	`setStrokeStyle(int lineStyle)` Get the line style for this shape For now acts a redirect for `setBasicLineStyle(int)` for the sake of having a more intuitive API
`void`	`setStrokeWeight(double strokeWeight)` 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 this map item (display name)
`void`	`setTouchPoint(GeoPoint point)` Deprecated. `MapItem.setClickPoint(GeoPoint)`
`boolean`	`wrap180()` Whether to wrap shapes that span more than 180 degrees over the IDL instead of over the prime meridian

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, onMetadataChanged, onRemoved, onTypeChanged, onVisibilityConditions, onVisibleChanged, 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, 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
  - STYLE_FILLED_MASK
```
public static final int STYLE_FILLED_MASK
```
    See Also:
    
    Constant Field Values
  - STYLE_STROKE_MASK
```
public static final int STYLE_STROKE_MASK
```
    See Also:
    
    Constant Field Values
  - BASIC_LINE_STYLE_SOLID
```
public static final int BASIC_LINE_STYLE_SOLID
```
    Basic line styles.
    
    See Also:
    
    Constant Field Values
  - BASIC_LINE_STYLE_DASHED
```
public static final int BASIC_LINE_STYLE_DASHED
```
    See Also:
    
    Constant Field Values
  - BASIC_LINE_STYLE_DOTTED
```
public static final int BASIC_LINE_STYLE_DOTTED
```
    See Also:
    
    Constant Field Values
  - BASIC_LINE_STYLE_OUTLINED
```
public static final int BASIC_LINE_STYLE_OUTLINED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Shape
```
protected Shape(java.lang.String uid)
```
  - Shape
```
protected Shape(long serialId,
                MetaDataHolder metadata,
                java.lang.String uid)
```
- Method Detail
  - addOnStyleChangedListener
```
public void addOnStyleChangedListener(Shape.OnStyleChangedListener listener)
```
    Add a style property listener
    
    Parameters:
    
    listener - the listener
  - removeOnStyleChangedListener
```
public void removeOnStyleChangedListener(Shape.OnStyleChangedListener listener)
```
    Remove a style property listener
    
    Parameters:
    
    listener - the listener
  - addOnStrokeColorChangedListener
```
public void addOnStrokeColorChangedListener(Shape.OnStrokeColorChangedListener listener)
```
    Add a strokeColor property listener
    
    Parameters:
    
    listener - the listener
  - removeOnStrokeColorChangedListener
```
public void removeOnStrokeColorChangedListener(Shape.OnStrokeColorChangedListener listener)
```
    Remove a strokeColor property listener
    
    Parameters:
    
    listener - the listener
  - addOnFillColorChangedListener
```
public void addOnFillColorChangedListener(Shape.OnFillColorChangedListener listener)
```
    Add a fillColor property listener
    
    Parameters:
    
    listener - the listener
  - removeOnFillColorChangedListener
```
public void removeOnFillColorChangedListener(Shape.OnFillColorChangedListener listener)
```
    Remove a fillColor property listener
    
    Parameters:
    
    listener - the listener
  - addOnStrokeWeightChangedListener
```
public void addOnStrokeWeightChangedListener(Shape.OnStrokeWeightChangedListener listener)
```
    Add a strokeWeight property listener
    
    Parameters:
    
    listener - the listener
  - removeOnStrokeWeightChangedListener
```
public void removeOnStrokeWeightChangedListener(Shape.OnStrokeWeightChangedListener listener)
```
    Remove a strokeWeight property listener
    
    Parameters:
    
    listener - the listener
  - addOnPointsChangedListener
```
public void addOnPointsChangedListener(Shape.OnPointsChangedListener listener)
```
    Add a point changed property listener
    
    Parameters:
    
    listener - the listener
  - removeOnPointsChangedListener
```
public void removeOnPointsChangedListener(Shape.OnPointsChangedListener listener)
```
    Remove a point changed property listener
    
    Parameters:
    
    listener - the listener
  - getTitle
```
public java.lang.String getTitle()
```
    Description copied from class: MapItem
    
    Get the title of this map item (display name)
    
    Specified by:
    
    getTitle in interface URIContent
    
    Overrides:
    
    getTitle in class MapItem
    
    Returns:
    
    Item title or null if N/A
  - 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 MapItem
    
    Parameters:
    
    title - Item title
  - getStyle
```
public int getStyle()
```
    Get the style property value
    
    Returns:
    
    a bitfield of any STYLE_*_MASK flags from Shape or specific subclass
  - setStyle
```
public void setStyle(int style)
```
    Set the style property value
    
    Parameters:
    
    style - a bitfield of any STYLE_*_MASK flags from Shape or specific subclass
  - addStyleBits
```
public void addStyleBits(int styleBits)
```
  - removeStyleBits
```
public void removeStyleBits(int styleBits)
```
  - getStrokeColor
```
public int getStrokeColor()
```
    Get the strokeColor property value
    
    Returns:
    
    An argb packed Color
  - setStrokeColor
```
public void setStrokeColor(int strokeColor)
```
    Set the strokeColor property value
    
    Parameters:
    
    strokeColor - An argb packed Color
  - getFillColor
```
public int getFillColor()
```
    Get the fillColor property value
    
    Returns:
    
    An argb packed Color
  - setFillColor
```
public void setFillColor(int fillColor)
```
    Set the fillColor property value
    
    Parameters:
    
    fillColor - An argb packed Color
  - setFillAlpha
```
public void setFillAlpha(int alpha)
```
    Set the alpha value for the fill color
    
    Parameters:
    
    alpha - Color alpha (0 to 255)
  - setColor
```
public void setColor(int color,
                     boolean includeAlpha)
```
    Sets both the stroke and fill color while maintaining fill alpha
    
    Parameters:
    
    color - An argb packed Color
    
    includeAlpha - Include the color alpha in the fill color
  - setColor
```
public void setColor(int color)
```
  - setStrokeWeight
```
public void setStrokeWeight(double strokeWeight)
```
    Set the stroke weight of this shape's lines Minimum = 1.0, maximum = 6.0
    
    Parameters:
    
    strokeWeight - a stroke line width
  - getStrokeWeight
```
public double getStrokeWeight()
```
    Get the strokeWeight property value
    
    Returns:
    
    the weight as a number scaled by density.
  - setStrokeStyle
```
public final void setStrokeStyle(int lineStyle)
```
    Get the line style for this shape For now acts a redirect for setBasicLineStyle(int) for the sake of having a more intuitive API
  - getStrokeStyle
```
public final int getStrokeStyle()
```
    Get the line style for this shape For now acts a redirect for getBasicLineStyle() for the sake of having a more intuitive API
    
    Returns:
    
    Line style
  - getIconColor
```
public int getIconColor()
```
    Get the color this shape should use for its icon Usually this is the stroke color or the "iconColor" meta int
    
    Specified by:
    
    getIconColor in interface URIContent
    
    Overrides:
    
    getIconColor in class MapItem
    
    Returns:
    
    Icon color
  - onStyleChanged
```
protected void onStyleChanged()
```
    Invoked when the style property changes
  - onStrokeColorChanged
```
protected void onStrokeColorChanged()
```
    Invoked when the strokeColor property changes
  - onFillColorChanged
```
protected void onFillColorChanged()
```
    Invoked when the fillColor property changes
  - onStrokeWeightChanged
```
protected void onStrokeWeightChanged()
```
    Invoked when the strokeWeight property changes
  - setBasicLineStyle
```
public void setBasicLineStyle(int basicLineStyle)
```
    Change the basic line style for the shape from either SOLID, DASHED or DOTTED
    
    Parameters:
    
    basicLineStyle - one of Shape.SOLID, Shape.DASHED or Shape.DOTTED
  - getBasicLineStyle
```
public int getBasicLineStyle()
```
    Returns the current state of the Basic Line Style.
    
    Returns:
    
    the basic line style for the shape (SOLID, DASHED or DOTTED).
  - addOnBasicLineStyleChangedListener
```
public void addOnBasicLineStyleChangedListener(Shape.OnBasicLineStyleChangedListener listener)
```
    Listen for when the style is changed for the basic line style.
    
    Parameters:
    
    listener - the listener to be called when the basic style is changed.
  - removeOnBasicLineStyleChangedListener
```
public void removeOnBasicLineStyleChangedListener(Shape.OnBasicLineStyleChangedListener listener)
```
    Remove the listener for the basic line style change
    
    Parameters:
    
    listener - the listener to be removed.
  - onBasicLineStyleChanged
```
protected void onBasicLineStyleChanged()
```
  - onStrokeStyleChanged
```
protected void onStrokeStyleChanged()
```
    The line/stroke style for this shape has been changed
  - onPointsChanged
```
protected void onPointsChanged()
```
  - getCenter
```
public GeoPointMetaData getCenter()
```
    Provides the center point for the Shape, or null if an error has occurred.
  - getGeoPointMetaData
```
public GeoPointMetaData getGeoPointMetaData()
```
    Get point metadata for this shape, usually at the center point
    
    Returns:
    
    Point metadata
  - getClickPoint
```
public GeoPoint getClickPoint()
```
    Description copied from class: MapItem
    
    Look for the last touched point on this item
    
    Overrides:
    
    getClickPoint in class MapItem
    
    Returns:
    
    The last geo point that was touched or null if N/A
  - findTouchPoint
```
@Deprecated
public GeoPoint findTouchPoint()
```
    Deprecated. getClickPoint()
  - setTouchPoint
```
@Deprecated
public void setTouchPoint(GeoPoint point)
```
    Deprecated. MapItem.setClickPoint(GeoPoint)
  - wrap180
```
public boolean wrap180()
```
    Whether to wrap shapes that span more than 180 degrees over the IDL instead of over the prime meridian
    
    Returns:
    
    True to wrap across IDL when longitudinal span >180 degrees
  - preDrawCanvas
```
public android.os.Bundle preDrawCanvas(CapturePP capture)
```
    Description copied from interface: Capturable
    
    Save forwarded points to meta data holder These will be used later in drawCanvas
    
    Specified by:
    
    preDrawCanvas in interface Capturable
    
    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
    
    Parameters:
    
    cap - Canvas to draw to (use getCanvas())
    
    data - Point data saved in preDrawCanvas
  - getPoints
```
public abstract GeoPoint[] getPoints()
```
    The array of points without any metadata
    
    Returns:
    
    the points
  - getArea
```
public double getArea()
```
    Returns the Area of the shape in meters
    
    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()
```
    Returns the perimeter of a shape if closed otherwise will return the length of of the open shape from start to end.
  - getMetaDataPoints
```
public abstract GeoPointMetaData[] getMetaDataPoints()
```
    The array of points that make up the shape with the corresponding metadata.
    
    Returns:
    
    the points.
  - getBounds
```
public abstract GeoBounds getBounds(MutableGeoBounds bounds)
```
    The bounds of the shape
    
    Parameters:
    
    bounds - a preallocated bounds object
    
    Returns:
    
    the upper left and lower right of the shape.

Class Shape

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

STYLE_FILLED_MASK

STYLE_STROKE_MASK

BASIC_LINE_STYLE_SOLID

BASIC_LINE_STYLE_DASHED

BASIC_LINE_STYLE_DOTTED

BASIC_LINE_STYLE_OUTLINED

Constructor Detail

Shape

Shape

Method Detail

addOnStyleChangedListener

removeOnStyleChangedListener

addOnStrokeColorChangedListener

removeOnStrokeColorChangedListener

addOnFillColorChangedListener

removeOnFillColorChangedListener

addOnStrokeWeightChangedListener

removeOnStrokeWeightChangedListener

addOnPointsChangedListener

removeOnPointsChangedListener

getTitle

setTitle

getStyle

setStyle

addStyleBits

removeStyleBits

getStrokeColor

setStrokeColor

getFillColor

setFillColor

setFillAlpha

setColor

setColor

setStrokeWeight

getStrokeWeight

setStrokeStyle

getStrokeStyle

getIconColor

onStyleChanged

onStrokeColorChanged

onFillColorChanged

onStrokeWeightChanged

setBasicLineStyle

getBasicLineStyle

addOnBasicLineStyleChangedListener

removeOnBasicLineStyleChangedListener

onBasicLineStyleChanged

onStrokeStyleChanged

onPointsChanged

getCenter

getGeoPointMetaData

getClickPoint

findTouchPoint

setTouchPoint

wrap180

preDrawCanvas

drawCanvas

getPoints

getArea

getPerimeterOrLength

getMetaDataPoints

getBounds