com.atakmap.android.editableShapes

Class EditablePolyline

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.editableShapes.EditablePolyline

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, Exportable, AnchoredMapItem, MapItem.OnGroupChangedListener, MapItem.OnZOrderChangedListener, MetaDataHolder, VisibilityListener

Direct Known Subclasses:

DrawingShape, Route, VehicleShape

public class EditablePolyline
extends Polyline
implements AnchoredMapItem, Exportable, MapItem.OnZOrderChangedListener, MapItem.OnGroupChangedListener

A Polyline that supports modification of it's points via the GUI. Reports touch events complete with which vertex or line the user touched, has the concept of an edit mode, and shows different menus depending on what was touched and if edit mode is active.

Combined with EditablePolyLineEditTool, EditablePolylineMoveTool, EditablePolyLineReceiver, and a class like ShapeCreationTool or RouteCreationTool, closed shapes and line segments can be input and modified by the user.

When not being edited and not clickable, performance should be comparable to that of a Polyline.

Some of the points may also be markers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EditablePolyline.ActionProviderInterface Outside tools or classes that extend EditablePolyline or interact intimately with it may choose to provide an implementation of this interface if they need to implement their own EditActions, potentially overriding the default behaviors of the built in ones.
class	EditablePolyline.ExchangePointAction
class	EditablePolyline.InsertPointAction
class	EditablePolyline.MovePointAction ******** UNDO Actions ***************
static interface	EditablePolyline.OnEditableChangedListener Editable state listener
class	EditablePolyline.RemoveMarkerAction Removes a marker, does *not* delete the underlying point though.
class	EditablePolyline.RemovePointAction

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

Modifier and Type	Field and Description
protected EditablePolyline.ActionProviderInterface	_actionProvider
protected Marker	_shapeMarker
protected android.content.Context	context
protected java.util.Map<java.lang.String,PointMapItem>	controlPoints
protected java.util.SortedMap<java.lang.Integer,PointMapItem>	indexToMarker
protected java.util.SortedMap<java.lang.Integer,PointMapItem>	indexToMarker2
protected MapView	mapView
protected java.util.Map<PointMapItem,java.lang.Integer>	markerToIndex
static java.lang.String	TAG

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

Method Summary

Modifier and Type	Method and Description
protected void	addListeners(PointMapItem item)
boolean	addMarker(int pointIndex, PointMapItem item) Adds a marker to an existing route at a specific index.
boolean	addMarker(PointMapItem item) Adds a marker to an existing route at the end.
boolean	addMarkers(int pointIndex, PointMapItem[] items) Bulk insert of waypoints.
void	addOnEditableChangedListener(EditablePolyline.OnEditableChangedListener listener) Add a points property listener
boolean	addPoint(GeoPointMetaData point)
boolean	addPoint(int index, GeoPointMetaData point)
protected boolean	addPointNoSync(int index, GeoPointMetaData point)
void	clear()
protected void	clearPoints()
protected void	clearPointsImpl(boolean notifyPointsChanged)
void	clearWithoutNotify() Used in very specific cases where this operation will be chained with other operations that will ultimately call notify.
protected Folder	createKmlGeometry(Folder folder, Placemark outerPlacemark, ExtendedData edata, java.lang.String styleId, java.util.List<Feature> folderFeatures)
protected Placemark	createOuterPlacemark(java.lang.String styleId)
void	delete(MapGroup childItemGroup)
protected int	determineIfFilled()
void	drawCanvas(CapturePP cap, android.os.Bundle data) Draw the item to the canvas
EditablePolyline.ActionProviderInterface	getActionProvider() Gets the current ActionProvider implementation if a non-default one has been specified.
PointMapItem	getAnchorItem() Get the anchor marker for this item
GeoPointMetaData	getAvgAltitude()
GeoPointMetaData	getCenter() Provides the center point for the Shape, or null if an error has occurred.
int	getColor()
protected java.lang.String	getCornerMenu() Provides a shape menu to be used when the shape corner is touched.
boolean	getEditable()
boolean	getFilled()
int	getIndexOfMarker(PointMapItem point) Returns the index of a way point For control points, see #getIndexOfPoint(PointMapItem)
int	getIndexOfPoint(GeoPointMetaData point) Given a point on a Polyline, return the index of the point or -1 if the point is not found.
protected java.lang.String	getLineMenu() Provides a shape menu to be used when the shape line is touched.
int	getLineStyle()
Marker	getMarker()
PointMapItem	getMarker(int index) Given an index on the EditablePolyline, return the PointMapItem at that position or null if no PointMapItem exists.
GeoPointMetaData	getMaxAltitude()
GeoPointMetaData	getMinAltitude()
int	getNumPoints() Returns the number of points for a given polyline.
GeoPointMetaData	getPoint(int index) For a given index, return the point.
PointMapItem	getPointMapItem(int index) Given an index on the EditablePolyline, return the PointMapItem at that position, regardless of whether it is a way point or a control point.
PointMapItem[]	getPointMapItemArray()
java.util.List<PointMapItem>	getPointMapItems() Gets a defensive copy of all of the PointMapItems contained in the line.
Marker	getShapeMarker()
protected java.lang.String	getShapeMenu() Provides a shape menu to be used when the shape is touched.
java.lang.String	getTitle() Returns the title of the editable polyline.
static java.lang.String	getUIDKey() This should be considered read only for 99% of use cases, in order to allow common functionality to work instead of needing to reimplement things like fine position of points on an editable polyline for every subclass.
Undoable	getUndoable()
boolean	hasMarker(PointMapItem item) True if the point is in this route
void	hideLabels(boolean state)
boolean	isBulkOperation()
boolean	isClosed()
boolean	isSupported(java.lang.Class<?> target) Check if this instance supports the specified target class type
protected java.util.List<Data>	kmlDataList()
protected java.lang.String	kmlFolderName()
void	moveClosedSet(GeoPointMetaData oldPoint, GeoPointMetaData newPoint) Move a closed EditablePolyline from the previous center point to a new point
void	onItemAdded(MapItem item, MapGroup newParent)
void	onItemRemoved(MapItem item, MapGroup oldParent)
protected void	onPointsChanged()
protected void	onVisibleChanged() Invokes when the visible property changes
void	onZOrderChanged(MapItem item)
android.os.Bundle	preDrawCanvas(CapturePP capture) Save forwarded points to meta data holder These will be used later in drawCanvas
protected void	removeListeners(PointMapItem item)
boolean	removeMarker(int index)
protected boolean	removeMarker(int index, boolean notExchangingPoints, boolean partOfRemovePoint) Removes a waypoint from the route requested.
boolean	removeMarker(PointMapItem item)
protected boolean	removeMarker(PointMapItem item, boolean notExchangingPoints) Removes a waypoint from the route requested.
protected PointMapItem	removeMarkerNoSync(int index)
void	removeOnEditableChangedListener(EditablePolyline.OnEditableChangedListener listener) Remove a points property listener
void	removePoint(int index)
void	resetAlpha() Changes route's transparency back to it's normal value
void	reverse() Reverse the entire polyline - mostly used in the case of turning an infil into an exfil.
void	setAbsoluteKMLElev(boolean forceAltitude) Deprecated.
void	setAlpha(int alpha) Temporarily change the transparency of the route's color.
protected void	setBulkOperation(boolean bulk)
void	setClickable(boolean state) Toggle the touchability of a route.
protected void	setClosed(boolean closed)
void	setColor(int color)
void	setEditable(boolean editable) Styles this route to indicate that it's the currently editable route, and also makes it's invisible handles visible so they can be interacted with.
void	setFillColor(int color) Set the fillColor property value
void	setFilled(boolean filled)
void	setLineStyle(int style) STYLE_SOLID = 0, STYLE_DOTTED = 1, STYLE_DASHED = 2 and STYLE_OUTLINED = 3
void	setLocked(boolean locked)
void	setMarker(int pointIndex, PointMapItem item)
protected void	setMarkerNoSync(int pointIndex, PointMapItem item)
boolean	setPoint(int index, GeoPointMetaData point)
boolean	setPoint(int index, GeoPointMetaData point, boolean skipIfEquals) Set a point in this polyline
boolean	setPoints(java.util.List<GeoPointMetaData> points, android.util.SparseArray<PointMapItem> markers) Bulk operation for setting both the points and markers for a line with as little overhead as possible
protected void	setShapeMarker(Marker marker) A Marker used to invoke the set's menu.
void	setStrokeColor(int strokeColor) Set the strokeColor property value
void	setStrokeWeight(double weight) Set the stroke weight of this shape's lines Minimum = 1.0, maximum = 6.0
void	setTitle(java.lang.String title) Set the title of this map item (display name)
void	setUndoable(Undoable undo)
void	setZOrder(double zOrder) Set the ascending order of the MapItem.
boolean	shouldDisplayVertices(double mapScale)
protected GeoPoint	testLinesHit(MapView view, int startIdx, int endIdx, Vector2D touch) Deprecated. use testLinesHit(MapView, int, int, Vector2D, GeoPoint)
protected GeoPoint	testLinesHit(MapView view, int startIdx, int endIdx, Vector2D touch, GeoPoint gp) Deprecated. Implementation moved to AbstractGLMapItem2.hitTest(MapRenderer3, HitTestQueryParameters)
protected int	testPointsHit(MapView view, int startIdx, int endIdx, android.graphics.RectF hitRect, GeoBounds hitBox) Deprecated. Implementation moved to AbstractGLMapItem2.hitTest(MapRenderer3, HitTestQueryParameters)
protected CotEvent	toCot() Produce a CoT message that represents the Route
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

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

addHeightStyle, addOnHeightStyleChangedListener, addOnLabelsChangedListener, addOnLabelTextSizeChangedListener, getBounds, getHeightExtrudeMode, getHeightStyle, getLabels, getLabelTextSize, getLabelTypeface, getLineLabel, getMetaDataPoints, getPerimeterOrLength, getPoints, getPoints, getPoints, getRelativeBounds, getTotalDistance, onHeightStyleChanged, onLabelsChanged, onLabelTextSizeChanged, onMetadataChanged, 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, getArea, getBasicLineStyle, getClickPoint, getFillColor, getGeoPointMetaData, getIconColor, getStrokeColor, getStrokeStyle, getStrokeWeight, getStyle, onBasicLineStyleChanged, onFillColorChanged, onStrokeColorChanged, onStrokeStyleChanged, onStrokeWeightChanged, onStyleChanged, removeOnBasicLineStyleChangedListener, removeOnFillColorChangedListener, removeOnPointsChangedListener, removeOnStrokeColorChangedListener, removeOnStrokeWeightChangedListener, removeOnStyleChangedListener, removeStyleBits, setBasicLineStyle, setColor, setFillAlpha, setStrokeStyle, 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, 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, onZOrderChanged, persist, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setAltitudeMode, setClickPoint, setHashtags, setHeight, setMetaBoolean, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, 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

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

_shapeMarker

protected Marker _shapeMarker

mapView

protected final MapView mapView

context

protected final android.content.Context context

controlPoints

protected final java.util.Map<java.lang.String,PointMapItem> controlPoints

markerToIndex

protected final java.util.Map<PointMapItem,java.lang.Integer> markerToIndex

indexToMarker

protected final java.util.SortedMap<java.lang.Integer,PointMapItem> indexToMarker

indexToMarker2

protected final java.util.SortedMap<java.lang.Integer,PointMapItem> indexToMarker2

_actionProvider

protected EditablePolyline.ActionProviderInterface _actionProvider

Constructor Detail

EditablePolyline

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

EditablePolyline

public EditablePolyline(MapView mapView,
                        long serialId,
                        MetaDataHolder metadata,
                        java.lang.String uid)

Method Detail

onItemAdded

public void onItemAdded(MapItem item,
                        MapGroup newParent)

Specified by:

onItemAdded in interface MapItem.OnGroupChangedListener

onItemRemoved

public void onItemRemoved(MapItem item,
                          MapGroup oldParent)

Specified by:

onItemRemoved in interface MapItem.OnGroupChangedListener

onZOrderChanged

public void onZOrderChanged(MapItem item)

Specified by:

onZOrderChanged in interface MapItem.OnZOrderChangedListener

delete

public void delete(MapGroup childItemGroup)

setShapeMarker

protected void setShapeMarker(Marker marker)

A Marker used to invoke the set's menu. Only visible when the set is editable.

Parameters:

marker - the marker used for the shapes menu

getShapeMarker

public Marker getShapeMarker()

setClickable

public void setClickable(boolean state)

Toggle the touchability of a route.

Overrides:

setClickable in class MapItem

hideLabels

public void hideLabels(boolean state)

setLocked

public void setLocked(boolean locked)

testPointsHit

@Deprecated
protected final int testPointsHit(MapView view,
                                              int startIdx,
                                              int endIdx,
                                              android.graphics.RectF hitRect,
                                              GeoBounds hitBox)

Deprecated. Implementation moved to AbstractGLMapItem2.hitTest(MapRenderer3, HitTestQueryParameters)

testLinesHit

@Deprecated
protected final GeoPoint testLinesHit(MapView view,
                                                  int startIdx,
                                                  int endIdx,
                                                  Vector2D touch)

Deprecated. use testLinesHit(MapView, int, int, Vector2D, GeoPoint)

testLinesHit

@Deprecated
protected final GeoPoint testLinesHit(MapView view,
                                                  int startIdx,
                                                  int endIdx,
                                                  Vector2D touch,
                                                  GeoPoint gp)

Deprecated. Implementation moved to AbstractGLMapItem2.hitTest(MapRenderer3, HitTestQueryParameters)

getShapeMenu

protected java.lang.String getShapeMenu()

Provides a shape menu to be used when the shape is touched. Can be overridden by setting the "shapeMenu" metaString.

Returns:

by default the drawing_shape_menu otherwise the metaString for "shapeMenu"

getLineMenu

protected java.lang.String getLineMenu()

Provides a shape menu to be used when the shape line is touched. Can be overridden by setting the "lineMenu" metaString.

Returns:

by default the drawing_shape_line_menu otherwise the metaString for "lineMenu"

getCornerMenu

protected java.lang.String getCornerMenu()

Provides a shape menu to be used when the shape corner is touched. Can be overridden by setting the "cornerMenu" metaString.

Returns:

by default the drawing_shape_corner_menu otherwise the metaString for "lineMenu"

getMarker

public final Marker getMarker()

setUndoable

public void setUndoable(Undoable undo)

getUndoable

public Undoable getUndoable()

isClosed

public boolean isClosed()

setClosed

protected void setClosed(boolean closed)

setBulkOperation

protected void setBulkOperation(boolean bulk)

isBulkOperation

public boolean isBulkOperation()

moveClosedSet

public void moveClosedSet(GeoPointMetaData oldPoint,
                          GeoPointMetaData newPoint)

Move a closed EditablePolyline from the previous center point to a new point

Parameters:

oldPoint - the old point to act as the center point

newPoint - the new point to act as the center point, important to shift the entire polygon by a specific amount.

getNumPoints

public int getNumPoints()

Returns the number of points for a given polyline.

Returns:

the number, or zero if there are no points.

getPoint

public GeoPointMetaData getPoint(int index)

For a given index, return the point. If the index falls outside of the bounds of the number of points, return the closest point to either end of the list.

Parameters:

index - the index

Returns:

the point.

getIndexOfPoint

public int getIndexOfPoint(GeoPointMetaData point)

Given a point on a Polyline, return the index of the point or -1 if the point is not found.

Parameters:

point - the point to find

Returns:

the index of the point, -1 if not found.

getMarker

public PointMapItem getMarker(int index)

Given an index on the EditablePolyline, return the PointMapItem at that position or null if no PointMapItem exists.

getPointMapItem

public PointMapItem getPointMapItem(int index)

Given an index on the EditablePolyline, return the PointMapItem at that position, regardless of whether it is a way point or a control point.

Parameters:

index - Position

Returns:

PointMapItem at position index

getPointMapItems

public java.util.List<PointMapItem> getPointMapItems()

Gets a defensive copy of all of the PointMapItems contained in the line.

Returns:

getPointMapItemArray

public PointMapItem[] getPointMapItemArray()

getIndexOfMarker

public int getIndexOfMarker(PointMapItem point)

Returns the index of a way point For control points, see #getIndexOfPoint(PointMapItem)

Parameters:

point - Way point

Returns:

Way point index

getColor

public int getColor()

setColor

public void setColor(int color)

Overrides:

setColor in class Shape

setStrokeColor

public void setStrokeColor(int strokeColor)

Description copied from class: Shape

Set the strokeColor property value

Overrides:

setStrokeColor in class Shape

Parameters:

strokeColor - An argb packed 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

setLineStyle

public void setLineStyle(int style)

STYLE_SOLID = 0, STYLE_DOTTED = 1, STYLE_DASHED = 2 and STYLE_OUTLINED = 3

getLineStyle

public int getLineStyle()

setFilled

public void setFilled(boolean filled)

getActionProvider

public EditablePolyline.ActionProviderInterface getActionProvider()

Gets the current ActionProvider implementation if a non-default one has been specified.

Returns:

getFilled

public boolean getFilled()

getAnchorItem

public PointMapItem getAnchorItem()

Description copied from interface: AnchoredMapItem

Get the anchor marker for this item

Specified by:

getAnchorItem in interface AnchoredMapItem

Returns:

Anchor marker

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

getAvgAltitude

public GeoPointMetaData getAvgAltitude()

getMaxAltitude

public GeoPointMetaData getMaxAltitude()

getMinAltitude

public GeoPointMetaData getMinAltitude()

setFillColor

public void setFillColor(int color)

Description copied from class: Shape

Set the fillColor property value

Overrides:

setFillColor in class Shape

Parameters:

color - An argb packed Color

onVisibleChanged

protected void onVisibleChanged()

Description copied from class: MapItem

Invokes when the visible property changes

Overrides:

onVisibleChanged in class MapItem

onPointsChanged

protected void onPointsChanged()

Overrides:

onPointsChanged in class Polyline

reverse

public void reverse()

Reverse the entire polyline - mostly used in the case of turning an infil into an exfil.

hasMarker

public boolean hasMarker(PointMapItem item)

True if the point is in this route

Parameters:

item - the map item to check against.

Returns:

true if the route contains the map item.

setAlpha

public void setAlpha(int alpha)

Temporarily change the transparency of the route's color. This is not saved to the route's cot event.

Parameters:

alpha - New alpha value

resetAlpha

public void resetAlpha()

Changes route's transparency back to it's normal value

getEditable

public boolean getEditable()

Overrides:

getEditable in class MapItem

setEditable

public void setEditable(boolean editable)

Styles this route to indicate that it's the currently editable route, and also makes it's invisible handles visible so they can be interacted with.

Overrides:

setEditable in class MapItem

Parameters:

editable - Whether editable styling should be enabled or disabled.

shouldDisplayVertices

public boolean shouldDisplayVertices(double mapScale)

setAbsoluteKMLElev

@Deprecated
public void setAbsoluteKMLElev(boolean forceAltitude)

Deprecated.

Forces the polyline to be rendered at altitude independent of the height and also turns off any extrusion.

Parameters:

forceAltitude - true if we are going to force the polyline to be at altitude

setZOrder

public void setZOrder(double zOrder)

Description copied from class: MapItem

Set the ascending order of the MapItem. zOrder affects draw order and hit order.

Overrides:

setZOrder in class MapItem

removeMarker

public boolean removeMarker(PointMapItem item)

removeMarker

protected boolean removeMarker(PointMapItem item,
                               boolean notExchangingPoints)

Removes a waypoint from the route requested.

Parameters:

item - the waypoint to be removed

notExchangingPoints - False if we're about to add a point to replace the one we're now removing. Turns off behavior which will be made obsolete once the insertion occurs.

Returns:

true if a point was removed

removeMarker

public boolean removeMarker(int index)

removeMarker

protected final boolean removeMarker(int index,
                                     boolean notExchangingPoints,
                                     boolean partOfRemovePoint)

Removes a waypoint from the route requested.

Parameters:

index - index of item to delete

notExchangingPoints - False if we're about to add a point to replace the one we're now removing. Turns off behavior which will be made obsolete once the insertion occurs.

Returns:

true if a point was removed

removeMarkerNoSync

