Main class of the Quasars plugin. More...

#include <Quasars.hpp>

Inheritance diagram for Quasars:

Collaboration diagram for Quasars:

Public Types
enum	UpdateState { Updating, CompleteNoUpdates, CompleteUpdates, DownloadError, OtherError }
	Used for keeping for track of the download/update status. 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	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	setFlagShowQuasars (bool b)
	Enable/disable display of markers of quasars. More...

bool	getFlagShowQuasars (void)
	Get status to display of markers of quasars. More...

void	setFlagShowQuasarsButton (bool b)
	Define whether the button toggling quasars should be visible. More...

bool	getFlagShowQuasarsButton (void)

int	getCountQuasars (void)
	Get count of quasars from catalog. More...

bool	getDisplayMode (void)
	Get status to display of distribution of pulsars. More...

void	setDisplayMode (bool b)
	Enable/disable display of distribution of pulsars. More...

Vec3f	getMarkerColor (void)
	Get color for quasars markers. More...

void	setMarkerColor (const Vec3f &c)
	Set color for quasars markers. More...

Signals
void	updateStateChanged (Quasars::UpdateState state)

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

void	flagQuasarsVisibilityChanged (bool b)

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)
	Update the module with respect to the time. More...

virtual void	draw (StelCore *core)
	Execute all the drawing functions for this module. More...

virtual void	drawPointer (StelCore *core, StelPainter &painter)

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	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...

virtual QStringList	listAllObjects (bool inEnglish) const
	List all StelObjects. More...

virtual QString	getName () const

QuasarP	getByID (const QString &id)
	get a Quasar 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 catalog data from the internet More...

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

void	setEnableAtStartup (bool b)

bool	getEnableAtStartup (void)

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

int	getUpdateFrequencyDays (void)
	get the update frequency in days More...

void	setUpdateFrequencyDays (int days)

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

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

Public Member Functions inherited from StelObjectModule
virtual QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const
	List all StelObjects by type. More...

bool	matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
	Auxiliary method of listMatchingObjects() More...

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	quasarsVisible

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

Author: Alexander Wolf

Definition at line 69 of file Quasars.hpp.

Member Enumeration Documentation

enum Quasars::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 80 of file Quasars.hpp.

Member Function Documentation

virtual bool Quasars::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 Quasars::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 Quasars::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

QuasarP Quasars::getByID ( const QString & id )

get a Quasar object by identifier

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

int Quasars::getCountQuasars ( void )

inlineslot

Get count of quasars from catalog.

Returns: count of quasars

Definition at line 197 of file Quasars.hpp.

bool Quasars::getDisplayMode ( void )

slot

Get status to display of distribution of pulsars.

Returns: true if distribution of pulsars is enabled

bool Quasars::getFlagShowQuasars ( void )

inlineslot

Get status to display of markers of quasars.

Returns: true if it's visible

Definition at line 189 of file Quasars.hpp.

QDateTime Quasars::getLastUpdate ( void )

inline

get the date and time the TLE elements were updated

Definition at line 158 of file Quasars.hpp.

Vec3f Quasars::getMarkerColor ( void )

slot

Get color for quasars markers.

Returns: color

int Quasars::getSecondsToUpdate ( void )

get the number of seconds till the next update

int Quasars::getUpdateFrequencyDays ( void )

inline

get the update frequency in days

Definition at line 161 of file Quasars.hpp.

bool Quasars::getUpdatesEnabled ( void )

inline

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

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

Definition at line 149 of file Quasars.hpp.

UpdateState Quasars::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 168 of file Quasars.hpp.

virtual void Quasars::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void Quasars::jsonUpdateComplete ( void )

signal

emitted after a JSON update has run.

virtual QStringList Quasars::listAllObjects ( bool inEnglish ) const

virtual

List all StelObjects.

Parameters

inEnglish list names in English (true) or translated (false)

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

Implements StelObjectModule.

virtual QStringList Quasars::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`,
		bool	inEnglish = `false`
	)		const

virtual

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

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

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

Reimplemented from StelObjectModule.

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

Set up the plugin with default values.

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

void Quasars::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

virtual QList<StelObjectP> Quasars::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 satellites.
core	the StelCore to use for computations.

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

Implements StelObjectModule.

virtual StelObjectP Quasars::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 Quasars::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 Quasars::setDisplayMode ( bool b )

slot

Enable/disable display of distribution of pulsars.

Parameters

b	(set true for display quasars as markers)

void Quasars::setFlagShowQuasars ( bool b )

slot

Enable/disable display of markers of quasars.

Parameters

b	boolean flag

void Quasars::setFlagShowQuasarsButton ( bool b )

slot

Define whether the button toggling quasars should be visible.

void Quasars::setMarkerColor ( const Vec3f & c )

slot

Set color for quasars markers.

Parameters

c	color // example of usage in scripts Quasars.setMarkerColor(Vec3f(1.0,0.0,0.0));

void Quasars::setUpdatesEnabled ( bool b )

inline

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

Parameters

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

Definition at line 152 of file Quasars.hpp.

virtual void Quasars::update ( double deltaTime )

inlinevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Definition at line 95 of file Quasars.hpp.

void Quasars::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 Quasars::updateStateChanged ( Quasars::UpdateState state )

signal

Parameters

state the new update state.

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

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

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation