gov.nasa.worldwind.render

Class ScreenAnnotation

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.render.AbstractAnnotation

gov.nasa.worldwind.render.ScreenAnnotation

All Implemented Interfaces:

AVList, Disposable, Annotation, Renderable, Restorable

Direct Known Subclasses:

EditorAnnotation, ImageAnnotation, ProgressAnnotation, ScreenRelativeAnnotation, ToolTipAnnotation, ToolTipAnnotation

public class ScreenAnnotation
extends AbstractAnnotation

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

See Also:

AbstractAnnotation, AnnotationAttributes

Nested Class Summary

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.AbstractAnnotation

AbstractAnnotation.TextCacheKey

Field Summary

Fields

Modifier and Type	Field and Description
protected Position	position
protected Point	screenPoint

Fields inherited from class gov.nasa.worldwind.render.AbstractAnnotation

alwaysOnTop, attributes, childList, delegateOwner, layoutManager, maxActiveAltitude, minActiveAltitude, pickEnabled, pickSupport, text, textBoundsMap, vertexBuffer, wrappedTextMap

Fields inherited from interface gov.nasa.worldwind.render.Annotation

ANTIALIAS_DONT_CARE, ANTIALIAS_FASTEST, ANTIALIAS_NICEST

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
protected Point	computeAnnotationPosition(DrawContext dc, Position pos)
protected Rectangle	computeBounds(DrawContext dc)
protected double[]	computeOffset(DrawContext dc)
protected Point	computeSize(DrawContext dc)
protected void	doRenderNow(DrawContext dc)
Position	getPosition() Returns the position set via setPosition(gov.nasa.worldwind.geom.Position).
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.
protected Point	getScreenPoint(DrawContext dc) 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	setPosition(Position position) Specifies an optional geographic position that is mapped to a screen position during rendering.
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

addChild, adjustSizeToChildren, adjustSizeToText, applyBackgroundTextureState, applyColor, applyScreenTransform, beginDraw, beginDrawChildren, bindPickableObject, computeBoundingRectangle, computeFreeBounds, computeInsetBounds, computeOpacity, computeScale, computeTextBounds, dispose, doDraw, doDrawBackgroundTexture, doDrawChildren, draw, drawBackground, drawBackgroundImage, drawBorder, drawCallout, drawChildren, drawContent, drawHTML, drawPlainText, drawText, drawText, drawTopLevelAnnotation, endDraw, endDrawChildren, getAttributes, getBounds, getChildren, getDelegateOwner, getLayout, getMaxActiveAltitude, getMinActiveAltitude, getMultiLineTextRenderer, getPickSupport, getPreferredSize, getText, getTextBounds, getTextRenderer, getWrappedText, glPointFromAWTPoint, isAlwaysOnTop, isPickEnabled, modulateColorOpacity, pick, removeAllChildren, removeChild, render, renderNow, setAlwaysOnTop, setAttributes, setDelegateOwner, setLayout, setMaxActiveAltitude, setMinActiveAltitude, setPickEnabled, setPickSupport, setText, transformBackgroundImageCoordsToAnnotationCoords, transformByModelview, transformImageCoordsToBackgroundImageCoords, wrapText

Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getRestorableStateForAVPair, 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, toString, wait, wait, wait

Field Detail

position

protected Position position

screenPoint

protected Point screenPoint

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

computeAnnotationPosition

protected Point computeAnnotationPosition(DrawContext dc,
                                          Position pos)

computeBounds

protected Rectangle computeBounds(DrawContext dc)

Specified by:

computeBounds in class AbstractAnnotation

computeOffset

protected double[] computeOffset(DrawContext dc)

computeSize

protected Point computeSize(DrawContext dc)

doRenderNow

protected void doRenderNow(DrawContext dc)

Specified by:

doRenderNow in class AbstractAnnotation

getPosition

public Position getPosition()

Returns the position set via setPosition(gov.nasa.worldwind.geom.Position).

Returns:

The position previously set.

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.

getScreenPoint

protected Point getScreenPoint(DrawContext dc)

Get the Point where the annotation is drawn in the viewport.

Parameters:

dc - the current draw context.

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.

setPosition

public void setPosition(Position position)

Specifies an optional geographic position that is mapped to a screen position during rendering. This value overrides this object's screen point and computes it anew each time this annotation is drawn.

Parameters:

position - This annotation's geographic position. May be null, in which case this annotation's screen point is used directly.

See Also:

setScreenPoint(java.awt.Point)

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.