Main class of the Equation of Time plugin. More...

#include <EquationOfTime.hpp>

Inheritance diagram for EquationOfTime:

Collaboration diagram for EquationOfTime:

Public Slots
void	enableEquationOfTime (bool b)
	Enable plugin usage. More...

void	setFlagInvertedValue (bool b)
	Enable usage inverted value for equation of time (switch sign of equation) More...

void	setFlagMsFormat (bool b)
	Enable usage minutes and seconds for value. More...

void	setFlagEnableAtStartup (bool b)
	Enable plugin usage at startup. More...

void	setFontSize (int size)
	Set font size for message. More...

void	setFlagShowEOTButton (bool b)
	Display plugin button on toolbar. More...

Signals
void	equationOfTimeStateChanged (bool b)

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 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)
	Detect or show the configuration GUI elements for the module. More...

void	restoreDefaults (void)
	Set up the plugin with default values. More...

void	readSettingsFromConfig (void)
	Read (or re-read) settings from the main config file. More...

void	saveSettingsToConfig (void)
	Save the settings to the main configuration file. More...

bool	isEnabled () const
	Is plugin enabled? More...

int	getFontSize (void)
	Get font size for messages. More...

bool	getFlagMsFormat (void) const
	Get status of usage minutes and seconds for value of equation. More...

bool	getFlagInvertedValue (void) const
	Get status of usage inverted values for equation of time. More...

bool	getFlagEnableAtStartup (void) const

bool	getFlagShowEOTButton (void) const

Public Member Functions inherited from StelModule
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

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

Properties
bool	showEOT

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

Detailed Description

Main class of the Equation of Time plugin.

Author: Alexander Wolf

Definition at line 59 of file EquationOfTime.hpp.

Member Function Documentation

virtual bool EquationOfTime::configureGui ( bool show )

virtual

Detect or show the configuration GUI elements for the module.

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

virtual void EquationOfTime::deinit ( )

virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void EquationOfTime::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

void EquationOfTime::enableEquationOfTime ( bool b )

slot

Enable plugin usage.

virtual double EquationOfTime::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

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.

bool EquationOfTime::getFlagInvertedValue ( void ) const

inline

Get status of usage inverted values for equation of time.

Definition at line 106 of file EquationOfTime.hpp.

bool EquationOfTime::getFlagMsFormat ( void ) const

inline

Get status of usage minutes and seconds for value of equation.

Definition at line 101 of file EquationOfTime.hpp.

int EquationOfTime::getFontSize ( void )

inline

Get font size for messages.

Definition at line 96 of file EquationOfTime.hpp.

virtual void EquationOfTime::init ( )

virtual

Initialize itself.

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

Implements StelModule.

bool EquationOfTime::isEnabled ( ) const

inline

Is plugin enabled?

Definition at line 90 of file EquationOfTime.hpp.

void EquationOfTime::readSettingsFromConfig ( void )

Read (or re-read) settings from the main config file.

This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).

void EquationOfTime::restoreDefaults ( void )

Set up the plugin with default values.

This means clearing out the Pulsars section in the main config.ini (if one already exists), and populating it with default values.

void EquationOfTime::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

void EquationOfTime::setFlagEnableAtStartup ( bool b )

slot

Enable plugin usage at startup.

void EquationOfTime::setFlagInvertedValue ( bool b )

slot

Enable usage inverted value for equation of time (switch sign of equation)

void EquationOfTime::setFlagMsFormat ( bool b )

slot

Enable usage minutes and seconds for value.

void EquationOfTime::setFlagShowEOTButton ( bool b )

slot

Display plugin button on toolbar.

void EquationOfTime::setFontSize ( int size )

slot

Set font size for message.

virtual void EquationOfTime::update ( double deltaTime )

inlinevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Definition at line 73 of file EquationOfTime.hpp.

The documentation for this class was generated from the following file:

/home/aw/devel/stellarium/0.15/plugins/EquationOfTime/src/EquationOfTime.hpp

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation