NASA World Wind

gov.nasa.worldwind.render
Class GlobeAnnotation

java.lang.Object
  extended by gov.nasa.worldwind.render.AbstractAnnotation
      extended by gov.nasa.worldwind.render.GlobeAnnotation
All Implemented Interfaces:
Disposable, Locatable, Movable, Pickable, Annotation, Renderable, Restorable
Direct Known Subclasses:
SARAnnotation

public class GlobeAnnotation
extends AbstractAnnotation
implements Locatable, Movable

Represent a text label attached to a Position on the globe 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
GlobeAnnotation(String text, Position position)
          Creates a GlobeAnnotation with the given text, at the given globe Position.
GlobeAnnotation(String text, Position position, AnnotationAttributes defaults)
          Creates a GlobeAnnotation with the given text, at the given globe Position.
GlobeAnnotation(String text, Position position, Font font)
          Creates a GlobeAnnotation with the given text, at the given globe Position.
GlobeAnnotation(String text, Position position, Font font, Color textColor)
          Creates a GlobeAnnotation with the given text, at the given globe Position.
 
Method Summary
protected  void doDraw(DrawContext dc)
           
 Position getPosition()
           
 Position getReferencePosition()
           
 String getRestorableState()
          Returns an XML state document String describing the public attributes of this GlobeAnnotation.
 void move(Position position)
          Shift the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.
 void moveTo(Position position)
          Move the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.
 void restoreState(String stateInXml)
          Restores publicly settable attribute values found in the specified XML state document String.
 void setPosition(Position position)
           
 
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

GlobeAnnotation

public GlobeAnnotation(String text,
                       Position position)
Creates a GlobeAnnotation with the given text, at the given globe Position.

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

GlobeAnnotation

public GlobeAnnotation(String text,
                       Position position,
                       AnnotationAttributes defaults)
Creates a GlobeAnnotation with the given text, at the given globe Position. Specify the default AnnotationAttributes set.

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

GlobeAnnotation

public GlobeAnnotation(String text,
                       Position position,
                       Font font)
Creates a GlobeAnnotation with the given text, at the given globe Position. Specifiy the Font to be used.

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

GlobeAnnotation

public GlobeAnnotation(String text,
                       Position position,
                       Font font,
                       Color textColor)
Creates a GlobeAnnotation with the given text, at the given globe Position. Specifiy the Font and text Color to be used.

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

doDraw

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

getPosition

public Position getPosition()
Specified by:
getPosition in interface Locatable

getReferencePosition

public Position getReferencePosition()
Specified by:
getReferencePosition in interface Movable

getRestorableState

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

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

move

public void move(Position position)
Description copied from interface: Movable
Shift the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.

Specified by:
move in interface Movable
Parameters:
position - the latitude and longitude to add to the shapes reference position.

moveTo

public void moveTo(Position position)
Description copied from interface: Movable
Move the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.

Specified by:
moveTo in interface Movable
Parameters:
position - the new position of the shapes reference position.

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 GlobeAnnotation.
Throws:
IllegalArgumentException - If stateInXml is null, or if stateInXml is not a well formed XML document String.

setPosition

public void setPosition(Position position)

NASA World Wind