com.atakmap.android.user

Class PlacePointTool.MarkerCreator

java.lang.Object

com.atakmap.android.user.PlacePointTool.MarkerCreator

Enclosing class:

PlacePointTool

public static class PlacePointTool.MarkerCreator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MarkerCreator(GeoPoint point) Build a marker creator with a point supplied.
MarkerCreator(GeoPointMetaData point) Build a marker with a more robust GeoPointMetaData point.

Method Summary

Modifier and Type	Method and Description
PlacePointTool.MarkerCreator	disableAutomaticIcon(boolean disable) If the flag is set to true, ATAK will make no effort to set an icon or change an icon for the marker dropped.
Marker	placePoint()
PlacePointTool.MarkerCreator	setAction(java.lang.String action) The ability to perform an action on the newly created marker after it is dropped.
PlacePointTool.MarkerCreator	setArchive(boolean archive) Defaults to true and signals if this marker should be saved to the database This is different from nevercot since it allows for a marker to be turned into cursor on target but does not allow it to be persisted.
PlacePointTool.MarkerCreator	setCallsign(java.lang.String callsign)
PlacePointTool.MarkerCreator	setColor(int color) Indicates the color of the marker.
PlacePointTool.MarkerCreator	setHow(java.lang.String how) Sets the CoT how for a marker such as m-g or h-i-g-o
PlacePointTool.MarkerCreator	setIconPath(java.lang.String iconsetPath) The iconset path to use when rendering the icon for the marker
PlacePointTool.MarkerCreator	setMetaString(java.lang.String key, java.lang.String value) Ability to set meta string properties on the Marker prior to its creation.
PlacePointTool.MarkerCreator	setNeverPersist(boolean persist) Defaults to false and indicates if this marker should never be turned into CoT
PlacePointTool.MarkerCreator	setPrefix(java.lang.String prefix)
PlacePointTool.MarkerCreator	setReadiness(boolean readiness) Sets the readiness flag for the marker.
PlacePointTool.MarkerCreator	setShowFiveLine(boolean show) For markers that when placed automatically show the five line when placed, show the five line based on the boolean
PlacePointTool.MarkerCreator	setShowMedNineLine(boolean showMedNineLine)
PlacePointTool.MarkerCreator	setShowNewRadial(boolean showNewRadial)
PlacePointTool.MarkerCreator	setShowNineLine(boolean showNineLine)
PlacePointTool.MarkerCreator	setShowNineLine(boolean showNineLine, java.lang.String friendlyUID)
PlacePointTool.MarkerCreator	setTextColor(int color)
PlacePointTool.MarkerCreator	setType(java.lang.String type) Sets the type of the marker based on the CoT 2525 types or custom types used in ATAK
PlacePointTool.MarkerCreator	setUid(java.lang.String uid) Sets the uid of the marker.
PlacePointTool.MarkerCreator	showCotDetails(boolean showEditor) The ability to disable the editor from displaying when a marker is dropped.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerCreator

public MarkerCreator(GeoPoint point)

Build a marker creator with a point supplied.

Parameters:

point - the point for the MarkerCreator.

MarkerCreator

public MarkerCreator(GeoPointMetaData point)

Build a marker with a more robust GeoPointMetaData point.

Parameters:

point - the point for the marker.

Method Detail

setMetaString

public PlacePointTool.MarkerCreator setMetaString(java.lang.String key,
                                                  java.lang.String value)

Ability to set meta string properties on the Marker prior to its creation.

Parameters:

key - the key for the string value

value - the value to be added to the marker prior to persisting

setReadiness

public PlacePointTool.MarkerCreator setReadiness(boolean readiness)

Sets the readiness flag for the marker. In ATAK, this does not visually change the icon but allows for a plugin to do so.

Parameters:

readiness - true or false

Returns:

the MarkerCreator for reuse in a chained call

setType

public PlacePointTool.MarkerCreator setType(java.lang.String type)

Sets the type of the marker based on the CoT 2525 types or custom types used in ATAK

Parameters:

type - the custom type

Returns:

the MarkerCreator for reuse in a chained call

setUid

public PlacePointTool.MarkerCreator setUid(java.lang.String uid)

Sets the uid of the marker.

Parameters:

uid - the universally unique identifier

Returns:

the MarkerCreator for reuse in a chained call

setHow

public PlacePointTool.MarkerCreator setHow(java.lang.String how)

Sets the CoT how for a marker such as m-g or h-i-g-o

Parameters:

how - the how for the CoT

Returns:

the MarkerCreator for reuse in a chained call

setShowFiveLine

public PlacePointTool.MarkerCreator setShowFiveLine(boolean show)

For markers that when placed automatically show the five line when placed, show the five line based on the boolean

Parameters:

show - if true the five line will be shown.

Returns:

the MarkerCreator for reuse in a chained call

setIconPath

public PlacePointTool.MarkerCreator setIconPath(java.lang.String iconsetPath)

The iconset path to use when rendering the icon for the marker

Parameters:

iconsetPath - the iconset path in the appropriate iconset format - usually asset://[uid]/directory/name

Returns:

the MarkerCreator for reuse in a chained call

disableAutomaticIcon

public PlacePointTool.MarkerCreator disableAutomaticIcon(boolean disable)

If the flag is set to true, ATAK will make no effort to set an icon or change an icon for the marker dropped. The user is completely responsible for controlling the icon. This feature is dangerous and requires the plugin to fully manage the icon lifecycle.

Returns:

the MarkerCreator for reuse in a chained call

setNeverPersist

public PlacePointTool.MarkerCreator setNeverPersist(boolean persist)

Defaults to false and indicates if this marker should never be turned into CoT

Parameters:

persist - true means it should never turn into CoT. This is different from archive which indicates that a marker can be turned into CoT.

Returns:

the MarkerCreator for chaining of calls

setArchive

public PlacePointTool.MarkerCreator setArchive(boolean archive)

Defaults to true and signals if this marker should be saved to the database This is different from nevercot since it allows for a marker to be turned into cursor on target but does not allow it to be persisted.

Parameters:

archive - true for saving

Returns:

the MarkerCreator for reuse in a chained call

setCallsign

public PlacePointTool.MarkerCreator setCallsign(java.lang.String callsign)

setPrefix

public PlacePointTool.MarkerCreator setPrefix(java.lang.String prefix)

setColor

public PlacePointTool.MarkerCreator setColor(int color)

Indicates the color of the marker.

Parameters:

color - used to multiply against the existing colors of the icon

Returns:

the MarkerCreator for reuse in a chained call

setTextColor

public PlacePointTool.MarkerCreator setTextColor(int color)

showCotDetails

public PlacePointTool.MarkerCreator showCotDetails(boolean showEditor)

The ability to disable the editor from displaying when a marker is dropped.

Parameters:

showEditor - if showEditor is false, the editor is not shown when the marker is dropped.

Returns:

the MarkerCreator for reuse in a chained call

setShowNineLine

public PlacePointTool.MarkerCreator setShowNineLine(boolean showNineLine)

setAction

public PlacePointTool.MarkerCreator setAction(java.lang.String action)

The ability to perform an action on the newly created marker after it is dropped.

setShowNewRadial

public PlacePointTool.MarkerCreator setShowNewRadial(boolean showNewRadial)

setShowNineLine

public PlacePointTool.MarkerCreator setShowNineLine(boolean showNineLine,
                                                    java.lang.String friendlyUID)

setShowMedNineLine

public PlacePointTool.MarkerCreator setShowMedNineLine(boolean showMedNineLine)

placePoint

public Marker placePoint()