NASA World Wind

gov.nasa.worldwind.layers
Class WorldMapLayer

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.WorldMapLayer
All Implemented Interfaces:
AVList, Disposable, Layer, Restorable, WWObject, PropertyChangeListener, EventListener

public class WorldMapLayer
extends AbstractLayer

Displays a world map overlay with a current position crosshair in a screen corner. Supports picking at a position on the map.


Field Summary
 
Fields inherited from class gov.nasa.worldwind.layers.AbstractLayer
screenCredit
 
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl
changeSupport
 
Constructor Summary
WorldMapLayer()
          Displays a world map overlay with a current position crosshair in a screen corner
WorldMapLayer(String iconFilePath)
          Displays a world map overlay with a current position crosshair in a screen corner
 
Method Summary
 void dispose()
           
 void doPick(DrawContext dc, Point pickPoint)
           
 void doRender(DrawContext dc)
           
 Color getBackgrounColor()
           
 int getBorderWidth()
           
 ArrayList<? extends LatLon> getFootPrintPositions()
          Get the current view footprint position list.
 String getIconFilePath()
          Returns the layer's current icon file path.
 double getIconScale()
          Returns the icon scale factor.
 Vec4 getLocationCenter()
          Returns the current worldmap image location.
 Vec4 getLocationOffset()
          Returns the current location offset.
 String getPosition()
          Returns the current relative world map icon position.
 String getResizeBehavior()
          Returns the world map icon's resize behavior.
 boolean getShowFootprint()
           
 double getToViewportScale()
          Returns the layer's world map-to-viewport scale factor.
 void setBackgroundColor(Color color)
           
 void setBorderWidth(int borderWidth)
          Sets the world map icon offset from the viewport border.
 void setIconFilePath(String iconFilePath)
          Sets the world map icon's image location.
 void setIconScale(double iconScale)
          Sets the scale factor defining the displayed size of the world map icon relative to the icon's width and height in its image file.
 void setLocationCenter(Vec4 locationCenter)
          Specifies the screen location of the worldmap image, relative to the image's center.
 void setLocationOffset(Vec4 locationOffset)
          Specifies a placement offset from the worldmap's position on the screen.
 void setPosition(String position)
          Sets the relative viewport location to display the world map icon.
 void setResizeBehavior(String resizeBehavior)
          Sets the behavior the layer uses to size the world map icon when the viewport size changes, typically when the World Wind window is resized.
 void setShowFootprint(boolean state)
           
 void setToViewportScale(double toViewportScale)
          Sets the scale factor applied to the viewport size to determine the displayed size of the world map icon.
 String toString()
           
 
Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer
doPreRender, getExpiryTime, getMaxActiveAltitude, getMinActiveAltitude, getName, getOpacity, getRestorableState, getScale, getScreenCredit, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isNetworkRetrievalEnabled, isPickEnabled, pick, preRender, render, restoreState, setEnabled, setExpiryTime, setMaxActiveAltitude, setMinActiveAltitude, setName, setNetworkRetrievalEnabled, setOpacity, setPickEnabled, setScreenCredit
 
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
 

Constructor Detail

WorldMapLayer

public WorldMapLayer()
Displays a world map overlay with a current position crosshair in a screen corner


WorldMapLayer

public WorldMapLayer(String iconFilePath)
Displays a world map overlay with a current position crosshair in a screen corner

Parameters:
iconFilePath - the world map image path and filename
Method Detail

dispose

public void dispose()
Specified by:
dispose in interface Disposable
Overrides:
dispose in class AbstractLayer

doPick

public void doPick(DrawContext dc,
                   Point pickPoint)
Overrides:
doPick in class AbstractLayer

doRender

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

getBackgrounColor

public Color getBackgrounColor()

getBorderWidth

public int getBorderWidth()

getFootPrintPositions

public ArrayList<? extends LatLon> getFootPrintPositions()
Get the current view footprint position list. May be null if no footprint is displayed or none has been computed.

Returns:
the current view footprint position list - may be null.

getIconFilePath

public String getIconFilePath()
Returns the layer's current icon file path.

Returns:
the icon file path

getIconScale

public double getIconScale()
Returns the icon scale factor. See setIconScale(double) for a description of the scale factor.

Returns:
the current icon scale

getLocationCenter

public Vec4 getLocationCenter()
Returns the current worldmap image location.

Returns:
the current location center. May be null.

getLocationOffset

public Vec4 getLocationOffset()
Returns the current location offset. See #setLocationOffset for a description of the offset and its values.

Returns:
the location offset. Will be null if no offset has been specified.

getPosition

public String getPosition()
Returns the current relative world map icon position.

Returns:
the current world map position

getResizeBehavior

public String getResizeBehavior()
Returns the world map icon's resize behavior.

Returns:
the icon's resize behavior

getShowFootprint

public boolean getShowFootprint()

getToViewportScale

public double getToViewportScale()
Returns the layer's world map-to-viewport scale factor.

Returns:
the world map-to-viewport scale factor

setBackgroundColor

public void setBackgroundColor(Color color)

setBorderWidth

public void setBorderWidth(int borderWidth)
Sets the world map icon offset from the viewport border.

Parameters:
borderWidth - the number of pixels to offset the world map icon from the borders indicated by setPosition(String).

setIconFilePath

public void setIconFilePath(String iconFilePath)
Sets the world map icon's image location. The layer first searches for this location in the current Java classpath. If not found then the specified path is assumed to refer to the local file system. found there then the

Parameters:
iconFilePath - the path to the icon's image file

setIconScale

public void setIconScale(double iconScale)
Sets the scale factor defining the displayed size of the world map icon relative to the icon's width and height in its image file. Values greater than 1 magify the image, values less than one minify it. If the layer's resize behavior is other than AVKey.RESIZE_KEEP_FIXED_SIZE, the icon's displayed sized is further affected by the value specified by setToViewportScale(double) and the current viewport size.

Parameters:
iconScale - the icon scale factor

setLocationCenter

public void setLocationCenter(Vec4 locationCenter)
Specifies the screen location of the worldmap image, relative to the image's center. May be null. If this value is non-null, it overrides the position specified by #setPosition. The location is specified in pixels. The origin is the window's lower left corner. Positive X values are to the right of the origin, positive Y values are upwards from the origin. The final image location will be affected by the currently specified location offset if a non-null location offset has been specified (see #setLocationOffset).

Parameters:
locationCenter - the location center. May be null.
See Also:
#setPosition, #setLocationOffset

setLocationOffset

public void setLocationOffset(Vec4 locationOffset)
Specifies a placement offset from the worldmap's position on the screen.

Parameters:
locationOffset - the number of pixels to shift the worldmap image from its specified screen position. A positive X value shifts the image to the right. A positive Y value shifts the image up. If null, no offset is applied. The default offset is null.
See Also:
#setLocationCenter, #setPosition

setPosition

public void setPosition(String position)
Sets the relative viewport location to display the world map icon. Can be one of AVKey.NORTHEAST, AVKey.NORTHWEST (the default), AVKey.SOUTHEAST, or SOUTHWEST. These indicate the corner of the viewport to place the icon.

Parameters:
position - the desired world map position

setResizeBehavior

public void setResizeBehavior(String resizeBehavior)
Sets the behavior the layer uses to size the world map icon when the viewport size changes, typically when the World Wind window is resized. If the value is AVKey.RESIZE_KEEP_FIXED_SIZE, the icon size is kept to the size specified in its image file scaled by the layer's current icon scale. If the value is AVKey.RESIZE_STRETCH, the icon is resized to have a constant size relative to the current viewport size. If the viewport shrinks the icon size decreases; if it expands then the icon file enlarges. The relative size is determined by the current world map-to-viewport scale and by the icon's image file size scaled by the current icon scale. If the value is AVKey.RESIZE_SHRINK_ONLY (the default), icon sizing behaves as for AVKey.RESIZE_STRETCH but the icon will not grow larger than the size specified in its image file scaled by the current icon scale.

Parameters:
resizeBehavior - the desired resize behavior

setShowFootprint

public void setShowFootprint(boolean state)

setToViewportScale

public void setToViewportScale(double toViewportScale)
Sets the scale factor applied to the viewport size to determine the displayed size of the world map icon. This scale factor is used only when the layer's resize behavior is AVKey.RESIZE_STRETCH or AVKey.RESIZE_SHRINK_ONLY. The icon's width is adjusted to occupy the proportion of the viewport's width indicated by this factor. The icon's height is adjusted to maintain the world map image's native aspect ratio.

Parameters:
toViewportScale - the world map to viewport scale factor

toString

public String toString()
Overrides:
toString in class AbstractLayer

NASA World Wind