Stellarium  23.4
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 setFlagShowNomenclature (bool b)
 Set flag which determines if nomenclature labels are drawn or hidden.
 
bool getFlagShowNomenclature () const
 Get the current value of the flag which determines if nomenclature labels are drawn or hidden.
 
void setFlagShowTerminatorZoneOnly (bool b)
 Set flag which determines if only nomenclature along the terminator should be shown.
 
bool getFlagShowTerminatorZoneOnly () const
 Get flag which determines if only nomenclature along the terminator should be shown.
 
void setTerminatorMinAltitude (int deg)
 Set minimum solar altitude (degrees) to draw only nomenclature along the terminator.
 
int getTerminatorMinAltitude () const
 Get minimum solar altitude (degrees) to draw only nomenclature along the terminator.
 
void setTerminatorMaxAltitude (int deg)
 Set maximum solar altitude (degrees) to draw only nomenclature along the terminator.
 
int getTerminatorMaxAltitude () const
 Get maximum solar altitude (degrees) to draw only nomenclature along the terminator.
 
void setFlagOutlineCraters (bool b)
 Set flag which determines if craters and satellite features (which are usually also craters) are outlined as ellipses.
 
bool getFlagOutlineCraters () const
 Get the current value of the flag which determines if craters and satellite features (which are usually also craters) are outlined as ellipses.
 
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 setFlagShowSpecialNomenclatureOnly (bool b)
 Set flag which determines if special nomenclature labels only are drawn or hidden.
 
bool getFlagShowSpecialNomenclatureOnly () const
 Get the current value of the flag which determines if special nomenclature labels only are drawn or hidden.
 
void updateI18n ()
 Translate nomenclature names.
 
void updateNomenclatureData ()
 

Signals

void flagShowNomenclatureChanged (bool b)
 
void flagShowTerminatorZoneOnlyChanged (bool b)
 
void terminatorMinAltitudeChanged (int deg)
 
void terminatorMaxAltitudeChanged (int deg)
 
void flagOutlineCratersChanged (bool b)
 
void localNomenclatureHidingChanged (bool b)
 
void specialNomenclatureOnlyDisplayingChanged (bool b)
 
void nomenclatureColorChanged (const Vec3f &color) const
 

Public Member Functions

virtual void init () Q_DECL_OVERRIDE
 Initialize itself. More...
 
virtual void deinit () Q_DECL_OVERRIDE
 Called before the module will be deleted, and before the OpenGL context is suppressed. More...
 
virtual void update (double deltaTime) Q_DECL_OVERRIDE
 Update the module with respect to the time. More...
 
virtual void draw (StelCore *core) Q_DECL_OVERRIDE
 Execute all the drawing functions for this module. More...
 
virtual void drawPointer (StelCore *core, StelPainter &painter)
 
virtual double getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
 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 Q_DECL_OVERRIDE
 Used to get a list of objects which are near to some position. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const Q_DECL_OVERRIDE
 Return the matching satellite object's pointer if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const Q_DECL_OVERRIDE
 Return the matching satellite if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByID (const QString &id) const Q_DECL_OVERRIDE
 Return the StelObject with the given ID if exists or the empty StelObject if not found. More...
 
virtual QStringList listAllObjects (bool inEnglish) const Q_DECL_OVERRIDE
 List all StelObjects. More...
 
virtual QStringList listAllObjectsByType (const QString &objType, bool inEnglish) const Q_DECL_OVERRIDE
 List all StelObjects by type. More...
 
virtual QString getName () const Q_DECL_OVERRIDE
 Gets a user-displayable name of the object category.
 
virtual QString getStelObjectType () const Q_DECL_OVERRIDE
 Returns the name that will be returned by StelObject::getType() for the objects this module manages.
 
- Public Member Functions inherited from StelObjectModule
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 passed object name. More...
 
bool matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
 Auxiliary method of listMatchingObjects() More...
 
- Public Member Functions inherited from StelModule
 StelModule ()
 Constructor. Every derived class MUST call setObjectName(className) in its constructor.
 
virtual QSettings * getSettings ()
 Return module-specific settings. More...
 
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 address 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 flagShowNomenclature
 
bool flagShowTerminatorZoneOnly
 
int terminatorMinAltitude
 
int terminatorMaxAltitude
 
bool flagOutlineCraters
 
bool flagHideLocalNomenclature
 
bool specialNomenclatureOnlyDisplayed
 
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...
 
StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...
 

Member Function Documentation

◆ deinit()

virtual void NomenclatureMgr::deinit ( )
virtual

Called before the module will be deleted, and before the OpenGL context is suppressed.

Deinitialize all OpenGL texture in this method.

Reimplemented from StelModule.

◆ draw()

virtual void NomenclatureMgr::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

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

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.

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.

◆ getColor

const Vec3f& NomenclatureMgr::getColor ( void  ) const
slot

Get the current color used to draw nomenclature items.

Returns
current color

◆ init()

virtual void NomenclatureMgr::init ( )
virtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

virtual QStringList NomenclatureMgr::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

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.

◆ listAllObjectsByType()

virtual QStringList NomenclatureMgr::listAllObjectsByType ( const QString &  objType,
bool  inEnglish 
) const
virtual

List all StelObjects by type.

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.

◆ searchAround()

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

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

Parameters
va vector representing the position in the sky around which to search for nomenclatures.
limitFovthe field of view around the position v in which to search for nomenclatures.
corethe StelCore to use for computations.
Returns
a list containing the NomenclatureItems located inside the limitFov circle around position v.

Implements StelObjectModule.

◆ searchByEnglishName

NomenclatureItemP NomenclatureMgr::searchByEnglishName ( QString  nomenclatureItemEnglishName) const
slot

Get a pointer to a nomenclature item.

Parameters
nomenclatureItemEnglishNamethe English name of the desired object.
Returns
The matching nomenclature item pointer if exists or Q_NULLPTR.

◆ searchByID()

virtual StelObjectP NomenclatureMgr::searchByID ( const QString &  id) const
inlinevirtual

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters
namethe english object name

Implements StelObjectModule.

◆ searchByName()

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

Return the matching satellite if exists or Q_NULLPTR.

Parameters
nameThe case in-sensitive english NomenclatureItem name

Implements StelObjectModule.

◆ searchByNameI18n()

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

Return the matching satellite object's pointer if exists or Q_NULLPTR.

Parameters
nameI18nThe case in-sensitive localized NomenclatureItem name

Implements StelObjectModule.

◆ setColor

void NomenclatureMgr::setColor ( const Vec3f c)
slot

Set the color used to draw nomenclature items.

Parameters
cThe color of the nomenclature items (R,G,B)
// example of usage in scripts

◆ update()

virtual void NomenclatureMgr::update ( double  deltaTime)
inlinevirtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Reimplemented from StelModule.