com.atakmap.android.elev

Class HeatMapOverlay

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem

com.atakmap.android.elev.HeatMapOverlay

All Implemented Interfaces:

HierarchyListItem, MapOverlay

Direct Known Subclasses:

ViewShedLayer2

public class HeatMapOverlay
extends AbstractHierarchyListItem
implements MapOverlay

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HeatMapOverlay.OnHeatMapColorChangedListener
static interface	HeatMapOverlay.OnHeatMapResolutionChangedListener

Nested classes/interfaces inherited from interface com.atakmap.android.hierarchy.HierarchyListItem

HierarchyListItem.ComparatorSort, HierarchyListItem.Sort, HierarchyListItem.SortAlphabet, HierarchyListItem.SortAlphabetDesc, HierarchyListItem.SortDistanceFrom

Constructor Summary

Constructors

Constructor and Description
HeatMapOverlay()

Method Summary

Modifier and Type	Method and Description
void	addOnHeatMapColorChangedListener(HeatMapOverlay.OnHeatMapColorChangedListener l)
void	addOnHeatMapResolutionChangedListener(HeatMapOverlay.OnHeatMapResolutionChangedListener l)
void	addOnLayerVisibleChangedListener(OnLayerVisibleChangedListener l)
<T extends Action> T	getAction(java.lang.Class<T> clazz) Returns an instance of the specified action that can be used to interact with the node's underlying content.
float	getAlpha()
HierarchyListItem	getChildAt(int index) Returns the child node at the specified index.
int	getChildCount() Returns the number of children that this node has.
int	getDescendantCount() Returns the total number of descendant nodes that this node has.
android.view.View	getExtraView() Returns the extra view, if any, associated with the node.
java.lang.String	getIconUri() Returns the URI for the icon for the node.
java.lang.String	getIdentifier() Returns the application unique identifier for the overlay.
HierarchyListItem	getListModel(android.widget.BaseAdapter adapter, long capabilities, HierarchyListItem.Sort preferredSort) Returns the model that may be used to build a UI to interact with the overlay.
java.lang.String	getName() Returns the name of the overlay.
DeepMapItemQuery	getQueryFunction()
MapGroup	getRootGroup() Returns the root MapGroup which will contain all subgroups and MapItem instances for the overlay.
int	getSampleResolutionX()
int	getSampleResolutionY()
float	getSaturation()
java.lang.String	getTitle() Returns the title to be displayed for the item.
java.lang.Object	getUserObject() Returns the user object associated with the node.
float	getValue()
boolean	isChildSupported() Check if list item can contain children
boolean	isVisible()
HierarchyListItem.Sort	refresh(HierarchyListItem.Sort sortHint) Refreshes this node's descendants on the specified sort.
void	removeOnHeatMapColorChangedListener(HeatMapOverlay.OnHeatMapColorChangedListener l)
void	removeOnHeatMapResolutionChangedListener(HeatMapOverlay.OnHeatMapResolutionChangedListener l)
void	removeOnLayerVisibleChangedListener(OnLayerVisibleChangedListener l)
void	setColorComponents(float saturation, float value, float alpha)
void	setResolution(int xSamples, int ySamples)
void	setVisible(boolean visible)

Methods inherited from class com.atakmap.android.hierarchy.items.AbstractHierarchyListItem

getIconColor, getLocalData, getLocalData, getPreferredListIndex, getUID, setLocalData

Methods inherited from class java.lang.Object

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

Constructor Detail

HeatMapOverlay

public HeatMapOverlay()

Method Detail

addOnLayerVisibleChangedListener

public void addOnLayerVisibleChangedListener(OnLayerVisibleChangedListener l)

removeOnLayerVisibleChangedListener

public void removeOnLayerVisibleChangedListener(OnLayerVisibleChangedListener l)

addOnHeatMapResolutionChangedListener

public void addOnHeatMapResolutionChangedListener(HeatMapOverlay.OnHeatMapResolutionChangedListener l)

removeOnHeatMapResolutionChangedListener

public void removeOnHeatMapResolutionChangedListener(HeatMapOverlay.OnHeatMapResolutionChangedListener l)

addOnHeatMapColorChangedListener

public void addOnHeatMapColorChangedListener(HeatMapOverlay.OnHeatMapColorChangedListener l)

removeOnHeatMapColorChangedListener

public void removeOnHeatMapColorChangedListener(HeatMapOverlay.OnHeatMapColorChangedListener l)

getSaturation

public float getSaturation()

getValue

public float getValue()

getAlpha

public float getAlpha()

setColorComponents

public void setColorComponents(float saturation,
                               float value,
                               float alpha)

getSampleResolutionX

public int getSampleResolutionX()

getSampleResolutionY

public int getSampleResolutionY()

setResolution

public void setResolution(int xSamples,
                          int ySamples)

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: MapOverlay

Returns the application unique identifier for the overlay.

Specified by:

getIdentifier in interface MapOverlay

Returns:

The application unique identifier for the overlay.

getName

public java.lang.String getName()

Description copied from interface: MapOverlay

Returns the name of the overlay.

Specified by:

getName in interface MapOverlay

Returns:

The name of the overlay.

getRootGroup

public MapGroup getRootGroup()

Description copied from interface: MapOverlay

Returns the root MapGroup which will contain all subgroups and MapItem instances for the overlay. This method may return null to indicate that the overlay does not contain any content that may be selected or interact with other map items.

Specified by:

getRootGroup in interface MapOverlay

Returns:

The root group for the overlay, or null if the overlay does not contain any selectable content.

getQueryFunction

public DeepMapItemQuery getQueryFunction()

Specified by:

getQueryFunction in interface MapOverlay

getListModel

public HierarchyListItem getListModel(android.widget.BaseAdapter adapter,
                                      long capabilities,
                                      HierarchyListItem.Sort preferredSort)

Description copied from interface: MapOverlay

Returns the model that may be used to build a UI to interact with the overlay. The returned item represents the root node to be displayed in the list. If null, the overlay will not appear in the list.

Specified by:

getListModel in interface MapOverlay

Parameters:

adapter - A reference to the adapter that will be responsible for displaying the list. The overlay may invoke BaseAdapter.notifyDataSetChanged() if the list content is externally modified and the adapter should update.

preferredSort - The preferred sorting order to be used when constructing the list view. This argument is a hint and may be ignored in the event that executing the specified sort will compromise performance. An ascending alphabetic sort is recommended as the default.

Returns:

The list model used to build the UI for the overlay or null if the overlay should not be included in the list.

getTitle

public java.lang.String getTitle()

Description copied from interface: HierarchyListItem

Returns the title to be displayed for the item.

Specified by:

getTitle in interface HierarchyListItem

Returns:

The title to be displayed for the item.

getIconUri

public java.lang.String getIconUri()

Description copied from interface: HierarchyListItem

Returns the URI for the icon for the node.

Specified by:

getIconUri in interface HierarchyListItem

Overrides:

getIconUri in class AbstractHierarchyListItem

Returns:

The URI for the icon for the node, null if the node has no icon, or "gone" to remove the icon space entirely.

getAction

public <T extends Action> T getAction(java.lang.Class<T> clazz)

Description copied from interface: HierarchyListItem

Returns an instance of the specified action that can be used to interact with the node's underlying content.

Specified by:

getAction in interface HierarchyListItem

Parameters:

clazz - The action class

Returns:

An object that can effect the specified action or null if the specified action is not supported for the node.

getUserObject

public java.lang.Object getUserObject()

Description copied from interface: HierarchyListItem

Returns the user object associated with the node. This is the underlying object that the node represents; the actual returned value is implementation dependent.

Specified by:

getUserObject in interface HierarchyListItem

Returns:

The user object associated with the node. May be null.

getExtraView

public android.view.View getExtraView()

Description copied from interface: HierarchyListItem

Returns the extra view, if any, associated with the node. The extra view occupies the space to the right of the line item and can be defined as the developer sees fit. Clicks should be passed through so you can include simple stuff like text, or more interactive things like buttons or check boxes. Should occupy space nicely with range and bearing values if any are present. If no extra view is associated with the node, the space will be empty.

Specified by:

getExtraView in interface HierarchyListItem

Returns:

The extra view associated with this node, or null if there is no view.

getChildCount

public int getChildCount()

Description copied from interface: HierarchyListItem

Returns the number of children that this node has.

Specified by:

getChildCount in interface HierarchyListItem

Returns:

The number of children that the node has.

getChildAt

public HierarchyListItem getChildAt(int index)

Description copied from interface: HierarchyListItem

Returns the child node at the specified index. Behavior is undefined if the index is invalid.

Specified by:

getChildAt in interface HierarchyListItem

Parameters:

index - The index

Returns:

The child node at the specified index.

getDescendantCount

public int getDescendantCount()

Description copied from interface: HierarchyListItem

Returns the total number of descendant nodes that this node has.

Specified by:

getDescendantCount in interface HierarchyListItem

Returns:

The total number of descendant nodes that this node has.

isChildSupported

public boolean isChildSupported()

Description copied from interface: HierarchyListItem

Check if list item can contain children

Specified by:

isChildSupported in interface HierarchyListItem

Overrides:

isChildSupported in class AbstractHierarchyListItem

Returns:

refresh

public HierarchyListItem.Sort refresh(HierarchyListItem.Sort sortHint)

Description copied from interface: HierarchyListItem

Refreshes this node's descendants on the specified sort. If the specified sort cannot be supported, the current sort remains unchanged.

Specified by:

refresh in interface HierarchyListItem

Parameters:

sortHint - The new sort

Returns:

The sort that is actually being used.

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()