Stellarium  0.16.0
List of all members | Public Slots | Signals | Public Member Functions | Properties
CompassMarks Class Reference

Main class of the Compass Marks plug-in. More...

#include <CompassMarks.hpp>

+ Inheritance diagram for CompassMarks:
+ Collaboration diagram for CompassMarks:

Public Slots

bool getCompassMarks () const
 Get flag for displaying a ring of marks indicating azimuth on the horizon. More...
 
void setCompassMarks (bool b)
 Define whether a ring of azimuth marks on the horizon should be visible. More...
 

Signals

void compassMarksChanged (bool)
 

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...
 
void loadConfiguration ()
 Load the plug-in's settings from the configuration file. More...
 
void restoreDefaultConfiguration ()
 
- 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...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool marksVisible
 

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 Compass Marks plug-in.

Provides a ring of marks indicating azimuth on the horizon, like a compass dial.

Author
Matthew Gates

Definition at line 43 of file CompassMarks.hpp.

Member Function Documentation

virtual void CompassMarks::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 CompassMarks::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.

bool CompassMarks::getCompassMarks ( ) const
inlineslot

Get flag for displaying a ring of marks indicating azimuth on the horizon.

Definition at line 69 of file CompassMarks.hpp.

virtual void CompassMarks::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void CompassMarks::loadConfiguration ( )

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

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

See also
restoreDefaultSettings()
void CompassMarks::setCompassMarks ( bool  b)
slot

Define whether a ring of azimuth marks on the horizon should be visible.

Parameters
bif true, the ring of azimuth marks is visible, else not
virtual void CompassMarks::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: