|
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.IconLayer
public class IconLayer
The IconLayer
class manages a collection of WWIcon
objects for
rendering and picking. IconLayer
delegates to its internal IconRenderer
for rendering and picking operations.
WWIcon
,
IconRenderer
Field Summary |
---|
Fields inherited from class gov.nasa.worldwind.layers.AbstractLayer |
---|
screenCredit |
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl |
---|
changeSupport |
Constructor Summary | |
---|---|
IconLayer()
Creates a new IconLayer with an empty collection of Icons. |
Method Summary | |
---|---|
void |
addIcon(WWIcon icon)
Adds the specified icon to this layer's internal collection. |
void |
addIcons(Iterable<WWIcon> icons)
Adds the contents of the specified icons to this layer's internal collection. |
protected void |
doPick(DrawContext dc,
Point pickPoint)
|
protected void |
doRender(DrawContext dc)
|
Iterable<WWIcon> |
getIcons()
Returns the Iterable of Icons currently in use by this layer. |
double |
getOpacity()
Returns the layer's opacity value, which is ignored by this layer the icon's image is assumed to indicate its opacity. |
Pedestal |
getPedestal()
Returns the Pedestal used by this layers internal IconRenderer . |
boolean |
isAlwaysUseAbsoluteElevation()
Indicates whether an icon's elevation is treated as an offset from the terrain or an absolute elevation above sea level. |
boolean |
isHorizonClippingEnabled()
Indicates whether horizon clipping is performed. |
boolean |
isViewClippingEnabled()
Indicates whether view volume clipping is performed. |
void |
removeAllIcons()
Clears the contents of this layer's internal Icon collection. |
void |
removeIcon(WWIcon icon)
Removes the specified icon from this layer's internal collection, if it exists. |
void |
setAlwaysUseAbsoluteElevation(boolean alwaysUseAbsoluteElevation)
Normally, an icon's elevation is treated as an offset from the terrain when it is less than the globe's maximum elevation. |
void |
setHorizonClippingEnabled(boolean horizonClippingEnabled)
Indicates whether to render icons beyond the horizon. |
void |
setIcons(Iterable<WWIcon> iconIterable)
Overrides the collection of currently active Icons with the specified iconIterable . |
void |
setOpacity(double opacity)
Opacity is not applied to layers of this type. |
void |
setPedestal(Pedestal pedestal)
Sets the Pedestal used by this layers internal IconRenderer . |
void |
setViewClippingEnabled(boolean viewClippingEnabled)
Indicates whether to render icons outside the view volume. |
String |
toString()
|
Methods inherited from class gov.nasa.worldwind.layers.AbstractLayer |
---|
dispose, doPreRender, getExpiryTime, getMaxActiveAltitude, getMinActiveAltitude, getName, getRestorableState, getScale, getScreenCredit, isAtMaxResolution, isEnabled, isLayerActive, isLayerInView, isMultiResolution, isNetworkRetrievalEnabled, isPickEnabled, pick, preRender, render, restoreState, setEnabled, setExpiryTime, setMaxActiveAltitude, setMinActiveAltitude, setName, setNetworkRetrievalEnabled, 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 |
---|
public IconLayer()
IconLayer
with an empty collection of Icons.
Method Detail |
---|
public void addIcon(WWIcon icon)
icon
to this layer's internal collection. If this layer's internal collection has
been overriden with a call to setIcons(java.lang.Iterable)
, this will throw an exception.
icon
- Icon to add.
IllegalArgumentException
- If icon
is null.
IllegalStateException
- If a custom Iterable has been specified by a call to setIcons
.public void addIcons(Iterable<WWIcon> icons)
icons
to this layer's internal collection. If this layer's
internal collection has been overriden with a call to setIcons(java.lang.Iterable)
, this will throw an exception.
icons
- Icons to add.
IllegalArgumentException
- If icons
is null.
IllegalStateException
- If a custom Iterable has been specified by a call to setIcons
.protected void doPick(DrawContext dc, Point pickPoint)
doPick
in class AbstractLayer
protected void doRender(DrawContext dc)
doRender
in class AbstractLayer
public Iterable<WWIcon> getIcons()
setIcons(java.lang.Iterable)
, this will returns a reference to that Iterable. If the caller passed setIcons
a
null parameter, or if setIcons
has not been called, this returns a view of this layer's internal
collection of Icons.
public double getOpacity()
getOpacity
in interface Layer
getOpacity
in class AbstractLayer
public Pedestal getPedestal()
Pedestal
used by this layers internal IconRenderer
.
Pedestal
used by this layers internal IconRenderer
.public boolean isAlwaysUseAbsoluteElevation()
true
if icon elevations are treated as absolute, false
if they're treated as
offsets from the terrain.public boolean isHorizonClippingEnabled()
true
if horizon clipping is performed, otherwise false
.setHorizonClippingEnabled(boolean)
public boolean isViewClippingEnabled()
true
if view volume clipping is performed, otherwise false
.setViewClippingEnabled(boolean)
public void removeAllIcons()
setIcons(java.lang.Iterable)
, this will throw an exception.
IllegalStateException
- If a custom Iterable has been specified by a call to setIcons
.public void removeIcon(WWIcon icon)
icon
from this layer's internal collection, if it exists. If this layer's
internal collection has been overriden with a call to setIcons(java.lang.Iterable)
, this will throw an exception.
icon
- Icon to remove.
IllegalArgumentException
- If icon
is null.
IllegalStateException
- If a custom Iterable has been specified by a call to setIcons
.public void setAlwaysUseAbsoluteElevation(boolean alwaysUseAbsoluteElevation)
true
causes the elevation to be treated as an
absolute elevation above sea level.
alwaysUseAbsoluteElevation
- true
to treat icon elevations as absolute, false
to
treat them as offsets from the terrain.public void setHorizonClippingEnabled(boolean horizonClippingEnabled)
false
, horizon clipping is not performed.
horizonClippingEnabled
- true
if horizon clipping should be performed, otherwise
false
.setViewClippingEnabled(boolean)
public void setIcons(Iterable<WWIcon> iconIterable)
iconIterable
. This layer will
maintain a reference to iconIterable
strictly for picking and rendering. This layer will not modify
the Iterable reference. However, this will clear the internal collection of Icons, and will prevent any
modification to its contents via addIcon, addIcons, or removeIcons
.
If the specified iconIterable
is null, this layer will revert to maintaining its internal
collection.
iconIterable
- Iterable to use instead of this layer's internal collection, or null to use this layer's
internal collection.public void setOpacity(double opacity)
setOpacity
in interface Layer
setOpacity
in class AbstractLayer
opacity
- the current opacity value, which is ignored by this layer.public void setPedestal(Pedestal pedestal)
Pedestal
used by this layers internal IconRenderer
.
pedestal
- Pedestal
to be used by this layers internal IconRenderer
.public void setViewClippingEnabled(boolean viewClippingEnabled)
false
, view volume clipping
is not performed.
viewClippingEnabled
- true
if view clipping should be performed, otherwise false
.setHorizonClippingEnabled(boolean)
public String toString()
toString
in class AbstractLayer
|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |