Stellarium 0.13.1
List of all members | Public Slots | Signals | Public Member Functions | Properties
ConstellationMgr Class Reference

Display and manage the constellations. More...

#include <ConstellationMgr.hpp>

Public Slots

void setFlagArt (const bool displayed)
 Set whether constellation art will be displayed. More...
 
bool getFlagArt (void) const
 Get whether constellation art is displayed. More...
 
void setArtFadeDuration (const float duration)
 Set constellation art fade duration in second. More...
 
float getArtFadeDuration () const
 Get constellation art fade duration in second. More...
 
void setArtIntensity (const double intensity)
 Set constellation maximum art intensity (between 0 and 1) More...
 
double getArtIntensity () const
 Set constellation maximum art intensity (between 0 and 1) More...
 
void setBoundariesColor (const Vec3f &color)
 Define boundary color. More...
 
Vec3f getBoundariesColor () const
 Get current boundary color. More...
 
void setFlagBoundaries (const bool displayed)
 Set whether constellation boundaries lines will be displayed. More...
 
bool getFlagBoundaries (void) const
 Get whether constellation boundaries lines are displayed. More...
 
void setFlagIsolateSelected (const bool isolate)
 Set whether selected constellation must be displayed alone. More...
 
bool getFlagIsolateSelected (void) const
 Get whether selected constellation is displayed alone. More...
 
void setLinesColor (const Vec3f &color)
 Define line color. More...
 
Vec3f getLinesColor () const
 Get line color. More...
 
void setFlagLines (const bool displayed)
 Set whether constellation path lines will be displayed. More...
 
bool getFlagLines (void) const
 Get whether constellation path lines are displayed. More...
 
void setLabelsColor (const Vec3f &color)
 Set label color for names. More...
 
Vec3f getLabelsColor () const
 Get label color for names. More...
 
void setFlagLabels (bool displayed)
 Set whether constellation names will be displayed. More...
 
bool getFlagLabels (void) const
 Set whether constellation names are displayed. More...
 
void setFontSize (const float newFontSize)
 Set the font size used for constellation names display. More...
 
float getFontSize () const
 Get the font size used for constellation names display. More...
 

Signals

void artDisplayedChanged (const bool displayed) const
 
void artFadeDurationChanged (const float duration) const
 
void artIntensityChanged (const double intensity) const
 
void boundariesColorChanged (const Vec3f &color) const
 
void boundariesDisplayedChanged (const bool displayed) const
 
void fontSizeChanged (const float newSize) const
 
void isolateSelectedChanged (const bool isolate) const
 
void linesColorChanged (const Vec3f &color) const
 
void linesDisplayedChanged (const bool displayed) const
 
void namesColorChanged (const Vec3f &color) const
 
void namesDisplayedChanged (const bool displayed) const
 

Public Member Functions

 ConstellationMgr (StarMgr *stars)
 Constructor. More...
 
virtual ~ConstellationMgr ()
 Destructor. More...
 
virtual void init ()
 Initialize the ConstellationMgr. More...
 
virtual void draw (StelCore *core)
 Draw constellation lines, art, names and boundaries. More...
 
virtual void update (double deltaTime)
 Updates time-varying state for each Constellation. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Return the value defining the order of call for the given action. More...
 
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Search for StelObject in an area around a specifid point. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching constellation object's pointer if exists or NULL. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching constellation if exists or NULL. More...
 
virtual QStringList listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name. More...
 
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object English name. More...
 
virtual QStringList listAllObjects (bool inEnglish) const
 
virtual QString getName () const
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version. More...
 
virtual QString getAuthorName () const
 Get the name of the module author. More...
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author. More...
 
virtual void handleMouseClicks (class QMouseEvent *)
 Handle mouse clicks. More...
 
virtual void handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual void handleKeys (class QKeyEvent *e)
 Handle key events. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool artDisplayed
 
bool artFadeDuration
 
bool artIntensity
 
bool boundariesColor
 
bool boundariesDisplayed
 
bool fontSize
 
bool isolateSelected
 
bool linesColor
 
bool linesDisplayed
 
bool namesColor
 
bool namesDisplayed
 

Additional Inherited Members

- Public Types inherited from StelModule
enum  StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
 Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
 
enum  StelModuleActionName {
  ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves,
  ActionHandleKeys
}
 Define the possible action for which an order is defined. More...
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action to the StelActionMgr object. More...
 
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action to the StelActionMgr object. More...
 

Detailed Description

Display and manage the constellations.

It can display constellations lines, names, art textures and boundaries. It also supports several different sky cultures.

Definition at line 43 of file ConstellationMgr.hpp.

Constructor & Destructor Documentation

ConstellationMgr::ConstellationMgr ( StarMgr stars)

Constructor.

virtual ConstellationMgr::~ConstellationMgr ( )
virtual

Destructor.

Member Function Documentation

virtual void ConstellationMgr::draw ( StelCore core)
virtual

Draw constellation lines, art, names and boundaries.

Reimplemented from StelModule.

float ConstellationMgr::getArtFadeDuration ( ) const
slot

Get constellation art fade duration in second.

double ConstellationMgr::getArtIntensity ( ) const
slot

Set constellation maximum art intensity (between 0 and 1)

Vec3f ConstellationMgr::getBoundariesColor ( ) const
slot

Get current boundary color.

virtual double ConstellationMgr::getCallOrder ( StelModuleActionName  actionName) const
virtual

Return the value defining the order of call for the given action.

Parameters
actionNamethe name of the action for which we want the call order
Returns
the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

bool ConstellationMgr::getFlagArt ( void  ) const
slot

Get whether constellation art is displayed.

bool ConstellationMgr::getFlagBoundaries ( void  ) const
slot

Get whether constellation boundaries lines are displayed.

bool ConstellationMgr::getFlagIsolateSelected ( void  ) const
slot

Get whether selected constellation is displayed alone.

bool ConstellationMgr::getFlagLabels ( void  ) const
slot

Set whether constellation names are displayed.

bool ConstellationMgr::getFlagLines ( void  ) const
slot

Get whether constellation path lines are displayed.

float ConstellationMgr::getFontSize ( ) const
slot

Get the font size used for constellation names display.

Vec3f ConstellationMgr::getLabelsColor ( ) const
slot

Get label color for names.

Vec3f ConstellationMgr::getLinesColor ( ) const
slot

Get line color.

virtual void ConstellationMgr::init ( )
virtual

Initialize the ConstellationMgr.

Reads from the configuration parser object and updates the loading bar as constellation objects are loaded for the required sky culture.

Implements StelModule.

virtual QStringList ConstellationMgr::listMatchingObjects ( const QString &  objPrefix,
int  maxNbItem = 5,
bool  useStartOfWords = false 
) const
virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object English name.

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe autofill mode for returned objects names
Returns
a vector of matching object name by order of relevance, or an empty vector if nothing match

Implements StelObjectModule.

virtual QStringList ConstellationMgr::listMatchingObjectsI18n ( const QString &  objPrefix,
int  maxNbItem = 5,
bool  useStartOfWords = false 
) const
virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe autofill mode for returned objects names
Returns
a vector of matching object name by order of relevance, or an empty vector if nothing match

Implements StelObjectModule.

virtual QList<StelObjectP> ConstellationMgr::searchAround ( const Vec3d v,
double  limitFov,
const StelCore core 
) const
virtual

Search for StelObject in an area around a specifid point.

The function searches in a disk of diameter limitFov centered on v. Only visible objects (i.e curretly displayed on screen) should be returned.

Parameters
vequatorial position at epoch J2000.
limitFovangular diameter of the searching zone in degree.
corethe core instance to use.
Returns
the list of all the displayed objects contained in the defined zone.

Implements StelObjectModule.

virtual StelObjectP ConstellationMgr::searchByName ( const QString &  name) const
virtual

Return the matching constellation if exists or NULL.

Parameters
nameThe case in-sensistive standard program name (three letter abbreviation)

Implements StelObjectModule.

virtual StelObjectP ConstellationMgr::searchByNameI18n ( const QString &  nameI18n) const
virtual

Return the matching constellation object's pointer if exists or NULL.

Parameters
nameI18nThe case in-sensistive constellation name

Implements StelObjectModule.

void ConstellationMgr::setArtFadeDuration ( const float  duration)
slot

Set constellation art fade duration in second.

void ConstellationMgr::setArtIntensity ( const double  intensity)
slot

Set constellation maximum art intensity (between 0 and 1)

void ConstellationMgr::setBoundariesColor ( const Vec3f color)
slot

Define boundary color.

Parameters
colorThe color of boundaries
// example of usage in scripts
void ConstellationMgr::setFlagArt ( const bool  displayed)
slot

Set whether constellation art will be displayed.

void ConstellationMgr::setFlagBoundaries ( const bool  displayed)
slot

Set whether constellation boundaries lines will be displayed.

void ConstellationMgr::setFlagIsolateSelected ( const bool  isolate)
slot

Set whether selected constellation must be displayed alone.

void ConstellationMgr::setFlagLabels ( bool  displayed)
slot

Set whether constellation names will be displayed.

void ConstellationMgr::setFlagLines ( const bool  displayed)
slot

Set whether constellation path lines will be displayed.

void ConstellationMgr::setFontSize ( const float  newFontSize)
slot

Set the font size used for constellation names display.

void ConstellationMgr::setLabelsColor ( const Vec3f color)
slot

Set label color for names.

Parameters
colorThe color of labels
// example of usage in scripts
void ConstellationMgr::setLinesColor ( const Vec3f color)
slot

Define line color.

Parameters
colorThe color of lines
// example of usage in scripts
virtual void ConstellationMgr::update ( double  deltaTime)
virtual

Updates time-varying state for each Constellation.

Implements StelModule.


The documentation for this class was generated from the following file: