Navigational Stars Plug-in

Data Structures
class	NavStars
	Main class of the Navigational Stars plugin. More...

Detailed Description

The Navigational Stars plugin marks the 58 navigational stars of the Nautical Almanach and the 2102-D Rude Star Finder on the sky.

The NavStars class is the main class of the plug-in. It manages the list of navigational stars and manipulate show/hide markers of them. All markers are not objects!

The plugin is also an example of a custom plugin that just marks existing stars.

Configuration

The plug-ins' configuration data is stored in Stellarium's main configuration file (section [NavigationalStars]).

---

Data Structure Documentation

class NavStars

Author

Alexander Wolf

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.
void	setEnableAtStartup (bool b)
bool	getEnableAtStartup (void) const
void	setCurrentNavigationalStarsSet (NavigationalStarsSet nsset)
	Set the set of navigational stars.
NavigationalStarsSet	getCurrentNavigationalStarsSet () const
	Get the set of navigational stars.
QString	getCurrentNavigationalStarsSetKey (void) const
	Get the key of current set of navigational stars.
QString	getCurrentNavigationalStarsSetDescription (void) const
void	setCurrentNavigationalStarsSetKey (QString key)
	Set the set of navigational stars from its key.
Signals
void	navStarsMarksChanged (bool b)
	Emitted when display of markers have been changed.
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.
void	populateNavigationalStarsSet (void)
Public Member Functions inherited from StelModule
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version.
virtual QString	getAuthorName () const
	Get the name of the module author.
virtual QString	getAuthorEmail () const
	Get the email adress of the module author.
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...

Member Enumeration Documentation

enum NavStars::NavigationalStarsSet

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

Member Function Documentation

virtual bool NavStars::configureGui ( bool  show )

virtual

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

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void NavStars::draw ( StelCore *  core )

virtual

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

virtual double NavStars::getCallOrder ( StelModuleActionName  actionName ) const

virtual

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.

virtual void NavStars::init ( )

virtual

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

Implements StelModule.

void NavStars::loadConfiguration

(

void

)

This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).

void NavStars::restoreDefaultConfiguration

(

void

)

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

void NavStars::setNavStarsMarks ( const bool  b )

slot

virtual void NavStars::update ( double  deltaTime )

virtual

Parameters

deltaTime

the time increment in second since last call.

Implements StelModule.