protected PointMapItem removeMarkerNoSync(int index)

removePoint

public void removePoint(int index)

addMarker

public boolean addMarker(PointMapItem item)

Adds a marker to an existing route at the end. This method requires that a route be placed on the map already or will be placed on the map in the future.

Parameters:

item - the point map item to add.

addMarker

public boolean addMarker(int pointIndex,
                         PointMapItem item)

Adds a marker to an existing route at a specific index. This method requires that a route be placed on the map already or will be placed on the map in the future.

Parameters:

pointIndex - the position to add the marker after.

item - the point map item to add.

addMarkers

public boolean addMarkers(int pointIndex,
                          PointMapItem[] items)

Bulk insert of waypoints. Much more efficient then the corresponding addMarker. Adds a set marker to an existing route at a specific index. This method requires that a route be placed on the map already or will be placed on the map in the future.

Parameters:

pointIndex - the position to add the marker after.

items - the array of point map items to add.

setMarker

public void setMarker(int pointIndex,
                      PointMapItem item)

setMarkerNoSync

protected void setMarkerNoSync(int pointIndex,
                               PointMapItem item)

addPoint

public boolean addPoint(GeoPointMetaData point)

addPoint

public boolean addPoint(int index,
                        GeoPointMetaData point)

addPointNoSync

protected boolean addPointNoSync(int index,
                                 GeoPointMetaData point)

setPoint

public boolean setPoint(int index,
                        GeoPointMetaData point,
                        boolean skipIfEquals)

Set a point in this polyline

Parameters:

index - Point index

point - Point location

skipIfEquals - True to skip operation if the point hasn't changed

Returns:

True if successful

setPoint

public boolean setPoint(int index,
                        GeoPointMetaData point)

removeListeners

protected void removeListeners(PointMapItem item)

addListeners

protected void addListeners(PointMapItem item)

clearPoints

protected void clearPoints()

clear

public void clear()

clearWithoutNotify

public void clearWithoutNotify()

Used in very specific cases where this operation will be chained with other operations that will ultimately call notify. For standard usage of clear, call clear()

clearPointsImpl

protected void clearPointsImpl(boolean notifyPointsChanged)

getUIDKey

public static java.lang.String getUIDKey()

This should be considered read only for 99% of use cases, in order to allow common functionality to work instead of needing to reimplement things like fine position of points on an editable polyline for every subclass.

Returns:

the uid key for an associated set

getTitle

public java.lang.String getTitle()

Returns the title of the editable polyline.

Specified by:

getTitle in interface URIContent

Overrides:

getTitle in class Shape

Returns:

the title

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 Shape

Parameters:

title - Item title

addOnEditableChangedListener

public void addOnEditableChangedListener(EditablePolyline.OnEditableChangedListener listener)

Add a points property listener

Parameters:

listener - the listener

removeOnEditableChangedListener

public void removeOnEditableChangedListener(EditablePolyline.OnEditableChangedListener listener)

Remove a points property listener

Parameters:

listener - the listener

toCot

protected CotEvent toCot()

Produce a CoT message that represents the Route

toKml

protected Folder toKml()

createOuterPlacemark

protected Placemark createOuterPlacemark(java.lang.String styleId)

determineIfFilled

protected int determineIfFilled()

kmlFolderName

protected java.lang.String kmlFolderName()

kmlDataList

protected java.util.List<Data> kmlDataList()

createKmlGeometry

protected Folder createKmlGeometry(Folder folder,
                                   Placemark outerPlacemark,
                                   ExtendedData edata,
                                   java.lang.String styleId,
                                   java.util.List<Feature> folderFeatures)

toKmz

protected KMZFolder toKmz()

toGpx

protected GPXExportWrapper toGpx()

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

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

Overrides:

preDrawCanvas in class Polyline

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 Polyline

Parameters:

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

data - Point data saved in preDrawCanvas

setPoints

public boolean setPoints(java.util.List<GeoPointMetaData> points,
                         android.util.SparseArray<PointMapItem> markers)

Bulk operation for setting both the points and markers for a line with as little overhead as possible

Parameters:

points - Complete list of points

markers - Sparse array (int map) of markers

Returns:

True if line changed, false if the same