NASA World Wind

gov.nasa.worldwind.render
Class IconRenderer

java.lang.Object
  extended by gov.nasa.worldwind.render.IconRenderer

public class IconRenderer
extends Object


Constructor Summary
IconRenderer()
           
 
Method Summary
 Pedestal getPedestal()
           
 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 pick(DrawContext dc, Iterable<WWIcon> icons, Point pickPoint, Layer layer)
           
 void pick(DrawContext dc, WWIcon icon, Vec4 iconPoint, Point pickPoint, Layer layer)
           
 void render(DrawContext dc, Iterable<WWIcon> icons)
           
 void render(DrawContext dc, WWIcon icon, Vec4 iconPoint)
           
 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 setPedestal(Pedestal pedestal)
           
 void setViewClippingEnabled(boolean viewClippingEnabled)
          Indicates whether to render icons outside the view volume.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IconRenderer

public IconRenderer()
Method Detail

getPedestal

public Pedestal getPedestal()

isAlwaysUseAbsoluteElevation

public boolean isAlwaysUseAbsoluteElevation()
Indicates whether an icon's elevation is treated as an offset from the terrain or an absolute elevation above sea level.

Returns:
true if icon elevations are treated as absolute, false if they're treated as offsets from the terrain.

isHorizonClippingEnabled

public boolean isHorizonClippingEnabled()
Indicates whether horizon clipping is performed.

Returns:
true if horizon clipping is performed, otherwise false.
See Also:
setHorizonClippingEnabled(boolean)

isViewClippingEnabled

public boolean isViewClippingEnabled()
Indicates whether view volume clipping is performed.

Returns:
true if view volume clipping is performed, otherwise false.
See Also:
setViewClippingEnabled(boolean)

pick

public void pick(DrawContext dc,
                 Iterable<WWIcon> icons,
                 Point pickPoint,
                 Layer layer)

pick

public void pick(DrawContext dc,
                 WWIcon icon,
                 Vec4 iconPoint,
                 Point pickPoint,
                 Layer layer)

render

public void render(DrawContext dc,
                   Iterable<WWIcon> icons)

render

public void render(DrawContext dc,
                   WWIcon icon,
                   Vec4 iconPoint)

setAlwaysUseAbsoluteElevation

public 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. Setting #setAlwaysUseAbsoluteElevation to true causes the elevation to be treated as an absolute elevation above sea level.

Parameters:
alwaysUseAbsoluteElevation - true to treat icon elevations as absolute, false to treat them as offsets from the terrain.

setHorizonClippingEnabled

public void setHorizonClippingEnabled(boolean horizonClippingEnabled)
Indicates whether to render icons beyond the horizon. If view culling is enabled, the icon is also tested for view volume inclusion. The default is false, horizon clipping is not performed.

Parameters:
horizonClippingEnabled - true if horizon clipping should be performed, otherwise false.
See Also:
setViewClippingEnabled(boolean)

setPedestal

public void setPedestal(Pedestal pedestal)

setViewClippingEnabled

public void setViewClippingEnabled(boolean viewClippingEnabled)
Indicates whether to render icons outside the view volume. This is primarily to control icon visibility beyond the far view clipping plane. Some important use cases demand that clipping not be performed. If horizon clipping is enabled, the icon is also tested for horizon clipping. The default is false, view volume clipping is not performed.

Parameters:
viewClippingEnabled - true if view clipping should be performed, otherwise false.
See Also:
setHorizonClippingEnabled(boolean)

toString

public String toString()
Overrides:
toString in class Object

NASA World Wind