Overview  Package   Class  Use  Tree  Index  Help 
NASA World Wind
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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.AbstractGraticuleLayer
                  extended by gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
                      extended by gov.nasa.worldwind.layers.Earth.MGRSGraticuleLayer
All Implemented Interfaces:
AVList, Disposable, Layer, Restorable, WWObject, PropertyChangeListener, EventListener
public class MGRSGraticuleLayer
extends UTMGraticuleLayer

Nested Class Summary
 
Nested classes/interfaces inherited from class gov.nasa.worldwind.layers.AbstractGraticuleLayer
AbstractGraticuleLayer.GridElement
 
Field Summary
static String GRATICULE_100000M
          Graticule for the 100,000 meter grid, nested inside the UTM grid.
static String GRATICULE_10000M
          Graticule for the 10,000 meter grid, nested inside the UTM grid.
static String GRATICULE_1000M
          Graticule for the 1,000 meter grid, nested inside the UTM grid.
static String GRATICULE_100M
          Graticule for the 100 meter grid, nested inside the UTM grid.
static String GRATICULE_10M
          Graticule for the 10 meter grid, nested inside the UTM grid.
static String GRATICULE_1M
          Graticule for the 1 meter grid, nested inside the UTM grid.
static 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.layers.AbstractGraticuleLayer
graticuleSupport, gridElements
 
Fields inherited from class gov.nasa.worldwind.layers.AbstractLayer
screenCredit
 
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl
changeSupport
 
Constructor Summary
MGRSGraticuleLayer()
          Creates a new MGRSGraticuleLayer, with default graticule attributes.
 
Method Summary
protected  void clear(DrawContext dc)
           
 Position computePosition(int zone, char hemisphere, double easting, double northing)
           
 Position computePositionFromUPS(char hemisphere, double easting, double northing)
           
 Position computePositionFromUTM(int zone, char hemisphere, double easting, double northing)
           
protected  double computeTerrainConformance(DrawContext dc)
           
protected  Sector computeVisibleSector(DrawContext dc)
           
 void doRender(DrawContext dc)
           
 Color getGraticuleLineColor(String graticuleType)
          Returns the line color of the specified graticule.
 String getGraticuleLineStyle(String graticuleType)
          Returns the line rendering style of the specified graticule.
 double getGraticuleLineWidth(String graticuleType)
          Returns the line width of the specified graticule.
 Color getLabelColor(String graticuleType)
          Returns the label color of the specified graticule.
 Font getLabelFont(String graticuleType)
          Returns the label font of the specified graticule.
 String getMaximumGraticuleResolution()
          Returns the maxiumum resolution graticule that will be rendered, or null if no graticules will be rendered.
 boolean isDrawLabels(String graticuleType)
          Returns whether specified graticule labels will be rendered.
protected  boolean needsToUpdate(DrawContext dc)
          Determines whether the grid should be updated.
protected  void selectMGRSRenderables(DrawContext dc, Sector vs)
           
 void setDrawLabels(boolean drawLabels)
          Sets whether all graticule labels will be rendered.
 void setDrawLabels(boolean drawLabels, Iterable<String> graticuleType)
          Sets whether the specified graticule labels will be rendered.
 void setDrawLabels(boolean drawLabels, String graticuleType)
          Sets whether the specified graticule labels will be rendered.
 void setGraticuleLineColor(Color color)
          Sets the line rendering color for all graticules.
 void setGraticuleLineColor(Color color, Iterable<String> graticuleType)
          Sets the line rendering color for the specified graticules.
 void setGraticuleLineColor(Color color, String graticuleType)
          Sets the line rendering color for the specified graticule.
 void setGraticuleLineStyle(String lineStyle)
          Sets the line rendering style for all graticules.
 void setGraticuleLineStyle(String lineStyle, Iterable<String> graticuleType)
          Sets the line rendering style for the specified graticules.
 void setGraticuleLineStyle(String lineStyle, 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, Iterable<String> graticuleType)
          Sets the line rendering width for the specified graticules.
 void setGraticuleLineWidth(double lineWidth, String graticuleType)
          Sets the line rendering width for the specified graticule.
 void setLabelColor(Color color)
          Sets the label rendering color for all graticules.
 void setLabelColor(Color color, Iterable<String> graticuleType)
          Sets the label rendering color for the specified graticules.
 void setLabelColor(Color color, String graticuleType)
          Sets the label rendering color for the specified graticule.
 void setLabelFont(Font font)
          Sets the label rendering font for all graticules.
 void setLabelFont(Font font, Iterable<String> graticuleType)
          Sets the label rendering font for the specified graticules.
 void setLabelFont(Font font, String graticuleType)
          Sets the label rendering font for the specified graticule.
 void setMaximumGraticuleResolution(String graticuleType)
          Sets the maxiumum resolution graticule that will be rendered.
 
Methods inherited from class gov.nasa.worldwind.layers.Earth.UTMGraticuleLayer
getGraticuleLineColor, getGraticuleLineStyle, getGraticuleLineWidth, getLabelColor, getLabelFont, isDrawGraticule, isDrawLabels, selectUTMRenderables, setDrawGraticule
 
Methods inherited from class gov.nasa.worldwind.layers.AbstractGraticuleLayer
addRenderable, computeAltitudeAboveGround, getRenderingParams, getRestorableState, getSurfacePoint, isDrawGraticule, removeAllRenderables, renderGraticule, restoreState, selectRenderables, setDrawGraticule, setRenderingParams
 
Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer
dispose, doPick, doPreRender, getExpiryTime, getMaxActiveAltitude, getMinActiveAltitude, getName, getOpacity, getScale, getScreenCredit, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isNetworkRetrievalEnabled, isPickEnabled, pick, preRender, render, setEnabled, setExpiryTime, setMaxActiveAltitude, setMinActiveAltitude, setName, setNetworkRetrievalEnabled, setOpacity, setPickEnabled, setScreenCredit, 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 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 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 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 String GRATICULE_100M
Graticule for the 100 meter grid, nested inside the UTM grid.

See Also:
Constant Field Values

GRATICULE_10M

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

See Also:
Constant Field Values

GRATICULE_1M

public static final 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 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

clear

protected void clear(DrawContext dc)

computePosition

public Position computePosition(int zone,
                                char hemisphere,
                                double easting,
                                double northing)

computePositionFromUPS

public Position computePositionFromUPS(char hemisphere,
                                       double easting,
                                       double northing)

computePositionFromUTM

public Position computePositionFromUTM(int zone,
                                       char hemisphere,
                                       double easting,
                                       double northing)

computeTerrainConformance

protected double computeTerrainConformance(DrawContext dc)

computeVisibleSector

protected Sector computeVisibleSector(DrawContext dc)

doRender

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

getGraticuleLineColor

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

Overrides:
getGraticuleLineColor in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getGraticuleLineStyle

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

Overrides:
getGraticuleLineStyle in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getGraticuleLineWidth

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

Overrides:
getGraticuleLineWidth in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getLabelColor

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

Overrides:
getLabelColor in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getLabelFont

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

Overrides:
getLabelFont in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

getMaximumGraticuleResolution

public 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(String graticuleType)
Returns whether specified graticule labels will be rendered.

Overrides:
isDrawLabels in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

needsToUpdate

protected boolean needsToUpdate(DrawContext dc)
Determines whether the grid should be updated. It returns true if:
  • the eye has moved more than 1% of its altitude above ground
  • the view FOV, heading or pitch have changed more than 1 degree
  • vertical exaggeration has changed
Parameters:
dc - the current DrawContext.
Returns:
true if the graticule should be updated.

selectMGRSRenderables

protected void selectMGRSRenderables(DrawContext dc,
                                     Sector vs)

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,
                          Iterable<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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setDrawLabels

public void setDrawLabels(boolean drawLabels,
                          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.

Overrides:
setDrawLabels in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineColor

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

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

setGraticuleLineColor

public void setGraticuleLineColor(Color color,
                                  Iterable<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:
IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineColor

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

Overrides:
setGraticuleLineColor in class AbstractGraticuleLayer
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:
IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineStyle

public void setGraticuleLineStyle(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:
IllegalArgumentException - if lineStyle is null.

setGraticuleLineStyle

public void setGraticuleLineStyle(String lineStyle,
                                  Iterable<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:
IllegalArgumentException - if lineStyle is null, if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineStyle

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

Overrides:
setGraticuleLineStyle in class AbstractGraticuleLayer
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:
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,
                                  Iterable<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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setGraticuleLineWidth

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

Overrides:
setGraticuleLineWidth in class AbstractGraticuleLayer
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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.

setLabelColor

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

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

setLabelColor

public void setLabelColor(Color color,
                          Iterable<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:
IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelColor

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

Overrides:
setLabelColor in class AbstractGraticuleLayer
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:
IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelFont

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

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

setLabelFont

public void setLabelFont(Font font,
                         Iterable<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:
IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.

setLabelFont

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

Overrides:
setLabelFont in class AbstractGraticuleLayer
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:
IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.

setMaximumGraticuleResolution

public void setMaximumGraticuleResolution(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:
IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
Overview  Package   Class  Use  Tree  Index  Help 
NASA World Wind
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Hosted by docs.bugaco.com