NASA World Wind

gov.nasa.worldwind.layers.Earth
Class MGRSGraticuleLayer

java.lang.Object
  extended by gov.nasa.worldwind.avlist.AVListImpl
      extended by gov.nasa.worldwind.WWObjectImpl
          extended by gov.nasa.worldwind.layers.AbstractLayer
              extended by gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
                  extended by gov.nasa.worldwind.layers.Earth.MGRSGraticuleLayer
All Implemented Interfaces:
AVList, Disposable, Layer, Restorable, WWObject, java.beans.PropertyChangeListener, java.util.EventListener

public class MGRSGraticuleLayer
extends UTMGraticuleLayer


Nested Class Summary
 
Nested classes/interfaces inherited from class gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
UTMGraticuleLayer.GridElement
 
Field Summary
static java.lang.String GRATICULE_100000M
          Graticule for the 100,000 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_10000M
          Graticule for the 10,000 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_1000M
          Graticule for the 1,000 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_100M
          Graticule for the 100 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_10M
          Graticule for the 10 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_1M
          Graticule for the 1 meter grid, nested inside the UTM grid.
static java.lang.String GRATICULE_UTM_GRID
          Graticule for the UTM grid.
 
Fields inherited from class gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
GRATICULE_UTM, LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_SOLID
 
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl
changeSupport
 
Constructor Summary
MGRSGraticuleLayer()
          Creates a new MGRSGraticuleLayer, with default graticule attributes.
 
Method Summary
 void doRender(DrawContext dc)
           
 java.awt.Color getGraticuleLineColor(java.lang.String graticuleType)
          Returns the line color of the specified graticule.
 java.lang.String getGraticuleLineStyle(java.lang.String graticuleType)
          Returns the line rendering style of the specified graticule.
 double getGraticuleLineWidth(java.lang.String graticuleType)
          Returns the line width of the specified graticule.
 java.awt.Color getLabelColor(java.lang.String graticuleType)
          Returns the label color of the specified graticule.
 java.awt.Font getLabelFont(java.lang.String graticuleType)
          Returns the label font of the specified graticule.
 java.lang.String getMaximumGraticuleResolution()
          Returns the maxiumum resolution graticule that will be rendered, or null if no graticules will be rendered.
 boolean isDrawLabels(java.lang.String graticuleType)
          Returns whether specified graticule labels will be rendered.
 void setDrawLabels(boolean drawLabels)
          Sets whether all graticule labels will be rendered.
 void setDrawLabels(boolean drawLabels, java.lang.Iterable<java.lang.String> graticuleType)
          Sets whether the specified graticule labels will be rendered.
 void setDrawLabels(boolean drawLabels, java.lang.String graticuleType)
          Sets whether the specified graticule labels will be rendered.
 void setGraticuleLineColor(java.awt.Color color)
          Sets the line rendering color for all graticules.
 void setGraticuleLineColor(java.awt.Color color, java.lang.Iterable<java.lang.String> graticuleType)
          Sets the line rendering color for the specified graticules.
 void setGraticuleLineColor(java.awt.Color color, java.lang.String graticuleType)
          Sets the line rendering color for the specified graticule.
 void setGraticuleLineStyle(java.lang.String lineStyle)
          Sets the line rendering style for all graticules.
 void setGraticuleLineStyle(java.lang.String lineStyle, java.lang.Iterable<java.lang.String> graticuleType)
          Sets the line rendering style for the specified graticules.
 void setGraticuleLineStyle(java.lang.String lineStyle, java.lang.String graticuleType)
          Sets the line rendering style for the specified graticule.
 void setGraticuleLineWidth(double lineWidth)
          Sets the line rendering width for all graticules.
 void setGraticuleLineWidth(double lineWidth, java.lang.Iterable<java.lang.String> graticuleType)
          Sets the line rendering width for the specified graticules.
 void setGraticuleLineWidth(double lineWidth, java.lang.String graticuleType)
          Sets the line rendering width for the specified graticule.
 void setLabelColor(java.awt.Color color)
          Sets the label rendering color for all graticules.
 void setLabelColor(java.awt.Color color, java.lang.Iterable<java.lang.String> graticuleType)
          Sets the label rendering color for the specified graticules.
 void setLabelColor(java.awt.Color color, java.lang.String graticuleType)
          Sets the label rendering color for the specified graticule.
 void setLabelFont(java.awt.Font font)
          Sets the label rendering font for all graticules.
 void setLabelFont(java.awt.Font font, java.lang.Iterable<java.lang.String> graticuleType)
          Sets the label rendering font for the specified graticules.
 void setLabelFont(java.awt.Font font, java.lang.String graticuleType)
          Sets the label rendering font for the specified graticule.
 void setMaximumGraticuleResolution(java.lang.String graticuleType)
          Sets the maxiumum resolution graticule that will be rendered.
 
Methods inherited from class gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
addRenderable, getGraticuleLineColor, getGraticuleLineStyle, getGraticuleLineWidth, getLabelColor, getLabelFont, getRenderingParams, getRestorableState, isDrawGraticule, isDrawLabels, removeAllRenderables, renderGraticule, restoreState, selectUTMRenderables, setDrawGraticule, setRenderingParams
 
Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer
dispose, doPick, getMaxActiveAltitude, getMinActiveAltitude, getName, getOpacity, getScale, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isPickEnabled, pick, render, setEnabled, setMaxActiveAltitude, setMinActiveAltitude, setName, setOpacity, setPickEnabled, toString
 
Methods inherited from class gov.nasa.worldwind.WWObjectImpl
propertyChange
 
Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nasa.worldwind.avlist.AVList
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 

Field Detail

GRATICULE_100000M

public static final java.lang.String GRATICULE_100000M
Graticule for the 100,000 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_10000M

public static final java.lang.String GRATICULE_10000M
Graticule for the 10,000 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_1000M

public static final java.lang.String GRATICULE_1000M
Graticule for the 1,000 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_100M

public static final java.lang.String GRATICULE_100M
Graticule for the 100 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_10M

public static final java.lang.String GRATICULE_10M
Graticule for the 10 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_1M

public static final java.lang.String GRATICULE_1M
Graticule for the 1 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_UTM_GRID

public static final java.lang.String GRATICULE_UTM_GRID
Graticule for the UTM grid.

See Also:
Constant Field Values
Constructor Detail

MGRSGraticuleLayer

public MGRSGraticuleLayer()
Creates a new MGRSGraticuleLayer, with default graticule attributes.

Method Detail

doRender

public void doRender(DrawContext dc)
Overrides:
doRender in class UTMGraticuleLayer

getGraticuleLineColor

public java.awt.Color getGraticuleLineColor(java.lang.String graticuleType)
Returns the line color of the specified graticule.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
Color of the the graticule line.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getGraticuleLineStyle

public java.lang.String getGraticuleLineStyle(java.lang.String graticuleType)
Returns the line rendering style of the specified graticule.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
line rendering style of the graticule.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getGraticuleLineWidth

public double getGraticuleLineWidth(java.lang.String graticuleType)
Returns the line width of the specified graticule.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
width of the graticule line.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getLabelColor

public java.awt.Color getLabelColor(java.lang.String graticuleType)
Returns the label color of the specified graticule.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
Color of the the graticule label.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getLabelFont

public java.awt.Font getLabelFont(java.lang.String graticuleType)
Returns the label font of the specified graticule.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
Font of the graticule label.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getMaximumGraticuleResolution

public java.lang.String getMaximumGraticuleResolution()
Returns the maxiumum resolution graticule that will be rendered, or null if no graticules will be rendered. By default, all graticules are rendered, and this will return GRATICULE_1M.

Returns:
maximum resolution rendered.

isDrawLabels

public boolean isDrawLabels(java.lang.String graticuleType)
Returns whether specified graticule labels will be rendered.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Returns:
true if graticule labels are will be rendered; false otherwise.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setDrawLabels

public void setDrawLabels(boolean drawLabels)
Sets whether all graticule labels will be rendered. If true, all graticule labels will be rendered. Otherwise, all graticule labels will not be rendered.

Overrides:
setDrawLabels in class UTMGraticuleLayer
Parameters:
drawLabels - true to render all graticule labels; false to disable rendering.

setDrawLabels

public void setDrawLabels(boolean drawLabels,
                          java.lang.Iterable<java.lang.String> graticuleType)
Sets whether the specified graticule labels will be rendered. If true, the graticule labels will be rendered. Otherwise, the graticule labels will not be rendered, but other graticules will not be affected.

Parameters:
drawLabels - true to render graticule labels; false to disable rendering.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setDrawLabels

public void setDrawLabels(boolean drawLabels,
                          java.lang.String graticuleType)
Sets whether the specified graticule labels will be rendered. If true, the graticule labels will be rendered. Otherwise, the graticule labels will not be rendered, but other graticules will not be affected.

Parameters:
drawLabels - true to render graticule labels; false to disable rendering.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineColor

public void setGraticuleLineColor(java.awt.Color color)
Sets the line rendering color for all graticules.

Overrides:
setGraticuleLineColor in class UTMGraticuleLayer
Parameters:
color - the line color.
Throws:
java.lang.IllegalArgumentException - if color is null.

setGraticuleLineColor

public void setGraticuleLineColor(java.awt.Color color,
                                  java.lang.Iterable<java.lang.String> graticuleType)
Sets the line rendering color for the specified graticules.

Parameters:
color - the line color for the specified graticules.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineColor

public void setGraticuleLineColor(java.awt.Color color,
                                  java.lang.String graticuleType)
Sets the line rendering color for the specified graticule.

Parameters:
color - the line color for the specified graticule.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineStyle

public void setGraticuleLineStyle(java.lang.String lineStyle)
Sets the line rendering style for all graticules.

Overrides:
setGraticuleLineStyle in class UTMGraticuleLayer
Parameters:
lineStyle - the line rendering style. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
Throws:
java.lang.IllegalArgumentException - if lineStyle is null.

setGraticuleLineStyle

public void setGraticuleLineStyle(java.lang.String lineStyle,
                                  java.lang.Iterable<java.lang.String> graticuleType)
Sets the line rendering style for the specified graticules.

Parameters:
lineStyle - the line rendering style for the specified graticules. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M
Throws:
java.lang.IllegalArgumentException - if lineStyle is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineStyle

public void setGraticuleLineStyle(java.lang.String lineStyle,
                                  java.lang.String graticuleType)
Sets the line rendering style for the specified graticule.

Parameters:
lineStyle - the line rendering style for the specified graticule. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M
Throws:
java.lang.IllegalArgumentException - if lineStyle is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineWidth

public void setGraticuleLineWidth(double lineWidth)
Sets the line rendering width for all graticules.

Overrides:
setGraticuleLineWidth in class UTMGraticuleLayer
Parameters:
lineWidth - the line rendering width.

setGraticuleLineWidth

public void setGraticuleLineWidth(double lineWidth,
                                  java.lang.Iterable<java.lang.String> graticuleType)
Sets the line rendering width for the specified graticules.

Parameters:
lineWidth - the line rendering width for the specified graticules.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineWidth

public void setGraticuleLineWidth(double lineWidth,
                                  java.lang.String graticuleType)
Sets the line rendering width for the specified graticule.

Parameters:
lineWidth - the line rendering width for the specified graticule.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setLabelColor

public void setLabelColor(java.awt.Color color)
Sets the label rendering color for all graticules.

Overrides:
setLabelColor in class UTMGraticuleLayer
Parameters:
color - the label color.
Throws:
java.lang.IllegalArgumentException - if color is null.

setLabelColor

public void setLabelColor(java.awt.Color color,
                          java.lang.Iterable<java.lang.String> graticuleType)
Sets the label rendering color for the specified graticules.

Parameters:
color - the label color for the specified graticules.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelColor

public void setLabelColor(java.awt.Color color,
                          java.lang.String graticuleType)
Sets the label rendering color for the specified graticule.

Parameters:
color - the label color for the specified graticule.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelFont

public void setLabelFont(java.awt.Font font)
Sets the label rendering font for all graticules.

Overrides:
setLabelFont in class UTMGraticuleLayer
Parameters:
font - the label font.
Throws:
java.lang.IllegalArgumentException - if font is null.

setLabelFont

public void setLabelFont(java.awt.Font font,
                         java.lang.Iterable<java.lang.String> graticuleType)
Sets the label rendering font for the specified graticules.

Parameters:
font - the label font for the specified graticules.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelFont

public void setLabelFont(java.awt.Font font,
                         java.lang.String graticuleType)
Sets the label rendering font for the specified graticule.

Parameters:
font - the label font for the specified graticule.
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.

setMaximumGraticuleResolution

public void setMaximumGraticuleResolution(java.lang.String graticuleType)
Sets the maxiumum resolution graticule that will be rendered.

Parameters:
graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
Throws:
java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

NASA World Wind