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
Class AbstractGraticuleLayer

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
All Implemented Interfaces:
AVList, Disposable, Layer, Restorable, WWObject, PropertyChangeListener, EventListener
Direct Known Subclasses:
LatLonGraticuleLayer, UTMGraticuleLayer
public class AbstractGraticuleLayer
extends AbstractLayer

Displays a graticule.

Nested Class Summary
protected  class AbstractGraticuleLayer.GridElement
           
 
Field Summary
protected  GraticuleSupport graticuleSupport
           
protected  ArrayList<AbstractGraticuleLayer.GridElement> gridElements
           
 
Fields inherited from class gov.nasa.worldwind.layers.AbstractLayer
screenCredit
 
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl
changeSupport
 
Constructor Summary
AbstractGraticuleLayer()
           
 
Method Summary
protected  void addRenderable(Object renderable, String paramsKey)
           
protected  double computeAltitudeAboveGround(DrawContext dc)
           
 void doRender(DrawContext dc)
           
 Color getGraticuleLineColor(String key)
          Returns the graticule line Color.
 String getGraticuleLineStyle(String key)
          Returns the graticule line rendering style.
 double getGraticuleLineWidth(String key)
          Returns the graticule line width.
 Color getLabelColor(String key)
          Returns the graticule label Color.
 Font getLabelFont(String key)
          Returns the Font used for graticule labels.
protected  GraticuleRenderingParams getRenderingParams(String key)
           
 String getRestorableState()
          Returns an XML document string describing the object’s state.
protected  Vec4 getSurfacePoint(DrawContext dc, Angle latitude, Angle longitude)
           
 boolean isDrawGraticule(String key)
          Returns whether or not graticule lines will be rendered.
 boolean isDrawLabels(String key)
          Returns whether or not graticule labels will be rendered.
protected  void removeAllRenderables()
           
protected  void renderGraticule(DrawContext dc)
           
 void restoreState(String stateInXml)
          Restores the object’s state to what is described in the specified XML document string.
protected  void selectRenderables(DrawContext dc)
          Select the visible grid elements
 void setDrawGraticule(boolean drawGraticule, String key)
          Sets whether or not graticule lines will be rendered.
 void setDrawLabels(boolean drawLabels, String key)
          Sets whether or not graticule labels will be rendered.
 void setGraticuleLineColor(Color color, String key)
          Sets the graticule line Color.
 void setGraticuleLineStyle(String lineStyle, String key)
          Sets the graticule line rendering style.
 void setGraticuleLineWidth(double lineWidth, String key)
          Sets the graticule line width.
 void setLabelColor(Color color, String key)
          Sets the graticule label Color.
 void setLabelFont(Font font, String key)
          Sets the Font used for graticule labels.
protected  void setRenderingParams(String key, GraticuleRenderingParams renderingParams)
           
 
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

graticuleSupport

protected GraticuleSupport graticuleSupport

gridElements

protected ArrayList<AbstractGraticuleLayer.GridElement> gridElements
Constructor Detail

AbstractGraticuleLayer

public AbstractGraticuleLayer()
Method Detail

addRenderable

protected void addRenderable(Object renderable,
                             String paramsKey)

computeAltitudeAboveGround

protected double computeAltitudeAboveGround(DrawContext dc)

doRender

public void doRender(DrawContext dc)
Specified by:
doRender in class AbstractLayer

getGraticuleLineColor

public Color getGraticuleLineColor(String key)
Returns the graticule line Color.

Parameters:
key - the rendering parameters key.
Returns:
Color used to render graticule lines.
Throws:
IllegalArgumentException - key is null.

getGraticuleLineStyle

public String getGraticuleLineStyle(String key)
Returns the graticule line rendering style.

Parameters:
key - the rendering parameters key.
Returns:
rendering style of the graticule lines.
Throws:
IllegalArgumentException - key is null.

getGraticuleLineWidth

public double getGraticuleLineWidth(String key)
Returns the graticule line width.

Parameters:
key - the rendering parameters key.
Returns:
width of the graticule lines.
Throws:
IllegalArgumentException - key is null.

getLabelColor

public Color getLabelColor(String key)
Returns the graticule label Color.

Parameters:
key - the rendering parameters key.
Returns:
Color used to render graticule labels.
Throws:
IllegalArgumentException - key is null.

getLabelFont

public Font getLabelFont(String key)
Returns the Font used for graticule labels.

Parameters:
key - the rendering parameters key.
Returns:
Font used to render graticule labels.
Throws:
IllegalArgumentException - key is null.

getRenderingParams

protected GraticuleRenderingParams getRenderingParams(String key)

getRestorableState

public String getRestorableState()
Description copied from interface: Restorable
Returns an XML document string describing the object’s state. This state can be restored later by calling restoreState and passing the XML document.

Specified by:
getRestorableState in interface Restorable
Overrides:
getRestorableState in class AbstractLayer
Returns:
an XML document string describing the object's state.

getSurfacePoint

protected Vec4 getSurfacePoint(DrawContext dc,
                               Angle latitude,
                               Angle longitude)

isDrawGraticule

public boolean isDrawGraticule(String key)
Returns whether or not graticule lines will be rendered.

Parameters:
key - the rendering parameters key.
Returns:
true if graticule lines will be rendered; false otherwise.
Throws:
IllegalArgumentException - key is null.

isDrawLabels

public boolean isDrawLabels(String key)
Returns whether or not graticule labels will be rendered.

Parameters:
key - the rendering parameters key.
Returns:
true if graticule labels will be rendered; false otherwise.
Throws:
IllegalArgumentException - key is null.

removeAllRenderables

protected void removeAllRenderables()

renderGraticule

protected void renderGraticule(DrawContext dc)

restoreState

public void restoreState(String stateInXml)
Description copied from interface: Restorable
Restores the object’s state to what is described in the specified XML document string.

Specified by:
restoreState in interface Restorable
Overrides:
restoreState in class AbstractLayer
Parameters:
stateInXml - an XML document string describing an object's state.

selectRenderables

protected void selectRenderables(DrawContext dc)
Select the visible grid elements

Parameters:
dc - the current DrawContext.

setDrawGraticule

public void setDrawGraticule(boolean drawGraticule,
                             String key)
Sets whether or not graticule lines will be rendered.

Parameters:
drawGraticule - true to render graticule lines; false to disable rendering.
key - the rendering parameters key.
Throws:
IllegalArgumentException - key is null.

setDrawLabels

public void setDrawLabels(boolean drawLabels,
                          String key)
Sets whether or not graticule labels will be rendered.

Parameters:
drawLabels - true to render graticule labels; false to disable rendering.
key - the rendering parameters key.
Throws:
IllegalArgumentException - key is null.

setGraticuleLineColor

public void setGraticuleLineColor(Color color,
                                  String key)
Sets the graticule line Color.

Parameters:
color - Color that will be used to render graticule lines.
key - the rendering parameters key.
Throws:
IllegalArgumentException - if color or key is null.

setGraticuleLineStyle

public void setGraticuleLineStyle(String lineStyle,
                                  String key)
Sets the graticule line rendering style.

Parameters:
lineStyle - rendering style of the graticule lines. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
key - the rendering parameters key.
Throws:
IllegalArgumentException - if lineStyle or key is null.

setGraticuleLineWidth

public void setGraticuleLineWidth(double lineWidth,
                                  String key)
Sets the graticule line width.

Parameters:
lineWidth - width of the graticule lines.
key - the rendering parameters key.
Throws:
IllegalArgumentException - key is null.

setLabelColor

public void setLabelColor(Color color,
                          String key)
Sets the graticule label Color.

Parameters:
color - Color that will be used to render graticule labels.
key - the rendering parameters key.
Throws:
IllegalArgumentException - if color or key is null.

setLabelFont

public void setLabelFont(Font font,
                         String key)
Sets the Font used for graticule labels.

Parameters:
font - Font that will be used to render graticule labels.
key - the rendering parameters key.
Throws:
IllegalArgumentException - if font or key is null.

setRenderingParams

protected void setRenderingParams(String key,
                                  GraticuleRenderingParams renderingParams)
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