Main class of the Navigational Stars plugin. More...

#include <NavStars.hpp>

Inheritance diagram for NavStars:

Collaboration diagram for NavStars:

Public Types
enum	NavigationalStarsSet { AngloAmerican, French, Russian }
	Available sets of navigational stars. More...

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

Public Slots
void	setNavStarsMarks (const bool b)
	Set flag of displaying markers of the navigational stars Emits navStarsMarksChanged() if the value changes. More...

bool	getNavStarsMarks (void) const
	Get flag of displaying markers of the navigational stars. More...

void	setCurrentNavigationalStarsSet (NavigationalStarsSet nsset)
	Set the set of navigational stars. More...

NavigationalStarsSet	getCurrentNavigationalStarsSet () const
	Get the set of navigational stars. More...

QString	getCurrentNavigationalStarsSetKey (void) const
	Get the key of current set of navigational stars. More...

QString	getCurrentNavigationalStarsSetDescription (void) const

void	setCurrentNavigationalStarsSetKey (QString key)
	Set the set of navigational stars from its key. More...

Signals
void	navStarsMarksChanged (bool b)
	Emitted when display of markers have been changed. More...

Public Member Functions
virtual void	init ()
	Initialize itself. More...

virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. 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 bool	configureGui (bool show)
	Detect or show the configuration GUI elements for the module. More...

void	restoreDefaultConfiguration (void)
	Set up the plugin with default values. More...

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

void	saveConfiguration (void)
	Save the settings to the main configuration file. More...

void	populateNavigationalStarsSet (void)

Public Member Functions inherited from StelModule
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...

Properties
bool	navStarsVisible

Additional Inherited Members
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...

Detailed Description

Main class of the Navigational Stars plugin.

Author: Alexander Wolf

Definition at line 58 of file NavStars.hpp.

Member Enumeration Documentation

enum NavStars::NavigationalStarsSet

Available sets of navigational stars.

Enumerator
AngloAmerican	Anglo-American set (The Nautical Almanach)
French	French set (Ephémérides Nautiques)
Russian	Russian set (Морской астрономический ежегодник)

Definition at line 69 of file NavStars.hpp.

Member Function Documentation

virtual bool NavStars::configureGui ( bool show )

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

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.

virtual void NavStars::deinit ( )

virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void NavStars::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

virtual double NavStars::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

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.

NavigationalStarsSet NavStars::getCurrentNavigationalStarsSet ( ) const

inlineslot

Get the set of navigational stars.

Definition at line 114 of file NavStars.hpp.

QString NavStars::getCurrentNavigationalStarsSetKey ( void ) const

slot

Get the key of current set of navigational stars.

bool NavStars::getNavStarsMarks ( void ) const

slot

Get flag of displaying markers of the navigational stars.

virtual void NavStars::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void NavStars::loadConfiguration ( 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 NavStars::navStarsMarksChanged ( bool b )

signal

Emitted when display of markers have been changed.

void NavStars::restoreDefaultConfiguration ( void )

Set up the plugin with default values.

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

void NavStars::saveConfiguration ( void )

Save the settings to the main configuration file.

void NavStars::setCurrentNavigationalStarsSet ( NavigationalStarsSet nsset )

inlineslot

Set the set of navigational stars.

Definition at line 109 of file NavStars.hpp.

void NavStars::setCurrentNavigationalStarsSetKey ( QString key )

slot

Set the set of navigational stars from its key.

void NavStars::setNavStarsMarks ( const bool b )

slot

Set flag of displaying markers of the navigational stars Emits navStarsMarksChanged() if the value changes.

virtual void NavStars::update ( double deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

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

/home/aw/devel/stellarium/0.15/plugins/NavStars/src/NavStars.hpp

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation