com.atakmap.android.maps

Class PointMapItem

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.PointMapItem

All Implemented Interfaces:

URIContent, HashtagContent, MetaDataHolder, VisibilityListener

Direct Known Subclasses:

CompassRing, Crumb, Marker, MetaMapPoint, RangeRing, Route.ControlPointMapItem

public abstract class PointMapItem
extends MapItem

A MapItem with a GeoPoint

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PointMapItem.OnPointChangedListener

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

MapItem.OnAltitudeModeChangedListener, MapItem.OnClickableChangedListener, MapItem.OnGroupChangedListener, MapItem.OnHeightChangedListener, MapItem.OnMetadataChangedListener, MapItem.OnTypeChangedListener, MapItem.OnVisibleChangedListener, MapItem.OnZOrderChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static GeoPoint	POINT_DEFAULT

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
	PointMapItem(GeoPointMetaData point, java.lang.String uid) Create a PointMapItem given a GeoPoint and the unique identifier
	PointMapItem(GeoPoint point, java.lang.String uid) Create a PointMapItem given a GeoPoint and the unique identifier
protected	PointMapItem(long serialId, GeoPoint point, java.lang.String uid)
protected	PointMapItem(long serialId, MetaDataHolder metadata, GeoPoint point, java.lang.String uid)
protected	PointMapItem(long serialId, MetaDataHolder metadata, java.lang.String uid)

Method Summary

Modifier and Type	Method and Description
void	addOnPointChangedListener(PointMapItem.OnPointChangedListener listener) Add a point property listener.
void	dispose() Clean up all of the resources associated with this MapItem, for destruction.
CrumbTrail	getCrumbTrail()
GeoPointMetaData	getGeoPointMetaData() Convenience method for retrieving the metadata enhanced GeoPoint for a specific PointMapItem.
PersistentCircleCrumbTrail	getPersistentCircleCrumbTrail() Deprecated.
GeoPoint	getPoint() Get the point value.
double	getVolumeHeight()
double	getVolumeRadius() The radius in meters
protected void	onPointChanged() Invoked when the point property changes
void	removeOnPointChangedListener(PointMapItem.OnPointChangedListener listener) Remove a point property listener.
void	setCrumbTrail(CrumbTrail trail)
void	setPersistentCircleCrumbTrail(PersistentCircleCrumbTrail persistentCircleCrumbTrail) Deprecated.
void	setPoint(GeoPoint point) Set the point property value, and notify all relevant listeners that the PointMapItem has changed.
void	setPoint(GeoPointMetaData point) Convenience function for setting a point with the associated metadata from the GeoPointMetaData object.
void	setVolume(double radius, double height) Sets both the radius and the height as one call.

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

addOnAltitudeModeChangedListener, addOnClickableChangedListener, addOnGroupChangedListener, addOnHeightChangedListener, addOnMetadataChangedListener, addOnMetadataChangedListener, addOnTypeChangedListener, addOnVisibleChangedListener, addOnZOrderChangedListener, computeDistance, copyMetaData, createSerialId, getAltitudeMode, getClickable, getClickPoint, getEditable, getGroup, getHashtags, getHeight, getHitRadius, getIconColor, getIconDrawable, getMetaBoolean, getMetaString, getMovable, getRadialMenuPath, getRemarks, getRemarksKey, getSerialId, getTag, getTitle, getType, getUID, getUniqueMapItemName, getURI, getVisible, getVisible, getZOrder, isTouchable, notifyMetadataChanged, onAdded, onAltitudeModeChanged, onClickableChanged, onGroupChanged, onHeightChanged, onMetadataChanged, onRemoved, onTypeChanged, onVisibilityConditions, onVisibleChanged, onZOrderChanged, persist, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setAltitudeMode, setClickable, setClickPoint, setEditable, setHashtags, setHeight, setMetaBoolean, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, setMetaStringArrayList, setMovable, setRadialMenu, setRemarks, setTag, setTitle, 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

POINT_DEFAULT

public static final GeoPoint POINT_DEFAULT

Constructor Detail

PointMapItem

public PointMapItem(GeoPoint point,
                    java.lang.String uid)

Create a PointMapItem given a GeoPoint and the unique identifier

Parameters:

point - the GeoPoint value

Throws:

java.lang.IllegalArgumentException - if point is null

PointMapItem

public PointMapItem(GeoPointMetaData point,
                    java.lang.String uid)

Create a PointMapItem given a GeoPoint and the unique identifier

Parameters:

point - the GeoPointMetaData value

Throws:

java.lang.IllegalArgumentException - if point is null

PointMapItem

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

PointMapItem

protected PointMapItem(long serialId,
                       GeoPoint point,
                       java.lang.String uid)

PointMapItem

protected PointMapItem(long serialId,
                       MetaDataHolder metadata,
                       GeoPoint point,
                       java.lang.String uid)

Method Detail

addOnPointChangedListener

public void addOnPointChangedListener(PointMapItem.OnPointChangedListener listener)

Add a point property listener. If the listener is alreadyed added, no action is performed.

Parameters:

listener - the listener

removeOnPointChangedListener

public void removeOnPointChangedListener(PointMapItem.OnPointChangedListener listener)

Remove a point property listener. If the point listener is not found no action is taken.

Parameters:

listener - the listener

getPoint

public GeoPoint getPoint()

Get the point value.

Returns:

the point value for the PointMapItem

getVolumeHeight

public double getVolumeHeight()

Returns:

the height in meters

getVolumeRadius

public double getVolumeRadius()

The radius in meters

setPoint

public void setPoint(GeoPoint point)

Set the point property value, and notify all relevant listeners that the PointMapItem has changed.

Parameters:

point - the GeoPoint

Throws:

java.lang.IllegalArgumentException - if point is null

setPoint

public void setPoint(GeoPointMetaData point)

Convenience function for setting a point with the associated metadata from the GeoPointMetaData object.

Parameters:

point -

getGeoPointMetaData

public GeoPointMetaData getGeoPointMetaData()

Convenience method for retrieving the metadata enhanced GeoPoint for a specific PointMapItem.

Returns:

a copy of the Point with metadata.

setVolume

public void setVolume(double radius,
                      double height)

Sets both the radius and the height as one call.

Parameters:

radius - the radius in meters

height - the height in meters

onPointChanged

protected void onPointChanged()

Invoked when the point property changes

getCrumbTrail

public CrumbTrail getCrumbTrail()

setCrumbTrail

public void setCrumbTrail(CrumbTrail trail)

getPersistentCircleCrumbTrail

@Deprecated
public PersistentCircleCrumbTrail getPersistentCircleCrumbTrail()

Deprecated.

setPersistentCircleCrumbTrail

@Deprecated
public void setPersistentCircleCrumbTrail(PersistentCircleCrumbTrail persistentCircleCrumbTrail)

Deprecated.

dispose

public void dispose()

Description copied from class: MapItem

Clean up all of the resources associated with this MapItem, for destruction.

Overrides:

dispose in class MapItem