gov.nasa.worldwind.render

Interface GeographicText

All Known Implementing Classes:

OpenStreetMapShapefileLoader.Label, SurfaceText, UserFacingText

public interface GeographicText

A piece of text that is drawn at a geographic location.

Method Summary

Modifier and Type	Method and Description
Color	getBackgroundColor() Indicates the background color used to draw the text.
Color	getColor() Indicates the color used to draw the text.
Font	getFont() Indicates the font used to draw the text.
Position	getPosition() Indicates the geographic position of the text.
double	getPriority() Indicates the text priority.
CharSequence	getText() Indicates the text contained in this object.
boolean	isVisible() Indicates whether or not the text is visible.
void	setBackgroundColor(Color background) Specifies the background color used to draw the text.
void	setColor(Color color) Specifies the color used to draw the text.
void	setFont(Font font) Specifies the font used to draw the text.
void	setPosition(Position position) Specifies the geographic position of the text.
void	setPriority(double d) Specifies the text priority.
void	setText(CharSequence text) Specifies the text.
void	setVisible(boolean visible) Specifies whether or not the text is visible.

Method Detail

getBackgroundColor

Color getBackgroundColor()

Indicates the background color used to draw the text.

Returns:

Current background color.

getColor

Color getColor()

Indicates the color used to draw the text.

Returns:

Current text color.

getFont

Font getFont()

Indicates the font used to draw the text.

Returns:

Current font.

getPosition

Position getPosition()

Indicates the geographic position of the text.

Returns:

The text position.

getPriority

double getPriority()

Indicates the text priority. The priority can be used to implement text culling.

Returns:

The text priority.

getText

CharSequence getText()

Indicates the text contained in this object.

Returns:

The current text.

isVisible

boolean isVisible()

Indicates whether or not the text is visible. The text will not be drawn when the visibility is set to false.

Returns:

true if the text is visible, otherwise false.

setBackgroundColor

void setBackgroundColor(Color background)

Specifies the background color used to draw the text.

Parameters:

background - New background color.

setColor

void setColor(Color color)

Specifies the color used to draw the text.

Parameters:

color - New color.

setFont

void setFont(Font font)

Specifies the font used to draw the text.

Parameters:

font - New font.

setPosition

void setPosition(Position position)

Specifies the geographic position of the text.

Parameters:

position - New text position.

setPriority

void setPriority(double d)

Specifies the text priority. The priority can be used to implement text culling.

Parameters:

d - New priority.

setText

void setText(CharSequence text)

Specifies the text.

Parameters:

text - New text.

setVisible

void setVisible(boolean visible)

Specifies whether or not the text is visible. The text will not be drawn when the visibility is set to false.

Parameters:

visible - true if the text should be visible. false if not.