Stellarium 0.15.1
List of all members | Public Slots | Signals | Public Member Functions
Observability Class Reference

Main class of the Observability Analysis plug-in. More...

#include <Observability.hpp>

+ Inheritance diagram for Observability:
+ Collaboration diagram for Observability:

Public Slots

void resetConfiguration ()
 Restore and reload the default plug-in settings. More...
 
void saveConfiguration ()
 Save the plug-in's configuration to the main configuration file. More...
 
void setFontColor (const Vec3f &color)
 Set the color of the font used to display the report. More...
 
void setFontSize (int size)
 Set the size of the font used to display the report. More...
 
void setTwilightAltitude (int altitude)
 Set the angular altitude below the horizon of the Sun at twilight. More...
 
void setHorizonAltitude (int altitude)
 Set the angular altitude of the visual horizon. More...
 
void showReport (bool b)
 Controls whether an observability report will be displayed. More...
 

Signals

void flagReportVisibilityChanged (bool b)
 

Public Member Functions

virtual void init ()
 Initialize itself. 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=true)
 Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. More...
 
void loadConfiguration ()
 Read (or re-read) settings from the main config file. More...
 
bool getShowFlags (int)
 get Show Flags from current configuration: More...
 
Vec3f getFontColor (void)
 get the current font color: More...
 
int getFontSize (void)
 get current font size: More...
 
int getTwilightAltitude ()
 Get the user-defined Sun altitude at twilight. More...
 
int getHorizonAltitude ()
 Get the user-defined altitude of the visual horizon. More...
 
bool isShownReport () const
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
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...
 

Fields displayed in the observability report.

void enableTodayField (bool enabled=true)
 Display today's events (rise, set and transit times). More...
 
void enableAcroCosField (bool enabled=true)
 Display acronychal and cosmical rising/setting. More...
 
void enableGoodNightsField (bool enabled=true)
 Display nights when the object is above the horizon after darkness. More...
 
void enableOppositionField (bool enabled=true)
 Display when selected object is in opposition. More...
 
void enableFullMoonField (bool enabled=true)
 Display date of the full moon. More...
 

GUI elements

Parameters for the graphics.

bool flagShowReport
 

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 StelActionaddAction (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 StelActionaddAction (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 Observability Analysis plug-in.

Definition at line 54 of file Observability.hpp.

Member Function Documentation

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

Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.

Reimplemented from StelModule.

virtual void Observability::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

void Observability::enableAcroCosField ( bool  enabled = true)
slot

Display acronychal and cosmical rising/setting.

void Observability::enableFullMoonField ( bool  enabled = true)
slot

Display date of the full moon.

Has any effect only if the Moon is selected.

void Observability::enableGoodNightsField ( bool  enabled = true)
slot

Display nights when the object is above the horizon after darkness.

void Observability::enableOppositionField ( bool  enabled = true)
slot

Display when selected object is in opposition.

void Observability::enableTodayField ( bool  enabled = true)
slot

Display today's events (rise, set and transit times).

virtual double Observability::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
actionNamethe 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.

Vec3f Observability::getFontColor ( void  )

get the current font color:

int Observability::getFontSize ( void  )

get current font size:

int Observability::getHorizonAltitude ( )

Get the user-defined altitude of the visual horizon.

bool Observability::getShowFlags ( int  )

get Show Flags from current configuration:

int Observability::getTwilightAltitude ( )

Get the user-defined Sun altitude at twilight.

Returns
A value in degrees.
virtual void Observability::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void Observability::loadConfiguration ( )

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

Default values are provided for all settings. Called in init() and resetConfiguration().

void Observability::resetConfiguration ( )
slot

Restore and reload the default plug-in settings.

void Observability::saveConfiguration ( )
slot

Save the plug-in's configuration to the main configuration file.

void Observability::setFontColor ( const Vec3f color)
slot

Set the color of the font used to display the report.

Applies only to what is drawn on the viewport.

Parameters
colorColor vector in Stellarium's RGB format.
void Observability::setFontSize ( int  size)
slot

Set the size of the font used to display the report.

Applies only to what is drawn on the viewport.

void Observability::setHorizonAltitude ( int  altitude)
slot

Set the angular altitude of the visual horizon.

Parameters
altitudeAn angle in degrees.
void Observability::setTwilightAltitude ( int  altitude)
slot

Set the angular altitude below the horizon of the Sun at twilight.

This determines the boundaries of day/night for observation purposes.

Parameters
altitudeAn angle in degrees; as this is altitude below the horizon, it should be negative.
Note
If you want the slider in the configuration dialog to be inverted, you can use the invertedAppearance property of QSlider.
void Observability::showReport ( bool  b)
slot

Controls whether an observability report will be displayed.

virtual void Observability::update ( double  deltaTime)
inlinevirtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.

Definition at line 66 of file Observability.hpp.


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