Stellarium  0.18.1
Public Slots | Signals | Public Member Functions | Properties
NomenclatureMgr Class Reference

Public Slots

NomenclatureItemP searchByEnglishName (QString nomenclatureItemEnglishName) const
 Get a pointer to a nomenclature item. More...
 
void setColor (const Vec3f &c)
 Set the color used to draw nomenclature items. More...
 
const Vec3fgetColor (void) const
 Get the current color used to draw nomenclature items. More...
 
void setFlagLabels (bool b)
 Set flag which determines if nomenclature labels are drawn or hidden.
 
bool getFlagLabels () const
 Get the current value of the flag which determines if nomenclature labels are drawn or hidden.
 
void setFlagHideLocalNomenclature (bool b)
 Set flag which determines if nomenclature labels are drawn or hidden on the celestial body of observer.
 
bool getFlagHideLocalNomenclature () const
 Get the current value of the flag which determines if nomenclature labels are drawn or hidden on the celestial body of observer.
 
void updateI18n ()
 Translate nomenclature names.
 
void updateNomenclatureData ()
 

Signals

void nomenclatureDisplayedChanged (bool b)
 
void localNomenclatureHidingChanged (bool b)
 
void nomenclatureColorChanged (const Vec3f &color) const
 

Public Member Functions

virtual void init ()
 Initialize itself. More...
 
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual void update (double)
 Update the module with respect to the time. More...
 
virtual void draw (StelCore *core)
 Execute all the drawing functions for this module. More...
 
virtual void drawPointer (StelCore *core, StelPainter &painter)
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
 
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Used to get a list of objects which are near to some position. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching satellite object's pointer if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching satellite if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByID (const QString &id) const
 Return the StelObject with the given ID if exists or the empty StelObject if not found. More...
 
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...
 
virtual QStringList listAllObjects (bool inEnglish) const
 List all StelObjects. More...
 
virtual QStringList listAllObjectsByType (const QString &objType, bool inEnglish) const
 List all StelObjects by type. More...
 
virtual QString getName () const
 Gets a user-displayable name of the object category.
 
virtual QString getStelObjectType () const
 Returns the name that will be returned by StelObject::getType() for the objects this module manages.
 
- Public Member Functions inherited from StelObjectModule
bool matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
 Auxiliary method of listMatchingObjects() More...
 
- Public Member Functions inherited from StelModule
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version.
 
virtual QString getAuthorName () const
 Get the name of the module author.
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author.
 
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 nomenclatureDisplayed
 
bool localNomenclatureHided
 
Vec3f nomenclatureColor
 

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 (call to slot) 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 (call to own slot) to the StelActionMgr object. More...
 

Member Function Documentation

virtual void NomenclatureMgr::deinit ( )
virtual

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void NomenclatureMgr::draw ( StelCore core)
virtual
Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

virtual double NomenclatureMgr::getCallOrder ( StelModuleActionName  actionName) const
virtual
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.

const Vec3f& NomenclatureMgr::getColor ( void  ) const
slot
Returns
current color
virtual void NomenclatureMgr::init ( )
virtual

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

virtual QStringList NomenclatureMgr::listAllObjects ( bool  inEnglish) const
virtual
Parameters
inEnglishlist names in English (true) or translated (false)
Returns
a list of matching object name by order of relevance, or an empty list if nothing matches

Implements StelObjectModule.

virtual QStringList NomenclatureMgr::listAllObjectsByType ( const QString &  objType,
bool  inEnglish 
) const
virtual
Parameters
objTypeobject type
inEnglishlist translated names (false) or in English (true)
Returns
a list of matching object name by order of relevance, or an empty list if nothing matches

Reimplemented from StelObjectModule.

virtual QStringList NomenclatureMgr::listMatchingObjects ( const QString &  objPrefix,
int  maxNbItem = 5,
bool  useStartOfWords = false,
bool  inEnglish = false 
) const
virtual
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

Reimplemented from StelObjectModule.

virtual QList<StelObjectP> NomenclatureMgr::searchAround ( const Vec3d v,
double  limitFov,
const StelCore core 
) const
virtual
Parameters
va vector representing the position in th sky around which to search for nebulae.
limitFovthe field of view around the position v in which to search for satellites.
corethe StelCore to use for computations.
Returns
an list containing the satellites located inside the limitFov circle around position v.

Implements StelObjectModule.

NomenclatureItemP NomenclatureMgr::searchByEnglishName ( QString  nomenclatureItemEnglishName) const
slot
Parameters
nomenclatureItemEnglishNamethe English name of the desired object.
Returns
The matching nomenclature item pointer if exists or Q_NULLPTR.
virtual StelObjectP NomenclatureMgr::searchByID ( const QString &  id) const
inlinevirtual
Parameters
namethe english object name

Implements StelObjectModule.

virtual StelObjectP NomenclatureMgr::searchByName ( const QString &  name) const
virtual
Parameters
nameThe case in-sensistive standard program name

Implements StelObjectModule.

virtual StelObjectP NomenclatureMgr::searchByNameI18n ( const QString &  nameI18n) const
virtual
Parameters
nameI18nThe case in-sensistive satellite name

Implements StelObjectModule.

void NomenclatureMgr::setColor ( const Vec3f c)
slot
Parameters
cThe color of the nomenclature items (R,G,B)
// example of usage in scripts
virtual void NomenclatureMgr::update ( double  deltaTime)
inlinevirtual
Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.