Main class of the Meteor Showers plugin, inherits from StelObjectModule. More...

#include <MeteorShowersMgr.hpp>

Inheritance diagram for MeteorShowersMgr:

Collaboration diagram for MeteorShowersMgr:

Public Types
enum	DownloadStatus { OUTDATED, UPDATING, UPDATED, FAILED }

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	setEnableAtStartup (const bool &b)
	Enable the meteor showers plugin at Stellarium startup. More...

bool	getEnableAtStartup ()
	True if the plugin is enabled at Stellarium startup. More...

void	setShowEnableButton (const bool &show)
	Show/hide the button that enable/disable the meteor showers plugin. More...

bool	getShowEnableButton ()
	Get the status of the enable button on the toolbar. More...

void	setShowSearchButton (const bool &show)
	Show/hide the button that opens the search dialog. More...

bool	getShowSearchButton ()
	Get the status of the search button on the toolbar. More...

void	setEnableMarker (const bool &b)
	Enable/disable radiant marker. More...

bool	getEnableMarker ()
	Enable/disable radiant marker. More...

void	setActiveRadiantOnly (const bool &b)
	True if user wants to see the active radiants only. More...

bool	getActiveRadiantOnly ()
	True if user wants to see the active radiants only. More...

void	setEnableLabels (const bool &b)
	Enable/disable radiant labels. More...

bool	getEnableLabels ()
	Enable/disable radiant labels. More...

void	setFontSize (int pixelSize)
	Set the font size (used on radiant labels). More...

int	getFontSize ()
	Set the font size (used on radiant labels). More...

void	setUpdateFrequencyHours (const int &hours)
	Set the update frequency in hours. More...

int	getUpdateFrequencyHours ()
	Gets the update frequency in hours. More...

void	setEnableAutoUpdates (const bool &b)
	Enable/disable automatic catalog updates from the internet. More...

bool	getEnableAutoUpdates ()
	Enable/disable catalog updates from the internet. More...

void	setColorARG (const Vec3f &rgb)
	Set the color of the active radiant based on generic data. More...

Vec3f	getColorARG ()

void	setColorARC (const Vec3f &rgb)
	Set the color of the active radiant based on confirmed data. More...

Vec3f	getColorARC ()

void	setColorIR (const Vec3f &rgb)
	Set the color of the inactive radiant. More...

Vec3f	getColorIR ()

void	updateCatalog ()
	Download the Meteor Showers catalog from the Internet. More...

void	restoreDefaultSettings ()
	Restore default settings. More...

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

void	messageTimeout ()

Signals
void	downloadStatusChanged (DownloadStatus)

void	enablePluginChanged (bool b)

void	enableLabelsChanged (bool b)

Public Member Functions
	MeteorShowersMgr ()
	Constructor. More...

virtual	~MeteorShowersMgr ()
	Destructor. More...

bool	restoreDefaultCatalog (const QString &destination)
	Restore default catalog. More...

StelTextureSP	getBolideTexture ()
	Gets the bolide texture. More...

StelTextureSP	getPointerTexture ()
	Gets the pointer texture. More...

StelTextureSP	getRadiantTexture ()
	Gets the radiant texture. More...

MeteorShowers *	getMeteorShowers ()
	Gets the MeteorShowers instance. More...

void	setEnablePlugin (const bool &b)
	Enable/disable the meteor showers plugin. More...

bool	getEnablePlugin ()

QFont	getFont ()
	Get the font. More...

void	setUrl (const QString &url)
	Set the URL for downloading the meteor showers catalog. More...

QString	getUrl ()

void	setLastUpdate (const QDateTime &datetime)
	Set the date and time of last update. More...

QDateTime	getLastUpdate ()

void	setStatusOfLastUpdate (const int &downloadStatus)
	Set the status of the last update. More...

DownloadStatus	getStatusOfLastUpdate ()

QDateTime	getNextUpdate ()
	Gets the date of the next update. More...

void	repaint ()
	It's useful to force the update() and draw(). More...

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=true)
	Detect or show the configuration GUI elements for the module. More...

virtual QList< StelObjectP >	searchAround (const Vec3d &, double, const StelCore *) const
	Search for StelObject in an area around a specifid point. More...

virtual StelObjectP	searchByNameI18n (const QString &) const
	Find a StelObject by name. More...

virtual StelObjectP	searchByName (const QString &) const
	Return the matching StelObject if exists or the empty StelObject if not found. More...

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

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

virtual QString	getName () const

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	enablePlugin

bool	enableLabels

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 Meteor Showers plugin, inherits from StelObjectModule.

Author: Marcos Cardinot mcard.nosp@m.inot.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Definition at line 53 of file MeteorShowersMgr.hpp.

Constructor & Destructor Documentation

MeteorShowersMgr::MeteorShowersMgr ( )

Constructor.

virtual MeteorShowersMgr::~MeteorShowersMgr ( )

virtual

Destructor.

Member Function Documentation

virtual bool MeteorShowersMgr::configureGui ( bool show = true )

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

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

slot

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

virtual void MeteorShowersMgr::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

Reimplemented in MeteorShowers.

bool MeteorShowersMgr::getActiveRadiantOnly ( )

inlineslot

True if user wants to see the active radiants only.

Returns: true if only active radiants are visible
// example of usage in scripts
var flag = MeteorShowers.getActiveRadiantOnly();

Definition at line 193 of file MeteorShowersMgr.hpp.

StelTextureSP MeteorShowersMgr::getBolideTexture ( )

inline

Gets the bolide texture.

Returns: texture

Definition at line 79 of file MeteorShowersMgr.hpp.

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

Vec3f MeteorShowersMgr::getColorARC ( )

inlineslot

Returns: color of markers of the active radiants based on confirmed data.
// example of usage in scripts
color = MeteorShowers.getColorARC();

Definition at line 263 of file MeteorShowersMgr.hpp.

Vec3f MeteorShowersMgr::getColorARG ( )

inlineslot

Returns: color of markers of the active radiants based on generic data.
// example of usage in scripts
color = MeteorShowers.getColorARG();

Definition at line 250 of file MeteorShowersMgr.hpp.

Vec3f MeteorShowersMgr::getColorIR ( )

inlineslot

Returns: color of markers of the inactive radiants.
// example of usage in scripts
color = MeteorShowers.getColorIR();

Definition at line 276 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableAtStartup ( void )

inlineslot

True if the plugin is enabled at Stellarium startup.

Returns: true if it's enabled at startup

Definition at line 149 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableAutoUpdates ( )

inlineslot

Enable/disable catalog updates from the internet.

Returns: true if auto updates is enabled

Definition at line 237 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableLabels ( )

inlineslot

Enable/disable radiant labels.

Returns: true if radiant labels visible
// example of usage in scripts
var flag = MeteorShowers.getEnableLabels();

Definition at line 208 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableMarker ( )

inlineslot

Enable/disable radiant marker.

Returns: true if radiant markers visible
// example of usage in scripts
var flag = MeteorShowers.getEnableMarker();

Definition at line 178 of file MeteorShowersMgr.hpp.

QFont MeteorShowersMgr::getFont ( )

inline

Get the font.

Definition at line 98 of file MeteorShowersMgr.hpp.

int MeteorShowersMgr::getFontSize ( void )

inlineslot

Set the font size (used on radiant labels).

Returns: size of font
// example of usage in scripts
var size = MeteorShowers.getFontSize();

Definition at line 223 of file MeteorShowersMgr.hpp.

MeteorShowers* MeteorShowersMgr::getMeteorShowers ( )

inline

Gets the MeteorShowers instance.

Returns: MeteorShowers instance

Definition at line 91 of file MeteorShowersMgr.hpp.

QDateTime MeteorShowersMgr::getNextUpdate ( )

Gets the date of the next update.

StelTextureSP MeteorShowersMgr::getPointerTexture ( )

inline

Gets the pointer texture.

Returns: texture

Definition at line 83 of file MeteorShowersMgr.hpp.

StelTextureSP MeteorShowersMgr::getRadiantTexture ( )

inline

Gets the radiant texture.

Returns: texture

Definition at line 87 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getShowEnableButton ( )

inlineslot

Get the status of the enable button on the toolbar.

Returns: true if it's visible

Definition at line 156 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getShowSearchButton ( )

inlineslot

Get the status of the search button on the toolbar.

Returns: true if it's visible

Definition at line 163 of file MeteorShowersMgr.hpp.

int MeteorShowersMgr::getUpdateFrequencyHours ( )

inlineslot

Gets the update frequency in hours.

Returns: update frequency in hours

Definition at line 230 of file MeteorShowersMgr.hpp.

virtual void MeteorShowersMgr::init ( )

virtual

Initialize itself.

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

Implements StelModule.

virtual QStringList MeteorShowersMgr::listAllObjects ( bool inEnglish ) const

inlinevirtual

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.

Reimplemented in MeteorShowers.

Definition at line 135 of file MeteorShowersMgr.hpp.

virtual QStringList MeteorShowersMgr::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem,
		bool	useStartOfWords,
		bool	inEnglish
	)		const

inlinevirtual

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

Parameters

objPrefix	the first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	decide if start of word is searched
inEnglish	list translated names (false) or in English (true)

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

Reimplemented from StelObjectModule.

Reimplemented in MeteorShowers.

Definition at line 134 of file MeteorShowersMgr.hpp.

void MeteorShowersMgr::repaint ( )

It's useful to force the update() and draw().

bool MeteorShowersMgr::restoreDefaultCatalog ( const QString & destination )

Restore default catalog.

void MeteorShowersMgr::restoreDefaultSettings ( )

slot

Restore default settings.

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

inlinevirtual

Search for StelObject in an area around a specifid point.

The function searches in a disk of diameter limitFov centered on v. Only visible objects (i.e curretly displayed on screen) should be returned.

Parameters

v	equatorial position at epoch J2000.
limitFov	angular diameter of the searching zone in degree.
core	the core instance to use.

Returns: the list of all the displayed objects contained in the defined zone.

Implements StelObjectModule.

Reimplemented in MeteorShowers.

Definition at line 131 of file MeteorShowersMgr.hpp.

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

inlinevirtual

Return the matching StelObject if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

Reimplemented in MeteorShowers.

Definition at line 133 of file MeteorShowersMgr.hpp.

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

inlinevirtual

Find a StelObject by name.

Parameters

nameI18n The translated name for the current sky locale.

Returns: The matching StelObject if exists or the empty StelObject if not found.

Implements StelObjectModule.

Reimplemented in MeteorShowers.

Definition at line 132 of file MeteorShowersMgr.hpp.

void MeteorShowersMgr::setActiveRadiantOnly ( const bool & b )

slot

True if user wants to see the active radiants only.

Parameters

b	boolean flag // example of usage in scripts MeteorShowers.setActiveRadiantOnly(true);

void MeteorShowersMgr::setColorARC ( const Vec3f & rgb )

slot

Set the color of the active radiant based on confirmed data.

// example of usage in scripts

MeteorShowers.setColorARC(Vec3f(1.0,0.0,0.0));

void MeteorShowersMgr::setColorARG ( const Vec3f & rgb )

slot

Set the color of the active radiant based on generic data.

// example of usage in scripts

MeteorShowers.setColorARG(Vec3f(1.0,0.0,0.0));

void MeteorShowersMgr::setColorIR ( const Vec3f & rgb )

slot

Set the color of the inactive radiant.

// example of usage in scripts

MeteorShowers.setColorIR(Vec3f(1.0,0.0,0.0));

void MeteorShowersMgr::setEnableAtStartup ( const bool & b )

slot

Enable the meteor showers plugin at Stellarium startup.

Parameters

b	boolean flag

void MeteorShowersMgr::setEnableAutoUpdates ( const bool & b )

slot

Enable/disable automatic catalog updates from the internet.

Parameters

b	boolean flag

void MeteorShowersMgr::setEnableLabels ( const bool & b )

slot

Enable/disable radiant labels.

Parameters

b	boolean flag // example of usage in scripts MeteorShowers.setEnableLabels(true);

void MeteorShowersMgr::setEnableMarker ( const bool & b )

slot

Enable/disable radiant marker.

Parameters

b	boolean flag // example of usage in scripts MeteorShowers.setEnableMarker(true);

void MeteorShowersMgr::setEnablePlugin ( const bool & b )

Enable/disable the meteor showers plugin.

void MeteorShowersMgr::setFontSize ( int pixelSize )

slot

Set the font size (used on radiant labels).

Parameters

pixelSize

size of font

// example of usage in scripts

MeteorShowers.setFontSize(15);

void MeteorShowersMgr::setLastUpdate ( const QDateTime & datetime )

Set the date and time of last update.

void MeteorShowersMgr::setShowEnableButton ( const bool & show )

slot

Show/hide the button that enable/disable the meteor showers plugin.

Parameters

b	boolean flag

void MeteorShowersMgr::setShowSearchButton ( const bool & show )

slot

Show/hide the button that opens the search dialog.

Parameters

b	boolean flag

void MeteorShowersMgr::setStatusOfLastUpdate ( const int & downloadStatus )

Set the status of the last update.

void MeteorShowersMgr::setUpdateFrequencyHours ( const int & hours )

slot

Set the update frequency in hours.

Parameters

hours update frequency in hours

void MeteorShowersMgr::setUrl ( const QString & url )

Set the URL for downloading the meteor showers catalog.

virtual void MeteorShowersMgr::update ( double deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Reimplemented in MeteorShowers.

void MeteorShowersMgr::updateCatalog ( )

slot

Download the Meteor Showers catalog from the Internet.

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

/home/aw/devel/stellarium/0.15/plugins/MeteorShowers/src/MeteorShowersMgr.hpp

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation