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

Public Slots

void enableObservability (bool b)
 Set whether observability will execute or not: More...
 

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, class StelRenderer *renderer)
 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 restoreDefaults (void)
 Set up the plugin with default values. More...
 
void restoreDefaultConfigIni (void)
 
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...
 
void setShow (int output, bool show)
 Set which output is shown. More...
 
void setFontColor (int Color, int Value)
 Set the font colors. Color is (0,1,2) for (R,G,B): More...
 
void setFontSize (int)
 Set the font size: More...
 
void setSunAltitude (int)
 Set the Sun altitude at twilight: More...
 
void setHorizAltitude (int)
 Set the Sun altitude at twilight: 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 getSunAltitude (void)
 get current Sun altitude at twilight: More...
 
int getHorizAltitude (void)
 get current Horizon altitude: More...
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be deleted, and before the renderer is destroyed. More...
 
virtual bool drawPartial (StelCore *core, class StelRenderer *renderer)
 Iterate through the drawing sequence. 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...
 

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

Detailed Description

Definition at line 33 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,
class StelRenderer renderer 
)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing
rendererRenderer to draw with.

Reimplemented from StelModule.

void Observability::enableObservability ( bool  b)
slot

Set whether observability will execute or not:

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

get current Horizon altitude:

bool Observability::getShowFlags ( int  )

get Show Flags from current configuration:

int Observability::getSunAltitude ( void  )

get current Sun altitude at twilight:

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::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 Observability::restoreDefaults ( void  )

Set up the plugin with default values.

void Observability::saveSettingsToConfig ( void  )

Save the settings to the main configuration file.

void Observability::setFontColor ( int  Color,
int  Value 
)

Set the font colors. Color is (0,1,2) for (R,G,B):

void Observability::setFontSize ( int  )

Set the font size:

void Observability::setHorizAltitude ( int  )

Set the Sun altitude at twilight:

void Observability::setShow ( int  output,
bool  show 
)

Set which output is shown.

Parameters
outputis the index of the output (e.g., 1 for today's ephemeris, 5 for Full Moon).
showis a boolean (true to show the output; false to hide it).
void Observability::setSunAltitude ( int  )

Set the Sun altitude at twilight:

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 40 of file Observability.hpp.


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