Stellarium  0.90.0
List of all members | Public Slots | Signals | Public Member Functions | Properties
AngleMeasure Class Reference

Main class of the Angle Measure plug-in. More...

#include <AngleMeasure.hpp>

+ Inheritance diagram for AngleMeasure:
+ Collaboration diagram for AngleMeasure:

Public Slots

void enableAngleMeasure (bool b)
 
void useDmsFormat (bool b)
 
void showPositionAngle (bool b)
 
void showPositionAngleHor (bool b)
 
void showEquatorial (bool b)
 
void showHorizontal (bool b)
 
void showHorizontalStartSkylinked (bool b)
 
void showHorizontalEndSkylinked (bool b)
 

Signals

void flagAngleMeasureChanged (bool b)
 

Public Member Functions

virtual void init ()
 Initialize itself. More...
 
virtual void update (double deltaTime)
 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 void handleKeys (class QKeyEvent *event)
 Handle key events. More...
 
virtual void handleMouseClicks (class QMouseEvent *event)
 Handle mouse clicks. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 
bool isEnabled () const
 
bool isDmsFormat () const
 
bool isPaDisplayed () const
 
bool isEquatorial () const
 
bool isHorizontal () const
 
bool isHorizontalStartSkylinked () const
 
bool isHorizontalEndSkylinked () const
 
bool isHorPaDisplayed () const
 
void restoreDefaultSettings ()
 Restore the plug-in's settings to the default state. More...
 
void loadSettings ()
 Load the plug-in's settings from the configuration file. More...
 
- 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 handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 

Properties

bool enabled
 
bool dmsFormat
 
bool paDisplayed
 

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 Angle Measure plug-in.

Author
Matthew Gates
Alexander Wolf
Georg Zotti

Definition at line 70 of file AngleMeasure.hpp.

Member Function Documentation

virtual bool AngleMeasure::configureGui ( bool  show = true)
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
showif 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 AngleMeasure::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

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

virtual void AngleMeasure::handleKeys ( class QKeyEvent *  e)
virtual

Handle key events.

Please note that most of the interactions will be done through the GUI module.

Parameters
ethe Key event
Returns
set the event as accepted if it was intercepted

Reimplemented from StelModule.

virtual void AngleMeasure::handleMouseClicks ( class QMouseEvent *  )
virtual

Handle mouse clicks.

Please note that most of the interactions will be done through the GUI module.

Returns
set the event as accepted if it was intercepted

Reimplemented from StelModule.

virtual bool AngleMeasure::handleMouseMoves ( int  x,
int  y,
Qt::MouseButtons  b 
)
virtual

Handle mouse moves.

Please note that most of the interactions will be done through the GUI module.

Returns
true if the event was intercepted

Reimplemented from StelModule.

virtual void AngleMeasure::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void AngleMeasure::loadSettings ( )

Load the plug-in's settings from the configuration file.

Settings are kept in the "AngleMeasure" section in Stellarium's configuration file. If no such section exists, it will load default values.

See also
saveSettings(), restoreSettings()
void AngleMeasure::restoreDefaultSettings ( )

Restore the plug-in's settings to the default state.

Replace the plug-in's settings in Stellarium's configuration file with the default values and re-load them. Uses internally loadSettings() and saveSettings().

virtual void AngleMeasure::update ( double  deltaTime)
virtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.


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