|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.worldwind.avlist.AVListImpl
gov.nasa.worldwind.WWObjectImpl
gov.nasa.worldwind.layers.AbstractLayer
gov.nasa.worldwind.layers.RenderableLayer
gov.nasa.worldwind.layers.ScalebarLayer
public class ScalebarLayer
Renders a scalebar graphic in a screen corner.
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
|
static String |
UNIT_IMPERIAL
|
static String |
UNIT_METRIC
|
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl |
---|
changeSupport |
Constructor Summary | |
---|---|
ScalebarLayer()
Renders a scalebar graphic in a screen corner |
Method Summary | |
---|---|
void |
dispose()
Disposes the contents of this layer's internal Renderable collection, but does not remove any elements from that collection. |
void |
doRender(DrawContext dc)
|
void |
draw(DrawContext dc)
|
int |
getBorderWidth()
|
Color |
getColor()
Get the scalebar color |
Font |
getFont()
Get the scalebar legend Fon |
String |
getPosition()
|
String |
getResizeBehavior()
Returns the layer's resize behavior. |
Dimension |
getSize()
Get the scalebar graphic Dimension (in pixels) |
double |
getToViewportScale()
Returns the scalebar-to-viewport scale factor. |
String |
getUnit()
|
void |
setBorderWidth(int borderWidth)
Sets the scalebar offset from the viewport border. |
void |
setColor(Color color)
Set the scalbar Color |
void |
setFont(Font font)
Set the scalebar legend Fon |
void |
setPosition(String position)
Sets the relative viewport location to display the scalebar. |
void |
setResizeBehavior(String resizeBehavior)
Sets the behavior the layer uses to size the scalebar when the viewport size changes, typically when the World Wind window is resized. |
void |
setSize(Dimension size)
Set the scalebar graphic Dimenion (in pixels) |
void |
setToViewportScale(double toViewportScale)
Sets the scale factor applied to the viewport size to determine the displayed size of the scalebar. |
void |
setUnit(String unit)
Sets the unit the scalebar uses to display distances. |
String |
toString()
|
Methods inherited from class gov.nasa.worldwind.layers.RenderableLayer |
---|
addRenderable, addRenderables, doPick, getDelegateOwner, getRenderables, removeAllRenderables, removeRenderable, setRenderables |
Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer |
---|
getMaxActiveAltitude, getMinActiveAltitude, getName, getOpacity, getRestorableState, getScale, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isPickEnabled, pick, render, restoreState, setEnabled, setMaxActiveAltitude, setMinActiveAltitude, setName, setOpacity, setPickEnabled |
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 |
---|
public static final String NORTHEAST
public static final String NORTHWEST
public static final String RESIZE_KEEP_FIXED_SIZE
public static final String RESIZE_SHRINK_ONLY
public static final String RESIZE_STRETCH
public static final String SOUTHEAST
public static final String SOUTHWEST
public static final String UNIT_IMPERIAL
public static final String UNIT_METRIC
Constructor Detail |
---|
public ScalebarLayer()
Method Detail |
---|
public void dispose()
RenderableLayer
dispose
in interface Disposable
dispose
in class RenderableLayer
public void doRender(DrawContext dc)
doRender
in class RenderableLayer
public void draw(DrawContext dc)
public int getBorderWidth()
public Color getColor()
public Font getFont()
public String getPosition()
public String getResizeBehavior()
public Dimension getSize()
public double getToViewportScale()
public String getUnit()
public void setBorderWidth(int borderWidth)
borderWidth
- the number of pixels to offset the scalebar from the borders indicated by setPosition(String)
.public void setColor(Color color)
color
- the scalebar Colorpublic void setFont(Font font)
font
- the scalebar legend Fontpublic void setPosition(String position)
NORTHEAST
(the default),
NORTHWEST
, SOUTHEAST
, or SOUTHWEST
. These indicate the corner of the viewport.
position
- the desired scalebar positionpublic void setResizeBehavior(String resizeBehavior)
RESIZE_KEEP_FIXED_SIZE
, the scalebar size is kept to the size
specified in its Dimension scaled by the layer's current icon scale. If the value is RESIZE_STRETCH
,
the scalebar is resized to have a constant size relative to the current viewport size. If the viewport shrinks the
scalebar size decreases; if it expands then the scalebar enlarges. If the value is
RESIZE_SHRINK_ONLY
(the default), scalebar sizing behaves as for RESIZE_STRETCH
but it will
not grow larger than the size specified in its Dimension.
resizeBehavior
- the desired resize behaviorpublic void setSize(Dimension size)
size
- the scalebar graphic Dimensionpublic void setToViewportScale(double toViewportScale)
RESIZE_STRETCH
or RESIZE_SHRINK_ONLY
. The scalebar's width is adjusted to occupy the proportion of the viewport's width indicated by
this factor. The scalebar's height is adjusted to maintain the scalebar's Dimension aspect ratio.
toViewportScale
- the scalebar to viewport scale factorpublic void setUnit(String unit)
UNIT_METRIC
(the default),
or UNIT_IMPERIAL
.
unit
- the desired unitpublic String toString()
toString
in class RenderableLayer
|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |