com.atakmap.android.routes

Class Route

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

com.atakmap.android.routes.Route

All Implemented Interfaces:

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

Direct Known Subclasses:

FloatingPointRoute, RouteTrackWrapper

public class Route
extends EditablePolyline

Handles automatic waypoint naming, stores metadata about the route.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Route.ControlPointMapItem A lighter weight PointMapItem capable of sharing metadata across the entire route.
static interface	Route.OnRouteDirectionChangedListener
static interface	Route.OnRouteMethodChangedListener
static interface	Route.OnRouteOrderChangedListener
static interface	Route.OnRoutePointsChangedListener Route changed listener
static interface	Route.OnRouteTypeChangedListener
class	Route.RouteAddSegment
static class	Route.RouteDirection
static class	Route.RouteMethod
static class	Route.RouteOrder
class	Route.RouteSetCueAction
class	Route.RouteSetPointName
static class	Route.RouteType

Nested classes/interfaces inherited from class com.atakmap.android.editableShapes.EditablePolyline

EditablePolyline.ActionProviderInterface, EditablePolyline.ExchangePointAction, EditablePolyline.InsertPointAction, EditablePolyline.MovePointAction, EditablePolyline.OnEditableChangedListener, EditablePolyline.RemoveMarkerAction, 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
static java.lang.String	CONTROLPOINT_TYPE
static int	DEFAULT_ROUTE_COLOR
static double	DEFAULT_STROKE_WEIGHT
static double	EDITABLE_STROKE_WEIGHT
static double	NAVIGATING_STROKE_WEIGHT
static java.lang.String	WAYPOINT_TYPE

Fields inherited from class com.atakmap.android.editableShapes.EditablePolyline

_actionProvider, _shapeMarker, context, controlPoints, indexToMarker, indexToMarker2, mapView, markerToIndex

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

Modifier	Constructor and Description
protected	Route(MapView mapView, long serialId, MetaDataHolder metadata, java.lang.String uid)
	Route(MapView mapView, java.lang.String routeName, int color, java.lang.String prefix, java.lang.String uid)
	Route(MapView mapView, java.lang.String routeName, int color, java.lang.String prefix, java.lang.String uid, boolean addGrouplessWaypointsToGroup)

Method Summary

Modifier and Type	Method and Description
boolean	addMarkers(int index, java.util.List<PointMapItem> items) Given a list of PointMapItems, add them using a bulk add method.
boolean	addMarkers(int index, PointMapItem[] items) Optimized method for bulk-adding markers to a Route
void	addOnRouteDirectionChangedListener(Route.OnRouteDirectionChangedListener listener) Add a route direction changed listener
void	addOnRouteMethodChangedListener(Route.OnRouteMethodChangedListener listener) Add a route method changed listener
void	addOnRouteOrderChangedListener(Route.OnRouteOrderChangedListener listener) Add a route order changed listener
void	addOnRoutePointsChangedListener(Route.OnRoutePointsChangedListener listener) Add a route points changed listener
void	addOnRouteTypeChangedListener(Route.OnRouteTypeChangedListener listener) Add a route type changed listener
boolean	addPoint(GeoPointMetaData point)
boolean	addPoint(int index, GeoPointMetaData point)
void	clearPoints()
static boolean	compare(Route route1, Route route2) Compares two routes to determine if they're identical.
static PointMapItem	createControlPoint(GeoPoint geoPoint) Creates a ControlPoint marker with a random uid.
static PointMapItem	createControlPoint(GeoPoint geoPoint, java.lang.String uid) Creates a ControlPoint marker with an assigned uid.
static Marker	createWayPoint(GeoPointMetaData geoPoint, java.lang.String uid) Creates a waypoint marker.
PointMapItem[]	getContactPoints()
protected java.lang.String	getCornerMenu() Provides a shape menu to be used when the shape corner is touched.
NavigationCue	getCueForPoint(java.lang.String uid) Gets the cue associated with the point with the given UID.
java.lang.String	getFirstWaypointName()
java.lang.String	getLastWaypointName()
protected java.lang.String	getLineMenu() Provides a shape menu to be used when the shape line is touched.
double	getMaximumDistance(PointMapItem refPoint) Finds the farthest point distance, within this route, to the reference point.
double	getMinimumDistance(PointMapItem refPoint) Finds the closest point distance, within this route, to the reference point.
java.util.Map<java.lang.String,NavigationCue>	getNavigationCues() Gets a copy of the map associating cues with route points by UID.
PointMapItem	getNextWaypoint(int index) Get the next waypoint after the given index
java.lang.String	getNextWaypointName()
int	getNumWaypoint()
java.lang.String	getPlanningMethod()
java.lang.String	getPrefix()
java.util.List<java.lang.String[]>	getRouteDetails() Returns a list of arrays that describe the route details where the array is as described: [0] - callsign (set last) [1] - distance in miles [2] - distance in kilometers [3] - elevation change [4] - uid
Route.RouteDirection	getRouteDirection()
Route.RouteMethod	getRouteMethod()
Route.RouteOrder	getRouteOrder()
Route.RouteType	getRouteType()
protected java.lang.String	getShapeMenu() Provides a shape menu to be used when the shape is touched.
java.lang.String	getTransportationType()
java.lang.String	getWaypointUID(int waypointNumber)
boolean	isClosed()
boolean	isReversedDir()
static boolean	isRouteDirection(java.lang.String direction)
static boolean	isRouteMethod(java.lang.String method)
static boolean	isRouteOrder(java.lang.String order)
static boolean	isRouteType(java.lang.String type)
void	onPointsChanged()
protected void	onRoutePointsChanged() Notifies listeners that a point's changed
void	refresh(MapEventDispatcher d, android.os.Bundle b, java.lang.Class<?> clazz) Dispatches a refresh event for the MapItem.
boolean	removeMarker(int index)
boolean	removeMarker(PointMapItem item)
protected PointMapItem	removeMarkerNoSync(int index)
NavigationCue	removeNavigationCueForPoint(java.lang.String uid) Clears all navigation cues associated with the point with the given UID.
void	removeOnRouteDirectionChangedListener(Route.OnRouteDirectionChangedListener listener) Remove a route Direction changed listener
void	removeOnRouteMethodChangedListener(Route.OnRouteMethodChangedListener listener) Remove a route Method changed listener
void	removeOnRouteOrderChangedListener(Route.OnRouteOrderChangedListener listener) Remove a route Order changed listener
void	removeOnRoutePointsChangedListener(Route.OnRoutePointsChangedListener listener) Remove a route points changed listener
void	removeOnRouteTypeChangedListener(Route.OnRouteTypeChangedListener listener) Remove a route Type changed listener
void	removePoint(int index)
java.util.List<PointMapItem>	removePoints(int start, int end) Remove multiple points from route
void	setClosed(boolean closed)
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	setMarker(int pointIndex, PointMapItem item)
protected void	setMarkerNoSync(int index, PointMapItem item)
void	setNavigating(boolean state) During navigation only show the navigation flag.
void	setNavigationCueForPoint(java.lang.String uid, NavigationCue cue) Associates a NavigationCue for a point in the route with the given UID.
void	setNavigationCues(java.util.Map<java.lang.String,NavigationCue> cues)
void	setPlanningMethod(java.lang.String method) See enum PlanningMethod
boolean	setPoint(int index, GeoPointMetaData point, boolean skipIfEquals) Set a point in this polyline
java.lang.String	setPrefix(java.lang.String value)
void	setRouteDirection(java.lang.String direction) See enum RouteDirection.
void	setRouteMethod(java.lang.String method) See enum RouteMethod
void	setRouteOrder(java.lang.String order) See enum RouteOrder
void	setRouteType(java.lang.String type) See enum RouteType
void	setTitle(java.lang.String title) Set the title of this map item (display name)
void	setTransportationType(java.lang.String transportationType)
void	setZOrder(double zOrder) Set the ascending order of the MapItem.
protected CotEvent	toCot() Produce a CoT message that represents the Route
protected GPXExportWrapper	toGpx()
protected Folder	toKml()
protected KMZFolder	toKmz()

Methods inherited from class com.atakmap.android.editableShapes.EditablePolyline

addListeners, addMarker, addMarker, addOnEditableChangedListener, addPointNoSync, clear, clearPointsImpl, clearWithoutNotify, createKmlGeometry, createOuterPlacemark, delete, determineIfFilled, drawCanvas, getActionProvider, getAnchorItem, getAvgAltitude, getCenter, getColor, getEditable, getFilled, getIndexOfMarker, getIndexOfPoint, getLineStyle, getMarker, getMarker, getMaxAltitude, getMinAltitude, getNumPoints, getPoint, getPointMapItem, getPointMapItemArray, getPointMapItems, getShapeMarker, getTitle, getUIDKey, getUndoable, hasMarker, hideLabels, isBulkOperation, isSupported, kmlDataList, kmlFolderName, moveClosedSet, onItemAdded, onItemRemoved, onVisibleChanged, onZOrderChanged, preDrawCanvas, removeListeners, removeMarker, removeMarker, removeOnEditableChangedListener, resetAlpha, reverse, setAbsoluteKMLElev, setAlpha, setBulkOperation, setClickable, setColor, setFilled, setLineStyle, setLocked, setPoint, setPoints, setShapeMarker, setStrokeColor, setStrokeWeight, setUndoable, shouldDisplayVertices, testLinesHit, testLinesHit, testPointsHit, toObjectOf

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

WAYPOINT_TYPE

public static final java.lang.String WAYPOINT_TYPE

See Also:

Constant Field Values

CONTROLPOINT_TYPE

public static final java.lang.String CONTROLPOINT_TYPE

See Also:

Constant Field Values

DEFAULT_STROKE_WEIGHT

public static final double DEFAULT_STROKE_WEIGHT

See Also:

Constant Field Values

EDITABLE_STROKE_WEIGHT

public static final double EDITABLE_STROKE_WEIGHT

See Also:

Constant Field Values

NAVIGATING_STROKE_WEIGHT

public static final double NAVIGATING_STROKE_WEIGHT

See Also:

Constant Field Values

DEFAULT_ROUTE_COLOR

public static final int DEFAULT_ROUTE_COLOR

See Also:

Constant Field Values

Constructor Detail

Route

protected Route(MapView mapView,
                long serialId,
                MetaDataHolder metadata,
                java.lang.String uid)

Parameters:

-

Route

public Route(MapView mapView,
             java.lang.String routeName,
             int color,
             java.lang.String prefix,
             java.lang.String uid,
             boolean addGrouplessWaypointsToGroup)

Route

public Route(MapView mapView,
             java.lang.String routeName,
             int color,
             java.lang.String prefix,
             java.lang.String uid)

Method Detail

setFillColor

public void setFillColor(int color)

Description copied from class: Shape

Set the fillColor property value

Overrides:

setFillColor in class EditablePolyline

Parameters:

color - An argb packed Color

setClosed

public void setClosed(boolean closed)

Overrides:

setClosed in class EditablePolyline

isClosed

public boolean isClosed()

Overrides:

isClosed in class EditablePolyline

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 EditablePolyline

refresh

public void refresh(MapEventDispatcher d,
                    android.os.Bundle b,
                    java.lang.Class<?> clazz)

Description copied from class: MapItem

Dispatches a refresh event for the MapItem. The refresh event will signal interested components that the metadata properties of the item have changed.

Overrides:

refresh in class MapItem

Parameters:

d - The event dispatcher

b - An optional bundle of extras to be sent with the event; may be null See MapEvent.ITEM_REFRESH

getPrefix

public java.lang.String getPrefix()

setPrefix

public java.lang.String setPrefix(java.lang.String value)

addOnRoutePointsChangedListener

public void addOnRoutePointsChangedListener(Route.OnRoutePointsChangedListener listener)

Add a route points changed listener

Parameters:

listener - the listener

removeOnRoutePointsChangedListener

public void removeOnRoutePointsChangedListener(Route.OnRoutePointsChangedListener listener)

Remove a route points changed listener

Parameters:

listener - the listener

addOnRouteMethodChangedListener

public void addOnRouteMethodChangedListener(Route.OnRouteMethodChangedListener listener)

Add a route method changed listener

Parameters:

listener - the listener

addOnRouteDirectionChangedListener

public void addOnRouteDirectionChangedListener(Route.OnRouteDirectionChangedListener listener)

Add a route direction changed listener

Parameters:

listener - the listener

addOnRouteTypeChangedListener

public void addOnRouteTypeChangedListener(Route.OnRouteTypeChangedListener listener)

Add a route type changed listener

Parameters:

listener - the listener

addOnRouteOrderChangedListener

public void addOnRouteOrderChangedListener(Route.OnRouteOrderChangedListener listener)

Add a route order changed listener

Parameters:

listener - the listener

setEditable

public void setEditable(boolean editable)

Description copied from class: EditablePolyline

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 EditablePolyline

Parameters:

editable - Whether editable styling should be enabled or disabled.

setNavigating

public void setNavigating(boolean state)

During navigation only show the navigation flag. No other menu items make sense.

removeOnRouteMethodChangedListener

public void removeOnRouteMethodChangedListener(Route.OnRouteMethodChangedListener listener)

Remove a route Method changed listener

Parameters:

listener - the listener

removeOnRouteDirectionChangedListener

public void removeOnRouteDirectionChangedListener(Route.OnRouteDirectionChangedListener listener)

Remove a route Direction changed listener

Parameters:

listener - the listener

removeOnRouteTypeChangedListener

public void removeOnRouteTypeChangedListener(Route.OnRouteTypeChangedListener listener)

Remove a route Type changed listener

Parameters:

listener - the listener

removeOnRouteOrderChangedListener

public void removeOnRouteOrderChangedListener(Route.OnRouteOrderChangedListener listener)

Remove a route Order changed listener

Parameters:

listener - the listener

onRoutePointsChanged

protected void onRoutePointsChanged()

Notifies listeners that a point's changed

getNextWaypoint

public PointMapItem getNextWaypoint(int index)

Get the next waypoint after the given index

Parameters:

index - Current waypoint index

Returns:

Next waypoint or null if none

removePoint

public void removePoint(int index)

Overrides:

removePoint in class EditablePolyline

removeMarker

public boolean removeMarker(PointMapItem item)

Overrides:

removeMarker in class EditablePolyline

removeMarker

public boolean removeMarker(int index)

Overrides:

removeMarker in class EditablePolyline

removeMarkerNoSync

protected PointMapItem removeMarkerNoSync(int index)

Overrides:

removeMarkerNoSync in class EditablePolyline

clearPoints

public void clearPoints()

Overrides:

clearPoints in class EditablePolyline

addPoint

public boolean addPoint(GeoPointMetaData point)

Overrides:

addPoint in class EditablePolyline

addPoint

public boolean addPoint(int index,
                        GeoPointMetaData point)

Overrides:

addPoint in class EditablePolyline

addMarkers

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

Optimized method for bulk-adding markers to a Route

Overrides:

addMarkers in class EditablePolyline

Parameters:

index - Starting index

items - List of markers to add

Returns:

True if successful

addMarkers

public boolean addMarkers(int index,
                          java.util.List<PointMapItem> items)

Given a list of PointMapItems, add them using a bulk add method.

Parameters:

index - the index where to start the insertion which must be greater than or equal to zero.

items - the array of point map items to add.

removePoints

public java.util.List<PointMapItem> removePoints(int start,
                                                 int end)

Remove multiple points from route

Parameters:

start - Start index (must be >= 0)

end - End index (exclusive; must be <= point count)

onPointsChanged

public void onPointsChanged()

Overrides:

onPointsChanged in class EditablePolyline

setNavigationCueForPoint

public void setNavigationCueForPoint(java.lang.String uid,
                                     NavigationCue cue)

Associates a NavigationCue for a point in the route with the given UID.

Parameters:

uid - UID of the point map item on the route to associate the cue with

cue - Cue to associate with point

setNavigationCues

public void setNavigationCues(java.util.Map<java.lang.String,NavigationCue> cues)

removeNavigationCueForPoint

public NavigationCue removeNavigationCueForPoint(java.lang.String uid)

Clears all navigation cues associated with the point with the given UID.

Parameters:

uid - UID of the point to clear

Returns:

The cue that was unassociated from the point, if any, null otherwise

getCueForPoint

public NavigationCue getCueForPoint(java.lang.String uid)

Gets the cue associated with the point with the given UID.

Parameters:

uid - UID of point

Returns:

Associated cue, null otherwise

getNavigationCues

public java.util.Map<java.lang.String,NavigationCue> getNavigationCues()

Gets a copy of the map associating cues with route points by UID.

Returns:

Copy of the map, may be empty.

setMarkerNoSync

protected void setMarkerNoSync(int index,
                               PointMapItem item)

Overrides:

setMarkerNoSync in class EditablePolyline

setPoint

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

Description copied from class: EditablePolyline

Set a point in this polyline

Overrides:

setPoint in class EditablePolyline

Parameters:

index - Point index

point - Point location

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

Returns:

True if successful

getCornerMenu

protected java.lang.String getCornerMenu()

Description copied from class: EditablePolyline

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

Overrides:

getCornerMenu in class EditablePolyline

Returns:

by default the drawing_shape_corner_menu otherwise the metaString for "lineMenu"

getLineMenu

protected java.lang.String getLineMenu()

Description copied from class: EditablePolyline

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

Overrides:

getLineMenu in class EditablePolyline

Returns:

by default the drawing_shape_line_menu otherwise the metaString for "lineMenu"

getShapeMenu

protected java.lang.String getShapeMenu()

Description copied from class: EditablePolyline

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

Overrides:

getShapeMenu in class EditablePolyline

Returns:

by default the drawing_shape_menu otherwise the metaString for "shapeMenu"

setMarker

public void setMarker(int pointIndex,
                      PointMapItem item)

Overrides:

setMarker in class EditablePolyline

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 EditablePolyline

Parameters:

title - Item title

getTransportationType

public java.lang.String getTransportationType()

setTransportationType

public void setTransportationType(java.lang.String transportationType)

getNumWaypoint

public int getNumWaypoint()

isRouteMethod

public static boolean isRouteMethod(java.lang.String method)

setRouteMethod

public void setRouteMethod(java.lang.String method)

See enum RouteMethod

getRouteMethod

public Route.RouteMethod getRouteMethod()

isRouteDirection

public static boolean isRouteDirection(java.lang.String direction)

setRouteDirection

public void setRouteDirection(java.lang.String direction)

See enum RouteDirection. This is a generalized label given to the route and not the actual route direction. This will not reverse the direction or order of the route.

getRouteDirection

public Route.RouteDirection getRouteDirection()

isReversedDir

public boolean isReversedDir()

isRouteType

public static boolean isRouteType(java.lang.String type)

setRouteType

public void setRouteType(java.lang.String type)

See enum RouteType

getRouteType

public Route.RouteType getRouteType()

setPlanningMethod

public void setPlanningMethod(java.lang.String method)

See enum PlanningMethod

getPlanningMethod

public java.lang.String getPlanningMethod()

isRouteOrder

public static boolean isRouteOrder(java.lang.String order)

setRouteOrder

public void setRouteOrder(java.lang.String order)

See enum RouteOrder

getRouteOrder

public Route.RouteOrder getRouteOrder()

getLastWaypointName

public java.lang.String getLastWaypointName()

getFirstWaypointName

public java.lang.String getFirstWaypointName()

getNextWaypointName

public java.lang.String getNextWaypointName()

getWaypointUID

public java.lang.String getWaypointUID(int waypointNumber)

getRouteDetails

public java.util.List<java.lang.String[]> getRouteDetails()

Returns a list of arrays that describe the route details where the array is as described: [0] - callsign (set last) [1] - distance in miles [2] - distance in kilometers [3] - elevation change [4] - uid

getMinimumDistance

public double getMinimumDistance(PointMapItem refPoint)

Finds the closest point distance, within this route, to the reference point.

Parameters:

refPoint - The reference point.

Returns:

The minimum distance to the point of interest.

getMaximumDistance

public double getMaximumDistance(PointMapItem refPoint)

Finds the farthest point distance, within this route, to the reference point.

Parameters:

refPoint - The reference point.

Returns:

The maximum distance to the point of interest.

compare

public static boolean compare(Route route1,
                              Route route2)

Compares two routes to determine if they're identical.

Parameters:

route1 - The first route to compare.

route2 - The second route to compare.

Returns:

True if the two routes are identical; False otherwise.

createWayPoint

public static Marker createWayPoint(GeoPointMetaData geoPoint,
                                    java.lang.String uid)

Creates a waypoint marker.

Parameters:

geoPoint -

Returns:

Marker representing a waypoint.

createControlPoint

public static PointMapItem createControlPoint(GeoPoint geoPoint)

Creates a ControlPoint marker with a random uid.

Parameters:

geoPoint -

Returns:

Marker representing a waypoint.

createControlPoint

public static PointMapItem createControlPoint(GeoPoint geoPoint,
                                              java.lang.String uid)

Creates a ControlPoint marker with an assigned uid.

Parameters:

geoPoint -

uid -

Returns:

Marker representing a waypoint.

toCot

protected CotEvent toCot()

Description copied from class: EditablePolyline

Produce a CoT message that represents the Route

Overrides:

toCot in class EditablePolyline

toKml

protected Folder toKml()

Overrides:

toKml in class EditablePolyline

toKmz

protected KMZFolder toKmz()

Overrides:

toKmz in class EditablePolyline

toGpx

protected GPXExportWrapper toGpx()

Overrides:

toGpx in class EditablePolyline

getContactPoints

public PointMapItem[] getContactPoints()