Stellarium 0.13.2
List of all members | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Properties
StarMgr Class Reference

Stores the star catalogue data. More...

#include <StarMgr.hpp>

Public Slots

void setLabelColor (const Vec3f &c)
 Set the color used to label bright stars. More...
 
Vec3f getLabelColor (void) const
 Get the current color used to label bright stars. More...
 
void setFlagStars (bool b)
 Set display flag for Stars. More...
 
bool getFlagStars (void) const
 Get display flag for Stars. More...
 
void setFlagLabels (bool b)
 Set display flag for Star names (labels). More...
 
bool getFlagLabels (void) const
 Get display flag for Star names (labels). More...
 
void setLabelsAmount (float a)
 Set the amount of star labels. More...
 
float getLabelsAmount (void) const
 Get the amount of star labels. More...
 
void setFontSize (float newFontSize)
 Define font size to use for star names display. More...
 
static void setFlagSciNames (bool f)
 Show scientific or catalog names on stars without common names. More...
 
static bool getFlagSciNames (void)
 

Signals

void starLabelsDisplayedChanged (const bool displayed)
 
void starsDisplayedChanged (const bool displayed)
 

Public Member Functions

virtual void init ()
 Initialize the StarMgr. More...
 
virtual void draw (StelCore *core)
 Draw the stars and the star selection indicator if necessary. More...
 
virtual void update (double deltaTime)
 Update any time-dependent features. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Used to determine the order in which the various StelModules are drawn. More...
 
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Return a list containing the stars located inside the limFov circle around position v. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching Stars object's pointer if exists or NULL. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching star 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 QStringList listAllObjectsByType (const QString &objType, bool inEnglish) const
 
virtual QString getName () const
 
StelObjectP searchHP (int hip) const
 Search by Hipparcos catalogue number. More...
 
QVariantList getCatalogsDescription () const
 
bool checkAndLoadCatalog (const QVariantMap &m)
 Try to load the given catalog, even if it is marched as unchecked. More...
 
- 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...
 

Static Public Member Functions

static QString getCommonName (int hip)
 Get the (translated) common name for a star with a specified Hipparcos catalogue number. More...
 
static QString getSciName (int hip)
 Get the (translated) scientific name for a star with a specified Hipparcos catalogue number. More...
 
static QString getSciAdditionalName (int hip)
 Get the (translated) additional scientific name for a star with a specified Hipparcos catalogue number. More...
 
static QString getGcvsName (int hip)
 Get the (translated) scientific name for a variable star with a specified Hipparcos catalogue number. More...
 
static QString getCommonEnglishName (int hip)
 Get the (English) common name for a star with a specified Hipparcos catalogue number. More...
 
static QString getGcvsVariabilityType (int hip)
 Get the type of variability for a variable star with a specified Hipparcos catalogue number. More...
 
static float getGcvsMaxMagnitude (int hip)
 Get the magnitude at maximum brightness for a variable star with a specified Hipparcos catalogue number. More...
 
static int getGcvsMagnitudeFlag (int hip)
 Get the magnitude flag code for a variable star with a specified Hipparcos catalogue number. More...
 
static float getGcvsMinMagnitude (int hip, bool firstMinimumFlag=true)
 Get the minimum magnitude or amplitude for a variable star with a specified Hipparcos catalogue number. More...
 
static QString getGcvsPhotometricSystem (int hip)
 Get the photometric system for a variable star with a specified Hipparcos catalogue number. More...
 
static double getGcvsEpoch (int hip)
 Get Epoch for maximum light for a variable star with a specified Hipparcos catalogue number. More...
 
static double getGcvsPeriod (int hip)
 Get the period for a variable star with a specified Hipparcos catalogue number. More...
 
static int getGcvsMM (int hip)
 Get the rising time or duration of eclipse for a variable star with a specified Hipparcos catalogue number. More...
 
static QString convertToSpectralType (int index)
 
static QString convertToComponentIds (int index)
 

Properties

bool flagStarsDisplayed
 
bool flagLabelsDisplayed
 

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

Stores the star catalogue data.

Used to render the stars themselves, as well as determine the color table and render the labels of those stars with names for a given SkyCulture.

The celestial sphere is split into zones, which correspond to the triangular faces of a geodesic sphere. The number of zones (faces) depends on the level of sub-division of this sphere. The lowest level, 0, is an icosahedron (20 faces), subsequent levels, L, of sub-division give the number of zones, n as:

n=20 x 4^L

Stellarium uses levels 0 to 7 in the existing star catalogues. Star Data Records contain the position of a star as an offset from the central position of the zone in which that star is located, thus it is necessary to determine the vector from the observer to the centre of a zone, and add the star's offsets to find the absolute position of the star on the celestial sphere.

This position for a star is expressed as a 3-dimensional vector which points from the observer (at the centre of the geodesic sphere) to the position of the star as observed on the celestial sphere.

Definition at line 80 of file StarMgr.hpp.

Member Function Documentation

bool StarMgr::checkAndLoadCatalog ( const QVariantMap &  m)

Try to load the given catalog, even if it is marched as unchecked.

Mark it as checked if checksum is correct.

Returns
false in case of failure.
virtual void StarMgr::draw ( StelCore core)
virtual

Draw the stars and the star selection indicator if necessary.

Reimplemented from StelModule.

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

Used to determine the order in which the various StelModules are drawn.

Reimplemented from StelModule.

static QString StarMgr::getCommonEnglishName ( int  hip)
static

Get the (English) common name for a star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
translated common name of star
static QString StarMgr::getCommonName ( int  hip)
static

Get the (translated) common name for a star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
translated common name of star
bool StarMgr::getFlagLabels ( void  ) const
inlineslot

Get display flag for Star names (labels).

Definition at line 169 of file StarMgr.hpp.

bool StarMgr::getFlagStars ( void  ) const
inlineslot

Get display flag for Stars.

Definition at line 164 of file StarMgr.hpp.

static double StarMgr::getGcvsEpoch ( int  hip)
static

Get Epoch for maximum light for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
Epoch for maximum light for a variable star
static int StarMgr::getGcvsMagnitudeFlag ( int  hip)
static

Get the magnitude flag code for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
the magnitude flag code for a variable star
static float StarMgr::getGcvsMaxMagnitude ( int  hip)
static

Get the magnitude at maximum brightness for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
the magnitude at maximum brightness for a variable star
static float StarMgr::getGcvsMinMagnitude ( int  hip,
bool  firstMinimumFlag = true 
)
static

Get the minimum magnitude or amplitude for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
firstMinimumFlag
Returns
the minimum magnitude or amplitude for a variable star
static int StarMgr::getGcvsMM ( int  hip)
static

Get the rising time or duration of eclipse for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
the rising time or duration of eclipse for variable star
static QString StarMgr::getGcvsName ( int  hip)
static

Get the (translated) scientific name for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
translated scientific name of variable star
static double StarMgr::getGcvsPeriod ( int  hip)
static

Get the period for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
the period of variable star
static QString StarMgr::getGcvsPhotometricSystem ( int  hip)
static

Get the photometric system for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
the photometric system for a variable star
static QString StarMgr::getGcvsVariabilityType ( int  hip)
static

Get the type of variability for a variable star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
type of variability
Vec3f StarMgr::getLabelColor ( void  ) const
inlineslot

Get the current color used to label bright stars.

Definition at line 159 of file StarMgr.hpp.

float StarMgr::getLabelsAmount ( void  ) const
inlineslot

Get the amount of star labels.

The real amount is also proportional with FOV.

Returns
the amount between 0 and 10. 0 is no labels, 10 is maximum of labels

Definition at line 177 of file StarMgr.hpp.

static QString StarMgr::getSciAdditionalName ( int  hip)
static

Get the (translated) additional scientific name for a star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
translated additional scientific name of star
static QString StarMgr::getSciName ( int  hip)
static

Get the (translated) scientific name for a star with a specified Hipparcos catalogue number.

Parameters
hipThe Hipparcos number of star
Returns
translated scientific name of star
virtual void StarMgr::init ( )
virtual

Initialize the StarMgr.

  • Loads the star catalogue data into memory
  • Sets up the star color table
  • Loads the star texture
  • Loads the star font (for labels on named stars)
  • Loads the texture of the sar selection indicator
  • Lets various display flags from the ini parser object

Implements StelModule.

virtual QStringList StarMgr::listAllObjects ( bool  inEnglish) const
virtual
Note
Loading stars with the common names only.

Implements StelObjectModule.

virtual QStringList StarMgr::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 list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

virtual QStringList StarMgr::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 list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

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

Return a list containing the stars located inside the limFov circle around position v.

Implements StelObjectModule.

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

Return the matching star if exists or NULL.

Parameters
nameThe case in-sensistive standard program planet name

Implements StelObjectModule.

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

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

Parameters
nameI18nThe case in-sensistive star common name or HP catalog name (format can be HP1234 or HP 1234 or HIP 1234) or sci name

Implements StelObjectModule.

StelObjectP StarMgr::searchHP ( int  hip) const

Search by Hipparcos catalogue number.

Parameters
hipthe Hipparcos catalogue number of the star which is required.
Returns
the requested StelObjectP or an empty objecy if the requested one was not found.
void StarMgr::setFlagLabels ( bool  b)
inlineslot

Set display flag for Star names (labels).

Definition at line 167 of file StarMgr.hpp.

static void StarMgr::setFlagSciNames ( bool  f)
inlinestaticslot

Show scientific or catalog names on stars without common names.

Definition at line 183 of file StarMgr.hpp.

void StarMgr::setFlagStars ( bool  b)
inlineslot

Set display flag for Stars.

Definition at line 162 of file StarMgr.hpp.

void StarMgr::setFontSize ( float  newFontSize)
slot

Define font size to use for star names display.

void StarMgr::setLabelColor ( const Vec3f c)
inlineslot

Set the color used to label bright stars.

Parameters
cThe color of the bright stars labels
// example of usage in scripts
StarMgr.setLabelColor(Vec3f(1.0,0.0,0.0));

Definition at line 157 of file StarMgr.hpp.

void StarMgr::setLabelsAmount ( float  a)
inlineslot

Set the amount of star labels.

The real amount is also proportional with FOV. The limit is set in function of the stars magnitude

Parameters
athe amount between 0 and 10. 0 is no labels, 10 is maximum of labels

Definition at line 174 of file StarMgr.hpp.

virtual void StarMgr::update ( double  deltaTime)
inlinevirtual

Update any time-dependent features.

Includes fading in and out stars and labels when they are turned on and off.

Implements StelModule.

Definition at line 112 of file StarMgr.hpp.


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