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

NebulaMgr Class Reference

Manage a collection of nebulae. More...

#include <NebulaMgr.hpp>

List of all members.

Public Slots

void setCirclesColor (const Vec3f &c)
 Set the color used to draw the nebula circles.
const Vec3fgetCirclesColor (void) const
 Get current value of the nebula circle color.
void setCircleScale (float scale)
 Set Nebulae Hints circle scale.
float getCircleScale (void) const
 Get Nebulae Hints circle scale.
void setHintsFadeDuration (float duration)
 Set how long it takes for nebula hints to fade in and out when turned on and off.
void setFlagHints (bool b)
 Set flag for displaying Nebulae Hints.
bool getFlagHints (void) const
 Get flag for displaying Nebulae Hints.
void setFlagShow (bool b)
 Set flag used to turn on and off Nebula rendering.
bool getFlagShow (void) const
 Get value of flag used to turn on and off Nebula rendering.
void setLabelsColor (const Vec3f &c)
 Set the color used to draw nebula labels.
const Vec3fgetLabelsColor (void) const
 Get current value of the nebula label color.
void setLabelsAmount (float a)
 Set the amount of nebulae labels.
float getLabelsAmount (void) const
 Get the amount of nebulae labels.
void setHintsAmount (float f)
 Set the amount of nebulae hints.
float getHintsAmount (void) const
 Get the amount of nebulae labels.

Public Member Functions

virtual void init ()
 Initialize the NebulaMgr object.
virtual void draw (StelCore *core, class StelRenderer *renderer)
 Draws all nebula objects.
virtual void update (double deltaTime)
 Update state which is time dependent.
virtual double getCallOrder (StelModuleActionName actionName) const
 Determines the order in which the various modules are drawn.
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Used to get a vector of objects which are near to some position.
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching nebula object's pointer if exists or NULL.
virtual StelObjectP searchByName (const QString &name) const
 Return the matching nebula if exists or NULL.
virtual QStringList listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.
virtual QStringList listAllObjects (bool inEnglish) const
virtual QString getName () const

Detailed Description

Manage a collection of nebulae.

This class is used to display the NGC catalog with information, and textures for some of them.

Definition at line 43 of file NebulaMgr.hpp.


Member Function Documentation

virtual void NebulaMgr::draw ( StelCore core,
class StelRenderer renderer 
) [virtual]

Draws all nebula objects.

Reimplemented from StelModule.

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

Determines the order in which the various modules are drawn.

Reimplemented from StelModule.

float NebulaMgr::getCircleScale ( void   )  const [slot]

Get Nebulae Hints circle scale.

const Vec3f& NebulaMgr::getCirclesColor ( void   )  const [slot]

Get current value of the nebula circle color.

bool NebulaMgr::getFlagHints ( void   )  const [inline, slot]

Get flag for displaying Nebulae Hints.

Definition at line 117 of file NebulaMgr.hpp.

bool NebulaMgr::getFlagShow ( void   )  const [inline, slot]

Get value of flag used to turn on and off Nebula rendering.

Definition at line 122 of file NebulaMgr.hpp.

float NebulaMgr::getHintsAmount ( void   )  const [inline, slot]

Get the amount of nebulae labels.

The real amount is also proportional with FOV.

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

Definition at line 143 of file NebulaMgr.hpp.

float NebulaMgr::getLabelsAmount ( void   )  const [inline, slot]

Get the amount of nebulae 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 135 of file NebulaMgr.hpp.

const Vec3f& NebulaMgr::getLabelsColor ( void   )  const [slot]

Get current value of the nebula label color.

virtual void NebulaMgr::init (  )  [virtual]

Initialize the NebulaMgr object.

  • Load the font into the Nebula class, which is used to draw Nebula labels.
  • Load the texture used to draw nebula locations into the Nebula class (for those with no individual texture).
  • Load the pointer texture.
  • Set flags values from ini parser which relate to nebula display.
  • call updateI18n() to translate names.

Implements StelModule.

virtual QStringList NebulaMgr::listMatchingObjectsI18n ( const QString &  objPrefix,
int  maxNbItem = 5 
) const [virtual]

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

Parameters:
objPrefix the case insensitive first letters of the searched object
maxNbItem the maximum number of returned object names
Returns:
a list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

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

Used to get a vector of objects which are near to some position.

Parameters:
v a vector representing the position in th sky around which to search for nebulae.
limitFov the field of view around the position v in which to search for nebulae.
core the StelCore to use for computations.
Returns:
an list containing the nebulae located inside the limitFov circle around position v.

Implements StelObjectModule.

virtual StelObjectP NebulaMgr::searchByName ( const QString &  name  )  const [virtual]

Return the matching nebula if exists or NULL.

Parameters:
name The case in-sensistive standard program name

Implements StelObjectModule.

virtual StelObjectP NebulaMgr::searchByNameI18n ( const QString &  nameI18n  )  const [virtual]

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

Parameters:
nameI18n The case in-sensistive nebula name or NGC M catalog name : format can be M31, M 31, NGC31, NGC 31

Implements StelObjectModule.

void NebulaMgr::setCircleScale ( float  scale  )  [slot]

Set Nebulae Hints circle scale.

void NebulaMgr::setCirclesColor ( const Vec3f c  )  [slot]

Set the color used to draw the nebula circles.

void NebulaMgr::setFlagHints ( bool  b  )  [inline, slot]

Set flag for displaying Nebulae Hints.

Definition at line 115 of file NebulaMgr.hpp.

void NebulaMgr::setFlagShow ( bool  b  )  [inline, slot]

Set flag used to turn on and off Nebula rendering.

Definition at line 120 of file NebulaMgr.hpp.

void NebulaMgr::setHintsAmount ( float  f  )  [inline, slot]

Set the amount of nebulae hints.

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

Parameters:
f the amount between 0 and 10. 0 is no hints, 10 is maximum of hints

Definition at line 140 of file NebulaMgr.hpp.

void NebulaMgr::setHintsFadeDuration ( float  duration  )  [inline, slot]

Set how long it takes for nebula hints to fade in and out when turned on and off.

Definition at line 112 of file NebulaMgr.hpp.

void NebulaMgr::setLabelsAmount ( float  a  )  [inline, slot]

Set the amount of nebulae labels.

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

Parameters:
a the amount between 0 and 10. 0 is no labels, 10 is maximum of labels

Definition at line 132 of file NebulaMgr.hpp.

void NebulaMgr::setLabelsColor ( const Vec3f c  )  [slot]

Set the color used to draw nebula labels.

virtual void NebulaMgr::update ( double  deltaTime  )  [inline, virtual]

Update state which is time dependent.

Implements StelModule.

Definition at line 66 of file NebulaMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Jan 31 14:05:43 2013 for Stellarium by  doxygen 1.6.3