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 Vec3f &	getColor (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 ()

void	setForceItems (bool b)
	trigger in a lambda connected from StelCore::locationChanged

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
void	init () override
	Initialize itself. More...

void	deinit () override
	Called before the module will be deleted, and before the OpenGL context is suppressed. More...

void	update (double deltaTime) override
	Update the module with respect to the time. More...

void	draw (StelCore *core) override
	Execute all the drawing functions for this module. More...

virtual void	drawPointer (StelCore *core, StelPainter &painter)

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

QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const override
	Used to get a list of objects which are near to some position. More...

StelObjectP	searchByNameI18n (const QString &nameI18n) const override
	Return the matching satellite object's pointer if exists or Q_NULLPTR. More...

StelObjectP	searchByName (const QString &name) const override
	Return the matching satellite if exists or Q_NULLPTR. More...

StelObjectP	searchByID (const QString &id) const override
	Return the StelObject with the given ID if exists or the empty StelObject if not found. More...

QStringList	listAllObjects (bool inEnglish) const override
	List all StelObjects. More...

QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const override
	List all StelObjects by type. More...

QString	getName () const override
	Gets a user-displayable name of the object category.

QString	getStelObjectType () const 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 StelAction *	addAction (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 StelAction *	addAction (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...

StelAction *	addAction (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()

void NomenclatureMgr::deinit ( )

overridevirtual

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()

void NomenclatureMgr::draw ( StelCore * core )

overridevirtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

double NomenclatureMgr::getCallOrder ( StelModuleActionName actionName ) const

overridevirtual

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

actionName the 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()

void NomenclatureMgr::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

QStringList NomenclatureMgr::listAllObjects ( bool inEnglish ) const

overridevirtual

List all StelObjects.

Parameters

inEnglish list 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()

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

overridevirtual

List all StelObjects by type.

Parameters

objType	object type
inEnglish	list 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()

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

overridevirtual

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

Parameters

v	a vector representing the position in the sky around which to search for nomenclatures.
limitFov	the field of view around the position v in which to search for nomenclatures.
core	the 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

nomenclatureItemEnglishName the English name of the desired object.

Returns: The matching nomenclature item pointer if exists or Q_NULLPTR.

◆ searchByID()

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

inlineoverridevirtual

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

Parameters

name	the english object name

Implements StelObjectModule.

◆ searchByName()

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

overridevirtual

Return the matching satellite if exists or Q_NULLPTR.

Parameters

name	The case in-sensitive english NomenclatureItem name

Implements StelObjectModule.

◆ searchByNameI18n()

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

overridevirtual

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

Parameters

nameI18n The 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

c	The color of the nomenclature items (R,G,B) // example of usage in scripts NomenclatureMgr.setColor(Vec3f(1.0,0.0,0.0));

◆ update()

void NomenclatureMgr::update ( double deltaTime )

inlineoverridevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Reimplemented from StelModule.

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ deinit()

◆ draw()

◆ getCallOrder()

◆ getColor

◆ init()

◆ listAllObjects()

◆ listAllObjectsByType()

◆ searchAround()

◆ searchByEnglishName

◆ searchByID()

◆ searchByName()

◆ searchByNameI18n()

◆ setColor

◆ update()