com.atakmap.android.imagecapture

Class CustomGrid

java.lang.Object

AbstractLayer

com.atakmap.android.imagecapture.CustomGrid

All Implemented Interfaces:

Capturable

public class CustomGrid
extends AbstractLayer
implements Capturable

A customizable MGRS-aligned grid

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomGrid.OnChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	CEIL
static java.lang.String	COLOR_PREF
static int	FLOOR
static java.lang.String	LABELS_PREF
static int	ROUND
static java.lang.String	SPACING_PREF
static java.lang.String	UNITS_PREF

Constructor Summary

Constructors

Constructor and Description
CustomGrid(MapView mapView, java.lang.String uid) Construct a custom grid overlay.

Method Summary

Modifier and Type	Method and Description
void	addOnChangedListener(CustomGrid.OnChangedListener ocl)
void	clear() Unset the coordinates for the layer.
void	drawCanvas(CapturePP cap, android.os.Bundle data) Draw the item to the canvas
void	drawFittedGrid(ImageryCapturePP cap) Draw fitted grid to canvas
static double	gcf(double val1, double val2)
GeoBounds	getBounds()
GeoPoint	getCenter()
Marker	getCenterMarker()
int	getColor() Returns the color used for the grid lines.
GeoPoint[]	getCorners()
int	getHorizontalLineCount()
int	getLabelPrecision() Get the appropriate label value precision based on spacing
java.lang.String[]	getLabels(boolean trunc) Get the list of grid labels (horizontal first then vertical)
int	getNumColumns()
int	getNumRows()
double	getSpacing() Return grid spacing
float	getStrokeWeight()
int	getVerticalLineCount()
boolean	isDrawingLabels(double lat, double mapRes) Test whether this grid is drawing it's labels This is different than showLabels since it also depends on the map zoom level
boolean	isValid() Return true if the coordinates for the layer are valid.
boolean	isVisible()
void	onChanged(boolean recalcGrid)
boolean	place(GeoPoint c)
boolean	place(GeoPoint c, int cols, int rows) Define grid extends based on center and size
android.os.Bundle	preDrawCanvas(CapturePP cap) Save forwarded points to meta data holder These will be used later in drawCanvas
void	removeOnChangedListener(CustomGrid.OnChangedListener ocl)
static double	round(double val, double nearest, int roundType)
void	setColor(int color) Sets the color of the grid lines used for the Custom grid
void	setCorners(GeoPointMetaData corner1, GeoPointMetaData corner2) Sets the four corners of the customized grid.
void	setLabelPrecision(int precision) Set the label precision manually
void	setShowLabels(boolean show)
void	setSpacing(double meters)
void	setStrokeWeight(float strokeWeight) Sets the stroke weight of the custom Grid
void	setVisible(boolean visible)
boolean	showLabels()

Methods inherited from class java.lang.Object

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

Field Detail

SPACING_PREF

public static final java.lang.String SPACING_PREF

See Also:

Constant Field Values

COLOR_PREF

public static final java.lang.String COLOR_PREF

See Also:

Constant Field Values

UNITS_PREF

public static final java.lang.String UNITS_PREF

See Also:

Constant Field Values

LABELS_PREF

public static final java.lang.String LABELS_PREF

See Also:

Constant Field Values

FLOOR

public static final int FLOOR

See Also:

Constant Field Values

ROUND

public static final int ROUND

See Also:

Constant Field Values

CEIL

public static final int CEIL

See Also:

Constant Field Values

Constructor Detail

CustomGrid

public CustomGrid(MapView mapView,
                  java.lang.String uid)

Construct a custom grid overlay.

Parameters:

mapView - the mapview

uid - the uid

Method Detail

setCorners

public void setCorners(GeoPointMetaData corner1,
                       GeoPointMetaData corner2)

Sets the four corners of the customized grid.

Parameters:

corner1 - upper left

corner2 - lower right

clear

public void clear()

Unset the coordinates for the layer.

isValid

public boolean isValid()

Return true if the coordinates for the layer are valid.

Returns:

true if the coordinates are valid.

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

setColor

public void setColor(int color)

Sets the color of the grid lines used for the Custom grid

Parameters:

color - the color as an integer value where the alpha is ignored.

getColor

public int getColor()

Returns the color used for the grid lines. The color will not have any alpha property.

Returns:

the color

setStrokeWeight

public void setStrokeWeight(float strokeWeight)

Sets the stroke weight of the custom Grid

Parameters:

strokeWeight - the weight

getStrokeWeight

public float getStrokeWeight()

setShowLabels

public void setShowLabels(boolean show)

showLabels

public boolean showLabels()

setSpacing

public void setSpacing(double meters)

getSpacing

public double getSpacing()

Return grid spacing

Returns:

Spacing between cells in meters

getVerticalLineCount

public int getVerticalLineCount()

getHorizontalLineCount

public int getHorizontalLineCount()

getNumColumns

public int getNumColumns()

getNumRows

public int getNumRows()

getBounds

public GeoBounds getBounds()

getCorners

public GeoPoint[] getCorners()

getCenter

public GeoPoint getCenter()

getCenterMarker

public Marker getCenterMarker()

place

public boolean place(GeoPoint c,
                     int cols,
                     int rows)

Define grid extends based on center and size

Parameters:

c - Grid center

cols - Number of grid columns

rows - Number of grid rows

Returns:

True if placement successful, false otherwise

place

public boolean place(GeoPoint c)

isDrawingLabels

public boolean isDrawingLabels(double lat,
                               double mapRes)

Test whether this grid is drawing it's labels This is different than showLabels since it also depends on the map zoom level

Parameters:

lat - Draw latitude

mapRes - Map resolution

Returns:

True if drawing labels

getLabelPrecision

public int getLabelPrecision()

Get the appropriate label value precision based on spacing

Returns:

Value precision (i.e. 100m spacing = first 3 digits)

setLabelPrecision

public void setLabelPrecision(int precision)

Set the label precision manually

Parameters:

precision - Precision from 0 to 5 (0 means use automatic)

getLabels

public java.lang.String[] getLabels(boolean trunc)

Get the list of grid labels (horizontal first then vertical)

Parameters:

trunc - Truncate according to the default precision

Returns:

List of labels

preDrawCanvas

public android.os.Bundle preDrawCanvas(CapturePP cap)

Description copied from interface: Capturable

Save forwarded points to meta data holder These will be used later in drawCanvas

Specified by:

preDrawCanvas in interface Capturable

Parameters:

cap - Capture instance (use forward() to convert)

Returns:

Metadata containing point data (or anything else relevant to ortho)

drawCanvas

public void drawCanvas(CapturePP cap,
                       android.os.Bundle data)

Description copied from interface: Capturable

Draw the item to the canvas

Specified by:

drawCanvas in interface Capturable

Parameters:

cap - Canvas to draw to (use getCanvas())

data - Point data saved in preDrawCanvas

drawFittedGrid

public void drawFittedGrid(ImageryCapturePP cap)

Draw fitted grid to canvas

Parameters:

cap - Capture post-processor

round

public static double round(double val,
                           double nearest,
                           int roundType)

gcf

public static double gcf(double val1,
                         double val2)

onChanged

public void onChanged(boolean recalcGrid)

addOnChangedListener

public void addOnChangedListener(CustomGrid.OnChangedListener ocl)

removeOnChangedListener

public void removeOnChangedListener(CustomGrid.OnChangedListener ocl)