Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure

LabelMgr Class Reference

Allows for creation of custom labels on objects or coordinates. More...

#include <LabelMgr.hpp>

Inherits StelModule.

List of all members.

Public Slots

int labelObject (const QString &text, const QString &objectName, bool visible=true, float fontSize=14, const QString &fontColor="#999999", const QString &side="E", double labelDistance=-1.0, const QString &style="TextOnly")
int labelScreen (const QString &text, int x, int y, bool visible=true, float fontSize=14, const QString &fontColor="#999999")
bool getLabelShow (int id)
void setLabelShow (int id, bool show)
void setLabelText (int id, const QString &newText)
bool deleteLabel (int id)
int deleteAllLabels (void)

Public Member Functions

 LabelMgr ()
virtual void init ()
virtual void draw (StelCore *core)
virtual void update (double deltaTime)
virtual double getCallOrder (StelModuleActionName actionName) const


Detailed Description

Allows for creation of custom labels on objects or coordinates.

Because this class is intended for use in scripting (although other uses are also fine), all label types and so on are specified by QString descriptions. TODO: when QT4.5 is out, change implementation to use QGraphicsTextItem. (QT4.5 should allow for opacity changes for fades, but it is not currently implemented.


Constructor & Destructor Documentation

LabelMgr::LabelMgr (  ) 

Construct a LabelMgr object.


Member Function Documentation

virtual void LabelMgr::init (  )  [virtual]

Initialize the LabelMgr object.

Implements StelModule.

virtual void LabelMgr::draw ( StelCore core  )  [virtual]

Draw user labels.

Reimplemented from StelModule.

virtual void LabelMgr::update ( double  deltaTime  )  [virtual]

Update time-dependent parts of the module.

Implements StelModule.

virtual double LabelMgr::getCallOrder ( StelModuleActionName  actionName  )  const [virtual]

Defines the order in which the various modules are drawn.

Reimplemented from StelModule.

int LabelMgr::labelObject ( const QString &  text,
const QString &  objectName,
bool  visible = true,
float  fontSize = 14,
const QString &  fontColor = "#999999",
const QString &  side = "E",
double  labelDistance = -1.0,
const QString &  style = "TextOnly" 
) [slot]

Create a label which is attached to a StelObject.

Parameters:
text the text to display
objectName the English name of the object to attach to
visible if true, the label starts displayed, else it starts hidden
fontSize size of the font to use
fontColor HTML-like color spec, e.g. "#ffff00" for yellow
side where the label appears in relation to object:
  • "N" = above object on screen
  • "S" = below object on screen
  • "E" = to the right of the object on screen
  • "W" = to the left of the object on screen
  • "NE", "NW", "SE", "SW" work too.
Returns:
a unique ID which can be used to refer to the label. returns -1 if the label could not be created (e.g. object not found)

int LabelMgr::labelScreen ( const QString &  text,
int  x,
int  y,
bool  visible = true,
float  fontSize = 14,
const QString &  fontColor = "#999999" 
) [slot]

Create a label at fixed screen coordinates.

Parameters:
text the text to display
x the horizontal position on the screen, in pixels, from the left of the screen
y the vertical position on the screen, in pixels, from the top of the screen
visible if true, the label starts displayed, else it starts hidden
fontSize size of the font to use
fontColor HTML-like color spec, e.g. "#ffff00" for yellow

bool LabelMgr::getLabelShow ( int  id  )  [slot]

find out if a label identified by id is presently shown

void LabelMgr::setLabelShow ( int  id,
bool  show 
) [slot]

set a label identified by id to be shown or not

void LabelMgr::setLabelText ( int  id,
const QString &  newText 
) [slot]

set text of label identified by id to be newText

bool LabelMgr::deleteLabel ( int  id  )  [slot]

Delete a label by the ID which was returned from addLabel.

..

Returns:
true if the id existed and was deleted, else false

int LabelMgr::deleteAllLabels ( void   )  [slot]

Delete all labels.

Returns:
the number of labels deleted


Generated on Mon Mar 22 09:55:38 2010 for Stellarium by  doxygen 1.5.5