Equation of Time plug-in

Data Structures
class	EquationOfTimeWindow
	Main window of the Equation of Time plug-in. More...
class	EquationOfTime
	Main class of the Equation of Time plugin. More...

Detailed Description

The Equation of Time plugin shows the values of the equation of time.

The equation of time describes the discrepancy between two kinds of solar time. These are apparent solar time, which directly tracks the motion of the sun, and mean solar time, which tracks a fictitious "mean" sun with noons 24 hours apart. There is no universally accepted definition of the sign of the equation of time. Some publications show it as positive when a sundial is ahead of a clock; others when the clock is ahead of the sundial. In the English-speaking world, the former usage is the more common, but is not always followed. Anyone who makes use of a published table or graph should first check its sign usage.

Configuration

The plug-ins' configuration data is stored in Stellarium's main configuration file (section [EquationOfTime]).

---

Data Structure Documentation

EquationOfTimeWindow

class EquationOfTimeWindow

Main window of the Equation of Time plug-in.

Public Slots
void	retranslate () override
Public Slots inherited from StelDialog
virtual void	styleChanged (const QString &style)
	Apply application style change.
virtual void	retranslate ()=0
	Retranslate the content of the dialog. More...
virtual void	setVisible (bool)
	On the first call with "true" populates the window contents.
virtual void	close ()
	Closes the window (the window widget is not deleted, just not visible).
void	handleMovedTo (QPoint newPos)
	Adds dialog location to config.ini; should be connected in createDialogContent()
virtual void	handleDialogSizeChanged (QSizeF size)
	Stores dialog sizes into config.ini; should be connected from the proxy. More...
Protected Member Functions
void	createDialogContent () override
	Initialize the dialog widgets and connect the signals/slots.

Additional Inherited Members
Signals inherited from StelDialog
void	visibleChanged (bool)
Public Member Functions inherited from StelDialog
	StelDialog (const QString &dialogName=QString("Default"), QObject *parent=nullptr)
bool	visible () const
	Returns true if the dialog contents have been constructed and are currently shown.
QString	getDialogName () const
Protected Slots inherited from StelDialog
bool	askConfirmation (const QString &message=q_("Are you sure? This will delete your customized data."))
void	messageBox (const QString &title, const QString &message)
void	enableKineticScrolling (bool b)
	enable kinetic scrolling. This should be connected to StelApp's StelGui signal flagUseKineticScrollingChanged.
void	handleFontChanged ()
	connect from StelApp to handle font and font size changes.
void	handleColorSchemeChanged ()
	connect from StelApp to handle CSS style changes
virtual void	updateNightModeProperty (bool n)
Static Protected Member Functions inherited from StelDialog
static void	connectCheckBox (QAbstractButton *checkBox, const QString &actionName)
	Helper function to connect a checkbox to the StelAction with the specified name.
static void	connectCheckBox (QAbstractButton *checkBox, StelAction *action)
	Helper function to connect a checkbox to the given StelAction.
static void	connectIntProperty (QLineEdit *lineEdit, const QString &propName)
	Helper function to connect a QLineEdit to an integer StelProperty. More...
static void	connectIntProperty (QSpinBox *spinBox, const QString &propName)
	Helper function to connect a QSpinBox to an integer StelProperty. More...
static void	connectIntProperty (QComboBox *comboBox, const QString &propName)
	Helper function to connect a QComboBox to an integer StelProperty. More...
static void	connectIntProperty (QSlider *slider, const QString &propName, int minValue, int maxValue)
	Helper function to connect a QSlider to an double or float StelProperty. More...
static void	connectDoubleProperty (QDoubleSpinBox *spinBox, const QString &propName)
	Helper function to connect a QDoubleSpinBox to an double or float StelProperty. More...
static void	connectDoubleProperty (AngleSpinBox *spinBox, const QString &propName)
	Helper function to connect an AngleSpinBox to a double or float StelProperty representing decimal degrees. More...
static void	connectDoubleProperty (QSlider *slider, const QString &propName, double minValue, double maxValue)
	Helper function to connect a QSlider to an double or float StelProperty. More...
static void	connectStringProperty (QComboBox *comboBox, const QString &propName)
	Helper function to connect a QComboBox to a QString StelProperty. More...
static void	connectStringProperty (QLineEdit *lineEdit, const QString &propName)
	Helper function to connect a QLineEdit to a QString StelProperty. More...
static void	connectBoolProperty (QAbstractButton *checkBox, const QString &propName)
	Helper function to connect a checkbox to a bool StelProperty. More...
static void	connectBoolProperty (QGroupBox *checkBox, const QString &propName)
	Helper function to connect a groupbox to a bool StelProperty. More...
Protected Attributes inherited from StelDialog
QWidget *	dialog
	The main dialog.
class CustomProxy *	proxy
QString	dialogName
	The name should be set in derived classes' constructors and can be used to store and retrieve the panel locations.
QList< QWidget * >	kineticScrollingList
	A list of widgets where kinetic scrolling can be activated or deactivated The list must be filled once, in the constructor or init() of fillDialog() etc. More...
Properties inherited from StelDialog
bool	visible

EquationOfTime

class EquationOfTime

Main class of the Equation of Time plugin.

Author

Alexander Wolf

Public Slots
void	enableEquationOfTime (bool b)
	Enable plugin usage.
void	setFlagInvertedValue (bool b)
	Enable usage inverted value for equation of time (switch sign of equation)
void	setFlagMsFormat (bool b)
	Enable usage minutes and seconds for value.
void	setFlagEnableAtStartup (bool b)
	Enable plugin usage at startup.
void	setFontSize (int size)
	Set font size for message.
void	setFlagShowEOTButton (bool b)
	Display plugin button on toolbar.
Vec3f	getTextColor () const
void	setTextColor (const Vec3f &c)
Signals
void	equationOfTimeStateChanged (bool b)
void	textColorChanged (Vec3f)
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	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...
bool	configureGui (bool show) override
	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) const
	Save the settings to the main configuration file.
bool	isEnabled () const
	Is plugin enabled?
int	getFontSize (void) const
	Get font size for messages.
bool	getFlagMsFormat (void) const
	Get status of usage minutes and seconds for value of equation.
bool	getFlagInvertedValue (void) const
	Get status of usage inverted values for equation of time.
bool	getFlagEnableAtStartup (void) const
bool	getFlagShowEOTButton (void) const
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 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...
Properties
bool	showEOT
Vec3f	textColor

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

configureGui()

bool EquationOfTime::configureGui ( bool  show )

overridevirtual

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.

deinit()

void EquationOfTime::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 EquationOfTime::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 EquationOfTime::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 EquationOfTime::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

readSettingsFromConfig()

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

restoreDefaults()

void EquationOfTime::restoreDefaults

(

void

)

Set up the plugin with default values.

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