StelModule Class Reference

This is the common base class for all the main components of stellarium. More...

#include <StelModule.hpp>

Public Types
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...

Public Member Functions
virtual void	init ()=0
	Initialize itself. More...
virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...
virtual void	draw (StelCore *core)
	Execute all the drawing functions for this module. More...
virtual void	update (double deltaTime)=0
	Update the module with respect to the time. 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 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 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 bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

Protected Member Functions
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...

Detailed Description

Standard StelModules are the one displaying the stars, the constellations, the planets etc.. Every new module derived class should implement the methods defined in StelModule.hpp. Once a module is registered into the StelModuleMgr, it is automatically managed by the program. It can be called using the GETSTELMODULE macro, passing as argument its name, which is also the QObject name Because StelModules are very generic components, it is also possible to load them dynamically, thus enabling creation of external plug-ins for stellarium.

See also

StelObjectModule for StelModule managing collections of StelObject.

Plugins for documentation on how to develop external plugins.

There are several signals that StelApp emits that subclasses may be interested in: laguageChanged() Update i18n strings from english names according to current global sky and application language. This method also reload the proper fonts depending on the language. The translation shall be done using the StelTranslator provided by the StelApp singleton instance. skyCultureChanged(const QString&) Update sky culture, i.e. load data if necessary and translate them to current sky language if needed. colorSchemeChanged(const QString&) Load the given color style

Member Enumeration Documentation

enum StelModule::StelModuleActionName

Enumerator
ActionDraw	Action associated to the draw() method.
ActionUpdate	Action associated to the update() method.
ActionHandleMouseClicks	Action associated to the handleMouseClicks() method.
ActionHandleMouseMoves	Action associated to the handleMouseMoves() method.
ActionHandleKeys	Action associated to the handleKeys() method.

enum StelModule::StelModuleSelectAction

Enumerator
AddToSelection	Add the StelObject to the current list of selected ones.
ReplaceSelection	Set the StelObject as the new list of selected ones.
RemoveFromSelection	Subtract the StelObject from the current list of selected ones.

Member Function Documentation

class StelAction* StelModule::addAction ( const QString &  id, const QString &  groupId, const QString &  text, QObject *  target, const char *  slot, const QString &  shortcut = "", const QString &  altShortcut = ""  )

protected

Parameters

id	unique identifier. Should be called actionMy_Action. (i.e., start with "action" and then "Capitalize_Underscore" style.)
groupId	string to be used in the Help menu. The action will be listed in this group.
text	short translatable description what the action does.
target	recipient of the call
slot	name of slot in target recipient
shortcut	default shortcut. Can be reconfigured.
altShortcut	default alternative shortcut. Can be reconfigured.

class StelAction* StelModule::addAction ( const QString &  id, const QString &  groupId, const QString &  text, const char *  slot, const QString &  shortcut = "", const QString &  altShortcut = ""  )

inlineprotected

Parameters

id	unique identifier. Should be called actionMy_Action. (i.e., start with "action" and then "Capitalize_Underscore" style.)
groupId	string to be used in the Help menu. The action will be listed in this group.
text	short translatable description what the action does.
slot	name of slot in target recipient
shortcut	default shortcut. Can be reconfigured.
altShortcut	default alternative shortcut. Can be reconfigured.

virtual bool StelModule::configureGui ( bool  show = true )

inlinevirtual

This is to be used with plugins to display a configuration dialog from the plugin list window.

Parameters

show	if true, make the configuration GUI visible. If false, hide the config GUI if there is one.

Returns

true if the module has a configuration GUI, else false.

Reimplemented in ArchaeoLines, Satellites, Exoplanets, Pulsars, Quasars, Novae, MeteorShowersMgr, Supernovae, Oculars, Scenery3d, TelescopeControl, AngleMeasure, PointerCoordinates, NavStars, RemoteSync, SolarSystemEditor, EquationOfTime, RemoteControl, Observability, FOV, and LogBook.

virtual void StelModule::deinit ( )

inlinevirtual

Deinitialize all openGL texture in this method.

Reimplemented in SolarSystem, Satellites, MeteorShowersMgr, Oculars, Scenery3d, Exoplanets, Pulsars, Quasars, TelescopeControl, PointerCoordinates, Supernovae, NavStars, SolarSystemEditor, EquationOfTime, NomenclatureMgr, FOV, CustomObjectMgr, and ToastMgr.

virtual void StelModule::draw ( StelCore *  core )

inlinevirtual

Parameters

core	the core to use for the drawing

Reimplemented in GridLinesMgr, NebulaMgr, SolarSystem, ArchaeoLines, Satellites, LandscapeMgr, StarMgr, ScreenImageMgr, MeteorShowersMgr, Oculars, ConstellationMgr, Scenery3d, Exoplanets, Pulsars, AsterismMgr, Quasars, TelescopeControl, StelMovementMgr, PointerCoordinates, AngleMeasure, Supernovae, Novae, NavStars, SolarSystemEditor, ZodiacalLight, EquationOfTime, RemoteControl, Observability, NomenclatureMgr, MeteorShowers, MilkyWay, CompassMarks, LabelMgr, StelSkyLayerMgr, LogBook, CustomObjectMgr, StelObjectMgr, TextUserInterface, SporadicMeteorMgr, ToastMgr, HelloStelModule, and SimpleDrawLine.

virtual double StelModule::getCallOrder ( StelModuleActionName  actionName ) const

inlinevirtual

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 in GridLinesMgr, NebulaMgr, SolarSystem, ArchaeoLines, Satellites, LandscapeMgr, StarMgr, ScreenImageMgr, MeteorShowersMgr, ConstellationMgr, Oculars, Scenery3d, Exoplanets, StelMovementMgr, AsterismMgr, Pulsars, Quasars, TelescopeControl, PointerCoordinates, AngleMeasure, Supernovae, Novae, ZodiacalLight, NavStars, RemoteSync, SolarSystemEditor, EquationOfTime, RemoteControl, Observability, MilkyWay, NomenclatureMgr, LabelMgr, FOV, StelSkyLayerMgr, CompassMarks, LogBook, CustomObjectMgr, TextUserInterface, SporadicMeteorMgr, ToastMgr, HelloStelModule, and SimpleDrawLine.

virtual void StelModule::handleKeys ( class QKeyEvent *  e )

inlinevirtual

Please note that most of the interactions will be done through the GUI module.

Parameters

e	the Key event

Returns

set the event as accepted if it was intercepted

Reimplemented in ArchaeoLines, Oculars, Scenery3d, StelMovementMgr, AngleMeasure, RemoteControl, and TextUserInterface.

virtual void StelModule::handleMouseClicks ( class QMouseEvent *  )

inlinevirtual

Please note that most of the interactions will be done through the GUI module.

Returns

set the event as accepted if it was intercepted

Reimplemented in Oculars, StelMovementMgr, AngleMeasure, and CustomObjectMgr.

virtual bool StelModule::handleMouseMoves ( int  x, int  y, Qt::MouseButtons  b  )

inlinevirtual

Please note that most of the interactions will be done through the GUI module.

Returns

true if the event was intercepted

Reimplemented in StelMovementMgr, and AngleMeasure.

virtual void StelModule::handleMouseWheel ( class QWheelEvent *  )

inlinevirtual

Please note that most of the interactions will be done through the GUI module.

Returns

set the event as accepted if it was intercepted

Reimplemented in StelMovementMgr.

virtual bool StelModule::handlePinch ( qreal  scale, bool  started  )

inlinevirtual

Parameters

scale	the value of the pinch gesture.
started	define whether the pinch has just started.

Returns

true if the event was intercepted.

Reimplemented in StelMovementMgr.

virtual void StelModule::init ( )

pure virtual

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

Implemented in GridLinesMgr, NebulaMgr, ArchaeoLines, SolarSystem, Satellites, LandscapeMgr, StarMgr, ScreenImageMgr, MeteorShowersMgr, Oculars, ConstellationMgr, Scenery3d, Exoplanets, Pulsars, AsterismMgr, Quasars, TelescopeControl, PointerCoordinates, AngleMeasure, Supernovae, StelMovementMgr, Novae, NavStars, RemoteSync, ZodiacalLight, SolarSystemEditor, EquationOfTime, RemoteControl, Observability, NomenclatureMgr, LogBook, FOV, MilkyWay, CompassMarks, MeteorShowers, LabelMgr, StelSkyLayerMgr, StelObjectMgr, CustomObjectMgr, TextUserInterface, SporadicMeteorMgr, StelGeodesicGridDrawer, ToastMgr, HelloStelModule, and SimpleDrawLine.

virtual void StelModule::update ( double  deltaTime )

pure virtual

Parameters

deltaTime

the time increment in second since last call.

Implemented in GridLinesMgr, NebulaMgr, SolarSystem, ArchaeoLines, Satellites, LandscapeMgr, StarMgr, ScreenImageMgr, Oculars, MeteorShowersMgr, ConstellationMgr, Scenery3d, Exoplanets, AsterismMgr, Pulsars, Quasars, TelescopeControl, PointerCoordinates, AngleMeasure, StelMovementMgr, Supernovae, Novae, NavStars, ZodiacalLight, RemoteSync, SolarSystemEditor, EquationOfTime, RemoteControl, Observability, MilkyWay, NomenclatureMgr, LogBook, MeteorShowers, FOV, LabelMgr, StelSkyLayerMgr, CompassMarks, StelObjectMgr, CustomObjectMgr, TextUserInterface, SporadicMeteorMgr, StelGeodesicGridDrawer, ToastMgr, HelloStelModule, and SimpleDrawLine.