com.atakmap.android.maps

Class Polyline

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.maps.Polyline

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, MetaDataHolder, VisibilityListener

Direct Known Subclasses:

AxisOfAdvance, Circle, Doghouse, EditablePolyline, Ellipse, MsdShape, SimpleRectangle, TrackPolyline, Wedge

public class Polyline
extends Shape

A Shape made up of GeoPoints connected by lines and optionally closed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Polyline.OnAltitudeModeChangedListener Deprecated.
static interface	Polyline.OnHeightStyleChangedListener
static interface	Polyline.OnLabelsChangedListener
static interface	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

Modifier and Type	Field and Description
protected java.util.ArrayList<GeoPointMetaData>	_points
static double	DEFAULT_MAX_LABEL_RENDER_RESOLUTION Maximum label render resolution for a polyline that is inside the render window.
static double	DEFAULT_MAX_LINE_RENDER_RESOLUTION The maximum line render resolution for a Polyline.
static double	DEFAULT_MIN_LABEL_RENDER_RESOLUTION Minimum label render resolution for a polyline that is inside the render window.
static double	DEFAULT_MIN_LINE_RENDER_RESOLUTION The minimum line render resolution for a Polyline.
static int	HEIGHT_EXTRUDE_CENTER_ALT Methods for how to extrude the shape's height (mutually exclusive)
static int	HEIGHT_EXTRUDE_DEFAULT Methods for how to extrude the shape's height (mutually exclusive)
static int	HEIGHT_EXTRUDE_MAX_ALT Methods for how to extrude the shape's height (mutually exclusive)
static int	HEIGHT_EXTRUDE_MIN_ALT Methods for how to extrude the shape's height (mutually exclusive)
static int	HEIGHT_EXTRUDE_PER_POINT Methods for how to extrude the shape's height (mutually exclusive)
static int	HEIGHT_STYLE_NONE Height styles (bit masks)
static int	HEIGHT_STYLE_OUTLINE Height styles (bit masks)
static int	HEIGHT_STYLE_OUTLINE_SIMPLE Height styles (bit masks)
static int	HEIGHT_STYLE_POLYGON Height styles (bit masks)
static int	HEIGHT_STYLE_TOP_ONLY Height styles (bit masks)
protected MutableGeoBounds	minimumBoundingBox
static int	PARTITION_SIZE
static int	STYLE_CLOSED_MASK A line will be drawn from the last point to the first and the STYLE_SHAPE_FILLED_MASK will take effect (if exists)
static int	STYLE_OUTLINE_HALO_MASK Adds a halo around the polyline with the same color that was used in the stroke.
static int	STYLE_OUTLINE_STROKE_MASK Adds a thin black outline on the stroke line which increases visual distinction.

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

Method Summary

Modifier and Type	Method and Description
void	addHeightStyle(int heightStyleBit) Add a single height style bit to this shape Example: HEIGHT_STYLE_OUTLINE
void	addOnHeightStyleChangedListener(Polyline.OnHeightStyleChangedListener l)
void	addOnLabelsChangedListener(Polyline.OnLabelsChangedListener listener)
void	addOnLabelTextSizeChangedListener(Polyline.OnLabelTextSizeChanged listener)
void	drawCanvas(CapturePP cap, android.os.Bundle data) Draw the item to the canvas
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.
int	getHeightExtrudeMode() Get the height extrusion mode See setHeightExtrudeMode(int)
int	getHeightStyle() Get the height rendering style for this shape
java.util.Map<java.lang.String,java.lang.Object>	getLabels()
int	getLabelTextSize() Gets the text size to use for the rendering label convenience method for getting label size meta
android.graphics.Typeface	getLabelTypeface()
java.lang.String	getLineLabel()
GeoPointMetaData[]	getMetaDataPoints() Get the points property value
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 the points property value
GeoPoint[]	getPoints(GeoPoint[] points)
GeoPointMetaData[]	getPoints(GeoPointMetaData[] points) Get the points property value
void	getRelativeBounds(MutableGeoBounds bounds) Returns the bounds relative to the center of the shape.
double	getTotalDistance()
protected void	onHeightStyleChanged()
protected void	onLabelsChanged()
protected void	onLabelTextSizeChanged()
protected void	onMetadataChanged(java.lang.String key) Invoked when the metadata property changes
protected void	onPointsChanged()
android.os.Bundle	preDrawCanvas(CapturePP cap) Save forwarded points to meta data holder These will be used later in drawCanvas
void	removeHeightStyle(int heightStyleBit) Remove a single height style bit from this shape
void	removeOnHeightStyleChangedListener(Polyline.OnHeightStyleChangedListener l)
void	removeOnLabelsChangedListener(Polyline.OnLabelsChangedListener listener)
void	removeOnLabelTextSizeChangedListner(Polyline.OnLabelTextSizeChanged listener)
void	setHeightExtrudeMode(int mode) Set how the height is extruded off the shape Mode can be one of the following: HEIGHT_EXTRUDE_DEFAULT Extrude based on shape properties HEIGHT_EXTRUDE_MIN_ALT Extrude off the minimum point elevation HEIGHT_EXTRUDE_MAX_ALT Extrude off the maximum point elevation HEIGHT_EXTRUDE_CENTER_ALT Extrude off the center point elevation HEIGHT_EXTRUDE_PER_POINT Extrude off each point's elevation
void	setHeightStyle(int heightStyle) Set the height rendering style for this shape Example: HEIGHT_STYLE_POLYGON | HEIGHT_STYLE_OUTLINE
void	setLabels(java.util.Map<java.lang.String,java.lang.Object> labels)
void	setLabelTextSize(int labelTextSize) Sets the text size to use for the rendering label convenience method for setting label size meta
void	setLabelTextSize(int labelTextSize, android.graphics.Typeface typeface) Sets the text size and typeface to use for the rendering label
void	setLabelTextTypeface(android.graphics.Typeface typeface) Gets the text typeface to use for the rendering label
void	setLineLabel(java.lang.String label) Set the floating line label for this polyline Not to be confused with individual segment labels
void	setMaxLabelRenderResolution(double d) Convenience method for setting the maximum label render resolution.
void	setMaxRenderResolution(double d) Convenience method for setting the maximum label render resolution.
void	setMinLabelRenderResolution(double d) Convenience method for setting the minimum label render resolution.
void	setMinRenderResolution(double d) Convenience method for setting the minimum label render resolution.
void	setPoints(GeoPoint[] points) Set the points for the polyline.
void	setPoints(GeoPoint[] points, int off, int len) Given an array of points points, set the sub array defined by offset and length as the points for the Polyine.
void	setPoints(GeoPointMetaData[] points) Set the points for the polyline.
void	setPoints(GeoPointMetaData[] points, int off, int len) Given an array of metadata enhanced points, set the sub array defined by offset and length as the points for the Polyine.

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

addOnBasicLineStyleChangedListener, addOnFillColorChangedListener, addOnPointsChangedListener, addOnStrokeColorChangedListener, addOnStrokeWeightChangedListener, addOnStyleChangedListener, addStyleBits, findTouchPoint, getArea, 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, 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

DEFAULT_MIN_LINE_RENDER_RESOLUTION

public static final double DEFAULT_MIN_LINE_RENDER_RESOLUTION

The minimum line render resolution for a Polyline.

See Also:

Constant Field Values

DEFAULT_MAX_LINE_RENDER_RESOLUTION

public static final double DEFAULT_MAX_LINE_RENDER_RESOLUTION

The maximum line render resolution for a Polyline.

See Also:

Constant Field Values

DEFAULT_MIN_LABEL_RENDER_RESOLUTION

public static final double DEFAULT_MIN_LABEL_RENDER_RESOLUTION

Minimum label render resolution for a polyline that is inside the render window.

See Also:

Constant Field Values

DEFAULT_MAX_LABEL_RENDER_RESOLUTION

public static final double DEFAULT_MAX_LABEL_RENDER_RESOLUTION

Maximum label render resolution for a polyline that is inside the render window.

See Also:

Constant Field Values

STYLE_CLOSED_MASK

public static final int STYLE_CLOSED_MASK

A line will be drawn from the last point to the first and the STYLE_SHAPE_FILLED_MASK will take effect (if exists)

See Also:

Constant Field Values

STYLE_OUTLINE_STROKE_MASK

public static final int STYLE_OUTLINE_STROKE_MASK

Adds a thin black outline on the stroke line which increases visual distinction. The outline will retain the alpha value of the stroke color.

See Also:

Constant Field Values

STYLE_OUTLINE_HALO_MASK

public static final int STYLE_OUTLINE_HALO_MASK

Adds a halo around the polyline with the same color that was used in the stroke.

See Also:

Constant Field Values

HEIGHT_STYLE_NONE

public static final int HEIGHT_STYLE_NONE

Height styles (bit masks)

See Also:

Constant Field Values

HEIGHT_STYLE_POLYGON

public static final int HEIGHT_STYLE_POLYGON

Height styles (bit masks)

See Also:

Constant Field Values

HEIGHT_STYLE_OUTLINE

public static final int HEIGHT_STYLE_OUTLINE

Height styles (bit masks)

See Also:

Constant Field Values

HEIGHT_STYLE_OUTLINE_SIMPLE

public static final int HEIGHT_STYLE_OUTLINE_SIMPLE

Height styles (bit masks)

See Also:

Constant Field Values

HEIGHT_STYLE_TOP_ONLY

public static final int HEIGHT_STYLE_TOP_ONLY

Height styles (bit masks)

See Also:

Constant Field Values

HEIGHT_EXTRUDE_DEFAULT

public static final int HEIGHT_EXTRUDE_DEFAULT

Methods for how to extrude the shape's height (mutually exclusive)

See Also:

Constant Field Values

HEIGHT_EXTRUDE_MIN_ALT

public static final int HEIGHT_EXTRUDE_MIN_ALT

Methods for how to extrude the shape's height (mutually exclusive)

See Also:

Constant Field Values

HEIGHT_EXTRUDE_MAX_ALT

public static final int HEIGHT_EXTRUDE_MAX_ALT

Methods for how to extrude the shape's height (mutually exclusive)

See Also:

Constant Field Values

HEIGHT_EXTRUDE_CENTER_ALT

public static final int HEIGHT_EXTRUDE_CENTER_ALT

Methods for how to extrude the shape's height (mutually exclusive)

See Also:

Constant Field Values

HEIGHT_EXTRUDE_PER_POINT

public static final int HEIGHT_EXTRUDE_PER_POINT

Methods for how to extrude the shape's height (mutually exclusive)

See Also:

Constant Field Values

PARTITION_SIZE

public static final int PARTITION_SIZE

See Also:

Constant Field Values

_points

protected final java.util.ArrayList<GeoPointMetaData> _points

minimumBoundingBox

protected final MutableGeoBounds minimumBoundingBox

Constructor Detail

Polyline

public Polyline(java.lang.String uid)

Polyline

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

Method Detail

getPoints

public GeoPointMetaData[] getPoints(GeoPointMetaData[] points)

Get the points property value

Parameters:

points - the array to use on return if large enough (or not null)

Returns:

GeoPoint array of points

getPoints

public GeoPoint[] getPoints()

Get the points property value

Specified by:

getPoints in class Shape

Returns:

GeoPoint array of points

getPoints

public GeoPoint[] getPoints(GeoPoint[] points)

getMetaDataPoints

public GeoPointMetaData[] getMetaDataPoints()

Get the points property value

Specified by:

getMetaDataPoints in class Shape

Returns:

GeoPoint array of points

setPoints

public void setPoints(GeoPointMetaData[] points)

Set the points for the polyline. These points have metadata.

Parameters:

points - the array of points

Throws:

java.lang.IllegalArgumentException - if one of the points is not valid

setPoints

public void setPoints(GeoPoint[] points)

Set the points for the polyline. These points do not have any metadata.

Parameters:

points - the array of points, cannot be null.

Throws:

java.lang.IllegalArgumentException - if one of the points is not valid

setPoints

public void setPoints(GeoPoint[] points,
                      int off,
                      int len)

Given an array of points points, set the sub array defined by offset and length as the points for the Polyine.

Parameters:

points - lat/lon/alt

off - the offset into the points array

len - the length to be used within the points array.

Throws:

java.lang.IllegalArgumentException - if one of the points is not valid

setPoints

public void setPoints(GeoPointMetaData[] points,
                      int off,
                      int len)

Given an array of metadata enhanced points, set the sub array defined by offset and length as the points for the Polyine.

Parameters:

points - metadata enhanced points

off - the offset into the points array

len - the length to be used within the points array.

Throws:

java.lang.IllegalArgumentException - if one of the points is not valid

onPointsChanged

protected void onPointsChanged()

Overrides:

onPointsChanged in class Shape

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

getTotalDistance

public double getTotalDistance()

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

setLabels

public void setLabels(java.util.Map<java.lang.String,java.lang.Object> labels)

getLabels

public java.util.Map<java.lang.String,java.lang.Object> getLabels()

addOnLabelTextSizeChangedListener

public void addOnLabelTextSizeChangedListener(Polyline.OnLabelTextSizeChanged listener)

removeOnLabelTextSizeChangedListner

public void removeOnLabelTextSizeChangedListner(Polyline.OnLabelTextSizeChanged listener)

addOnLabelsChangedListener

public void addOnLabelsChangedListener(Polyline.OnLabelsChangedListener listener)

removeOnLabelsChangedListener

public void removeOnLabelsChangedListener(Polyline.OnLabelsChangedListener listener)

onLabelsChanged

protected void onLabelsChanged()

onLabelTextSizeChanged

protected void onLabelTextSizeChanged()

addOnHeightStyleChangedListener

public void addOnHeightStyleChangedListener(Polyline.OnHeightStyleChangedListener l)

removeOnHeightStyleChangedListener

public void removeOnHeightStyleChangedListener(Polyline.OnHeightStyleChangedListener l)

onHeightStyleChanged

protected void onHeightStyleChanged()

setHeightStyle

public void setHeightStyle(int heightStyle)

Set the height rendering style for this shape Example: HEIGHT_STYLE_POLYGON | HEIGHT_STYLE_OUTLINE

Parameters:

heightStyle - Height style bit flags

getHeightStyle

public int getHeightStyle()

Get the height rendering style for this shape

Returns:

Height style bit flags

addHeightStyle

public void addHeightStyle(int heightStyleBit)

Add a single height style bit to this shape Example: HEIGHT_STYLE_OUTLINE

Parameters:

heightStyleBit - Height style bit

removeHeightStyle

public void removeHeightStyle(int heightStyleBit)

Remove a single height style bit from this shape

Parameters:

heightStyleBit - Height style bit

setHeightExtrudeMode

public void setHeightExtrudeMode(int mode)

Set how the height is extruded off the shape Mode can be one of the following: HEIGHT_EXTRUDE_DEFAULT Extrude based on shape properties HEIGHT_EXTRUDE_MIN_ALT Extrude off the minimum point elevation HEIGHT_EXTRUDE_MAX_ALT Extrude off the maximum point elevation HEIGHT_EXTRUDE_CENTER_ALT Extrude off the center point elevation HEIGHT_EXTRUDE_PER_POINT Extrude off each point's elevation

Parameters:

mode - Extrusion mode

getHeightExtrudeMode

public int getHeightExtrudeMode()

Get the height extrusion mode See setHeightExtrudeMode(int)

Returns:

The height extrusion mode

getBounds

public GeoBounds getBounds(MutableGeoBounds bounds)

Description copied from class: Shape

The bounds of the shape

Specified by:

getBounds in class Shape

Parameters:

bounds - a preallocated bounds object

Returns:

the upper left and lower right of the shape.

getRelativeBounds

public void getRelativeBounds(MutableGeoBounds bounds)

Returns the bounds relative to the center of the shape.

Parameters:

bounds - The bounds relative to the center of the shape.

setLabelTextSize

public void setLabelTextSize(int labelTextSize)

Sets the text size to use for the rendering label convenience method for setting label size meta

Parameters:

labelTextSize - the int value size to use on the default format

getLabelTextSize

public int getLabelTextSize()

Gets the text size to use for the rendering label convenience method for getting label size meta

Returns:

default MapView font size if key not found in mapping

setLabelTextSize

public void setLabelTextSize(int labelTextSize,
                             android.graphics.Typeface typeface)

Sets the text size and typeface to use for the rendering label

Parameters:

labelTextSize - the int value size to use on the default format

typeface - the typeface graphic to use to draw the label text

setLabelTextTypeface

public void setLabelTextTypeface(android.graphics.Typeface typeface)

Gets the text typeface to use for the rendering label

Parameters:

typeface - the typeface graphic to use to draw the label text

getLabelTypeface

public android.graphics.Typeface getLabelTypeface()

Returns:

the current label drawing typeface for the polyline labels

setLineLabel

public void setLineLabel(java.lang.String label)

Set the floating line label for this polyline Not to be confused with individual segment labels

Parameters:

label - Line label

getLineLabel

public java.lang.String getLineLabel()

onMetadataChanged

protected void onMetadataChanged(java.lang.String key)

Description copied from class: MapItem

Invoked when the metadata property changes

Overrides:

onMetadataChanged in class MapItem

Parameters:

key - Metadata key that has been changed

preDrawCanvas

public android.os.Bundle preDrawCanvas(CapturePP cap)

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

Overrides:

preDrawCanvas in class Shape

Parameters:

cap - 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

setMinLabelRenderResolution

public void setMinLabelRenderResolution(double d)

Convenience method for setting the minimum label render resolution.

Parameters:

d - the double value set in resolution meters per pixel.

setMaxLabelRenderResolution

public void setMaxLabelRenderResolution(double d)

Convenience method for setting the maximum label render resolution.

Parameters:

d - the double value set in resolution meters per pixel.

setMinRenderResolution

public void setMinRenderResolution(double d)

Convenience method for setting the minimum label render resolution.

Parameters:

d - the double value set in resolution meters per pixel.

setMaxRenderResolution

public void setMaxRenderResolution(double d)

Convenience method for setting the maximum label render resolution. This should be used instead of the original "minRenderScale" because scale is a value that is device dependent whereas resolution is device independent.

Parameters:

d - the double value set in resolution meters per pixel.