This is an example of a plug-in which can be dynamically loaded into stellarium. More...

#include <Exoplanets.hpp>

Public Types
enum	UpdateState { Updating, CompleteNoUpdates, CompleteUpdates, DownloadError, OtherError }
	Used for keeping for track of the download/update status. More...

Public Slots
void	updateJSON (void)
	Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. More...

void	setFlagShowExoplanets (bool b)

bool	getFlagShowExoplanets (void)

void	setFlagShowExoplanetsButton (bool b)
	Define whether the button toggling exoplanets should be visible. More...

bool	getFlagShowExoplanetsButton (void)

void	displayMessage (const QString &message, const QString hexColor="#999999")
	Display a message. This is used for plugin-specific warnings and such. More...

void	messageTimeout (void)

Signals
void	updateStateChanged (Exoplanets::UpdateState state)

void	jsonUpdateComplete (void)
	emitted after a JSON update has run. More...

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

virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...

virtual void	update (double deltaTime)
	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 void	drawPointer (StelCore core, class StelRenderer renderer, StelProjectorP projector)

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 QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Used to get a list of objects which are near to some position. More...

virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Return the matching satellite object's pointer if exists or NULL. More...

virtual StelObjectP	searchByName (const QString &name) const
	Return the matching satellite if exists or NULL. More...

virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name. More...

virtual QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object English name. More...

virtual QStringList	listAllObjects (bool inEnglish) const

virtual QString	getName () const

ExoplanetP	getByID (const QString &id)
	get a exoplanet object by identifier 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	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...

bool	getUpdatesEnabled (void)
	get whether or not the plugin will try to update TLE data from the internet More...

void	setUpdatesEnabled (bool b)
	set whether or not the plugin will try to update TLE data from the internet More...

bool	getDisplayMode (void)

void	setDisplayMode (bool b)

bool	getTimelineMode (void)

void	setTimelineMode (bool b)

void	setEnableAtStartup (bool b)

bool	getEnableAtStartup (void)

QDateTime	getLastUpdate (void)
	get the date and time the TLE elements were updated More...

int	getUpdateFrequencyHours (void)
	get the update frequency in hours More...

void	setUpdateFrequencyHours (int hours)

int	getSecondsToUpdate (void)
	get the number of seconds till the next update More...

UpdateState	getUpdateState (void)
	Get the current updateState. More...

Detailed Description

This is an example of a plug-in which can be dynamically loaded into stellarium.

Definition at line 44 of file Exoplanets.hpp.

Member Enumeration Documentation

enum Exoplanets::UpdateState

Used for keeping for track of the download/update status.

Enumerator
Updating	Update in progress.
CompleteNoUpdates	Update completed, there we no updates.
CompleteUpdates	Update completed, there were updates.
DownloadError	Error during download phase.
OtherError	Other error.

Definition at line 50 of file Exoplanets.hpp.

Member Function Documentation

virtual bool Exoplanets::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 Exoplanets::deinit ( )

virtual

Called before the module will be deleted, and before the renderer is destroyed.

Deinitialize all textures in this method.

Reimplemented from StelModule.

void Exoplanets::displayMessage	(	const QString &	message,
		const QString	hexColor = `"#999999"`
	)

slot

Display a message. This is used for plugin-specific warnings and such.

virtual void Exoplanets::draw	(	StelCore *	core,
		class StelRenderer *	renderer
	)

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing
renderer	Renderer to draw with.

Reimplemented from StelModule.

ExoplanetP Exoplanets::getByID ( const QString & id )

get a exoplanet object by identifier

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

QDateTime Exoplanets::getLastUpdate ( void )

inline

get the date and time the TLE elements were updated

Definition at line 140 of file Exoplanets.hpp.

int Exoplanets::getSecondsToUpdate ( void )

get the number of seconds till the next update

int Exoplanets::getUpdateFrequencyHours ( void )

inline

get the update frequency in hours

Definition at line 143 of file Exoplanets.hpp.

bool Exoplanets::getUpdatesEnabled ( void )

inline

get whether or not the plugin will try to update TLE data from the internet

Returns: true if updates are set to be done, false otherwise

Definition at line 125 of file Exoplanets.hpp.

UpdateState Exoplanets::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 150 of file Exoplanets.hpp.

virtual void Exoplanets::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void Exoplanets::jsonUpdateComplete ( void )

signal

emitted after a JSON update has run.

virtual QStringList Exoplanets::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object English name.

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names

Returns: a list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

virtual QStringList Exoplanets::listMatchingObjectsI18n	(	const QString &	objPrefix,
		int	maxNbItem = `5`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names

Returns: a list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

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

Set up the plugin with default values.

This means clearing out the Exoplanets section in the main config.ini (if one already exists), and populating it with default values. It also creates the default exoplanets.json file from the resource embedded in the plugin lib/dll file.

void Exoplanets::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

virtual QList<StelObjectP> Exoplanets::searchAround	(	const Vec3d &	v,
		double	limitFov,
		const StelCore *	core
	)		const

virtual

Used to get a list of objects which are near to some position.

Parameters

v	a vector representing the position in th sky around which to search for nebulae.
limitFov	the field of view around the position v in which to search for exoplanets.
core	the StelCore to use for computations.

Returns: an list containing the exoplanets located inside the limitFov circle around position v.

Implements StelObjectModule.

virtual StelObjectP Exoplanets::searchByName ( const QString & name ) const

virtual

Return the matching satellite if exists or NULL.

Parameters

name	The case in-sensistive standard program name

Implements StelObjectModule.

virtual StelObjectP Exoplanets::searchByNameI18n ( const QString & nameI18n ) const

virtual

Return the matching satellite object's pointer if exists or NULL.

Parameters

nameI18n The case in-sensistive satellite name

Implements StelObjectModule.

void Exoplanets::setFlagShowExoplanetsButton ( bool b )

slot

Define whether the button toggling exoplanets should be visible.

void Exoplanets::setUpdatesEnabled ( bool b )

inline

set whether or not the plugin will try to update TLE data from the internet

Parameters

b	if true, updates will be enabled, else they will be disabled

Definition at line 128 of file Exoplanets.hpp.

virtual void Exoplanets::update ( double deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

void Exoplanets::updateJSON ( void )

slot

Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.

void Exoplanets::updateStateChanged ( Exoplanets::UpdateState state )

signal

Parameters

state the new update state.

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

/home/aw/devel/stellarium/trunk/plugins/Exoplanets/src/Exoplanets.hpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation