gov.nasa.worldwind.layers.Earth
Class WorldMapLayer

java.lang.Object
  gov.nasa.worldwind.avlist.AVListImpl
      gov.nasa.worldwind.WWObjectImpl
          gov.nasa.worldwind.layers.AbstractLayer
              gov.nasa.worldwind.layers.RenderableLayer
                  gov.nasa.worldwind.layers.Earth.WorldMapLayer

All Implemented Interfaces:

AVList, Disposable, Layer, WWObject, PropertyChangeListener, EventListener

public class WorldMapLayer
extends RenderableLayer

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

Field Summary

static String	NORTHEAST
static String	NORTHWEST
static String	RESIZE_KEEP_FIXED_SIZE
static String	RESIZE_SHRINK_ONLY
static String	RESIZE_STRETCH
static String	SOUTHEAST
static String	SOUTHWEST

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()
String	getIconFilePath() Returns the layer's current icon file path.
double	getIconScale() Returns the icon scale factor.
Vec4	getLocationCenter()
String	getPosition() Returns the current relative world map icon position.
String	getResizeBehavior() Returns the world map icon's resize behavior.
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)
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	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.RenderableLayer

addRenderable, addRenderables, getDelegateOwner, getRenderables, removeRenderable, setRenderable, setRenderables

Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer

getMaxActiveAltitude, getMinActiveAltitude, getName, getOpacity, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isPickEnabled, pick, render, setEnabled, setMaxActiveAltitude, setMinActiveAltitude, setName, setOpacity, setPickEnabled

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, propertyChange, 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

NORTHEAST

public static final String NORTHEAST

See Also:

Constant Field Values

NORTHWEST

public static final String NORTHWEST

See Also:

Constant Field Values

RESIZE_KEEP_FIXED_SIZE

public static final String RESIZE_KEEP_FIXED_SIZE

See Also:

Constant Field Values

RESIZE_SHRINK_ONLY

public static final String RESIZE_SHRINK_ONLY

See Also:

Constant Field Values

RESIZE_STRETCH

public static final String RESIZE_STRETCH

See Also:

Constant Field Values

SOUTHEAST

public static final String SOUTHEAST

See Also:

Constant Field Values

SOUTHWEST

public static final String SOUTHWEST

See Also:

Constant Field Values

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 RenderableLayer

doPick

public void doPick(DrawContext dc,
                   Point pickPoint)

Overrides:

doPick in class RenderableLayer

doRender

public void doRender(DrawContext dc)

Overrides:

doRender in class RenderableLayer

getBackgrounColor

public Color getBackgrounColor()

getBorderWidth

public int getBorderWidth()

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()

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

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 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)

setPosition

public void setPosition(String position)

Sets the relative viewport location to display the world map icon. Can be one of NORTHEAST (the default), NORTHWEST, 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 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 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 RESIZE_SHRINK_ONLY (the default), icon sizing behaves as for 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

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 RESIZE_STRETCH or 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 RenderableLayer