com.atakmap.android.munitions.util

Class MunitionsHelper

java.lang.Object

com.atakmap.android.munitions.util.MunitionsHelper

public class MunitionsHelper
extends java.lang.Object

Helper methods for managing munitions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIVELINE
static java.lang.String	NINELINE
static java.lang.String	TARGET
static java.lang.String	WPN_DISPLAY

Constructor Summary

Constructors

Constructor and Description
MunitionsHelper(MapView mapView, PointMapItem target, java.lang.String fromLine)

Method Summary

Modifier and Type	Method and Description
void	addRangeRings()
void	addRangeRings(boolean visible) Add range rings based on weapon metadata
void	addWeapon(java.lang.String categoryName, java.lang.String weaponName, java.lang.String description, int inner, int outer) Add a weapon to the munitions map
RangeRing	createRangeRing(WeaponData weapon) Create a range ring for a specific weapon
RangeRing	findRangeRing(java.lang.String weaponName) Find the range ring for the given weapon name
java.util.List<RangeRing>	findRangeRings() Find all range rings attached to the target
void	forEachCategory(CategoryConsumer consumer) Loop through each category in the metadata map
void	forEachWeapon(WeaponConsumer consumer) Loop through each weapon in the metadata map
int	getWeaponsCount() Get the total number of weapons
static boolean	hasNoLine(java.lang.String fromLine)
boolean	isVisible()
boolean	isVisible(boolean defaultVisible) Get munitions visibility
void	persist() Persist the target
void	removeAllWeapons() Remove all weapons and associated range rings
void	removeRangeRing(RangeRing r, boolean removeWeapon) Remove the range ring from the map (and map view)
void	removeRangeRings() Remove all range rings that apply to this target (and line) Does NOT remove the weapon entries
void	removeWeapon(java.lang.String categoryName, java.lang.String weaponName) Remove a weapon from the munitions map This method will also remove the category map if it's empty
void	setRangeRingsVisible(boolean visible) Set the visibility of all range rings
void	setVisible(boolean visible) Set munitions visibility

Methods inherited from class java.lang.Object

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

Field Detail

WPN_DISPLAY

public static final java.lang.String WPN_DISPLAY

See Also:

Constant Field Values

NINELINE

public static final java.lang.String NINELINE

See Also:

Constant Field Values

FIVELINE

public static final java.lang.String FIVELINE

See Also:

Constant Field Values

TARGET

public static final java.lang.String TARGET

See Also:

Constant Field Values

Constructor Detail

MunitionsHelper

public MunitionsHelper(MapView mapView,
                       PointMapItem target,
                       java.lang.String fromLine)

Method Detail

addWeapon

public void addWeapon(java.lang.String categoryName,
                      java.lang.String weaponName,
                      java.lang.String description,
                      int inner,
                      int outer)

Add a weapon to the munitions map

Parameters:

categoryName - Weapon category name

weaponName - Weapon name

description - Description

inner - Inner (prone) radius

outer - Outer (standing) radius

removeWeapon

public void removeWeapon(java.lang.String categoryName,
                         java.lang.String weaponName)

Remove a weapon from the munitions map This method will also remove the category map if it's empty

Parameters:

categoryName - Category name

weaponName - Weapon name

removeAllWeapons

public void removeAllWeapons()

Remove all weapons and associated range rings

getWeaponsCount

public int getWeaponsCount()

Get the total number of weapons

Returns:

Total weapons count

setVisible

public void setVisible(boolean visible)

Set munitions visibility

Parameters:

visible - True if visible

isVisible

public boolean isVisible(boolean defaultVisible)

Get munitions visibility

Parameters:

defaultVisible - True if this set of munitions is visible by default

Returns:

True if visible

isVisible

public boolean isVisible()

createRangeRing

public RangeRing createRangeRing(WeaponData weapon)

Create a range ring for a specific weapon

Parameters:

weapon - Weapon data

Returns:

Range ring

findRangeRings

public java.util.List<RangeRing> findRangeRings()

Find all range rings attached to the target

Returns:

List of range rings

findRangeRing

public RangeRing findRangeRing(java.lang.String weaponName)

Find the range ring for the given weapon name

Parameters:

weaponName - Weapon name

Returns:

Range ring or null if not found

removeRangeRing

public void removeRangeRing(RangeRing r,
                            boolean removeWeapon)

Remove the range ring from the map (and map view)

Parameters:

r - Range ring

removeWeapon - True to remove the matching weapon entry

setRangeRingsVisible

public void setRangeRingsVisible(boolean visible)

Set the visibility of all range rings

Parameters:

visible - True if visible

addRangeRings

public void addRangeRings(boolean visible)

Add range rings based on weapon metadata

addRangeRings

public void addRangeRings()

removeRangeRings

public void removeRangeRings()

Remove all range rings that apply to this target (and line) Does NOT remove the weapon entries

persist

public void persist()

Persist the target

forEachCategory

public void forEachCategory(CategoryConsumer consumer)

Loop through each category in the metadata map

Parameters:

consumer - Consumer

forEachWeapon

public void forEachWeapon(WeaponConsumer consumer)

Loop through each weapon in the metadata map

Parameters:

consumer - Consumer

hasNoLine

public static boolean hasNoLine(java.lang.String fromLine)