NASA World Wind

gov.nasa.worldwind.render
Class ScreenAnnotation

java.lang.Object
  extended by gov.nasa.worldwind.render.AbstractAnnotation
      extended by gov.nasa.worldwind.render.ScreenAnnotation
All Implemented Interfaces:
Disposable, Pickable, Annotation, Renderable, Restorable

public class ScreenAnnotation
extends AbstractAnnotation

Represent a text label attached to a Point on the viewport and its rendering attributes.

See Also:
AbstractAnnotation, AnnotationAttributes

Field Summary
 
Fields inherited from class gov.nasa.worldwind.render.AbstractAnnotation
alphaFactor, attributes, delegateOwner, drawRectangle, freeRectangle, renderInfo, scaleFactor, text
 
Fields inherited from interface gov.nasa.worldwind.render.Annotation
ANTIALIAS_DONT_CARE, ANTIALIAS_FASTEST, ANTIALIAS_NICEST, IMAGE_REPEAT_NONE, IMAGE_REPEAT_X, IMAGE_REPEAT_XY, IMAGE_REPEAT_Y, SIZE_FIT_TEXT, SIZE_FIXED
 
Constructor Summary
ScreenAnnotation(String text, Point position)
          Creates a ScreenAnnotation with the given text, at the given viewport position.
ScreenAnnotation(String text, Point position, AnnotationAttributes defaults)
          Creates a ScreenAnnotation with the given text, at the given viewport position.
ScreenAnnotation(String text, Point position, Font font)
          Creates a ScreenAnnotation with the given text, at the given viewport position.
ScreenAnnotation(String text, Point position, Font font, Color textColor)
          Creates a ScreenAnnotation with the given text, at the given viewport position.
 
Method Summary
protected  void doDraw(DrawContext dc)
           
 String getRestorableState()
          Returns an XML state document String describing the public attributes of this ScreenAnnotation.
 Point getScreenPoint()
          Get the Point where the annotation is drawn in the viewport.
 void restoreState(String stateInXml)
          Restores publicly settable attribute values found in the specified XML state document String.
 void setScreenPoint(Point position)
          Set the Point where the annotation will be drawn in the viewport.
 
Methods inherited from class gov.nasa.worldwind.render.AbstractAnnotation
cacheRenderInfo, computeLookAtDistance, dispose, draw, drawAnnotation, getAttributes, getDelegateOwner, getPickSupport, getRectangleInViewportCoordinates, getRenderInfo, getText, getTextRenderer, initializeTexture, isAlwaysOnTop, pick, render, setAlwaysOnTop, setAttributes, setDelegateOwner, setDepthFunc, setDrawColor, setDrawColor, setPickSupport, setText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScreenAnnotation

public ScreenAnnotation(String text,
                        Point position)
Creates a ScreenAnnotation with the given text, at the given viewport position.

Parameters:
text - the annotation text.
position - the annotation viewport position.

ScreenAnnotation

public ScreenAnnotation(String text,
                        Point position,
                        AnnotationAttributes defaults)
Creates a ScreenAnnotation with the given text, at the given viewport position. Specify the default AnnotationAttributes set.

Parameters:
text - the annotation text.
position - the annotation viewport position.
defaults - the default AnnotationAttributes set.

ScreenAnnotation

public ScreenAnnotation(String text,
                        Point position,
                        Font font)
Creates a ScreenAnnotation with the given text, at the given viewport position. Specifiy the Font to be used.

Parameters:
text - the annotation text.
position - the annotation viewport position.
font - the Font to use.

ScreenAnnotation

public ScreenAnnotation(String text,
                        Point position,
                        Font font,
                        Color textColor)
Creates a ScreenAnnotation with the given text, at the given viewport position. Specifiy the Font and text Color to be used.

Parameters:
text - the annotation text.
position - the annotation viewport position.
font - the Font to use.
textColor - the text Color.
Method Detail

doDraw

protected void doDraw(DrawContext dc)
Specified by:
doDraw in class AbstractAnnotation

getRestorableState

public String getRestorableState()
Returns an XML state document String describing the public attributes of this ScreenAnnotation.

Specified by:
getRestorableState in interface Restorable
Overrides:
getRestorableState in class AbstractAnnotation
Returns:
XML state document string describing this ScreenAnnotation.

getScreenPoint

public Point getScreenPoint()
Get the Point where the annotation is drawn in the viewport.

Returns:
the Point where the annotation is drawn in the viewport.

restoreState

public void restoreState(String stateInXml)
Restores publicly settable attribute values found in the specified XML state document String. The document specified by stateInXml must be a well formed XML document String, or this will throw an IllegalArgumentException. Unknown structures in stateInXml are benign, because they will simply be ignored.

Specified by:
restoreState in interface Restorable
Overrides:
restoreState in class AbstractAnnotation
Parameters:
stateInXml - an XML document String describing a ScreenAnnotation.
Throws:
IllegalArgumentException - If stateInXml is null, or if stateInXml is not a well formed XML document String.

setScreenPoint

public void setScreenPoint(Point position)
Set the Point where the annotation will be drawn in the viewport.

Parameters:
position - the Point where the annotation will be drawn in the viewport.

NASA World Wind