HelloStelModule Class Reference

This is an example of a plug-in which can be dynamically loaded into stellarium. More...

#include <HelloStelModule.hpp>

Public Member Functions
void	init () override
	Initialize itself. More...
void	draw (StelCore *core) override
	Execute all the drawing functions for this module. More...
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...
Public Member Functions inherited from StelModule
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.
virtual void	deinit ()
	Called before the module will be deleted, and before the OpenGL context is suppressed. More...
virtual QSettings *	getSettings ()
	Return module-specific settings. More...
virtual void	update (double deltaTime)
	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 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...

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

Detailed Description

This is an example of a plug-in which can be dynamically loaded into stellarium.

Member Function Documentation

draw()

void HelloStelModule::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 HelloStelModule::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.

init()

void HelloStelModule::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.