This class manages a collection of MeteorShower objects. More...

#include <MeteorShowers.hpp>

Inheritance diagram for MeteorShowers:

Collaboration diagram for MeteorShowers:

Classes
struct	SearchResult

Public Member Functions
	MeteorShowers (MeteorShowersMgr *mgr)
	Constructor. More...

virtual void	init (void)
	Initialize itself. More...

virtual	~MeteorShowers ()
	Destructor. More...

virtual void	update (double deltaTime)
	Update. More...

virtual void	draw (StelCore *core)
	Draw. More...

void	loadMeteorShowers (const QVariantMap &map)
	Loads all meteor showers contained in a QVariantMap. More...

QList< SearchResult >	searchEvents (QDate dateFrom, QDate dateTo) const
	Find all meteor_shower events in a given date interval. More...

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

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

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

virtual StelObjectP	searchByID (const QString &id) const
	Return the StelObject with the given ID if exists or the empty StelObject if not found. More...

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

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

virtual QString	getName () const
	Gets a user-displayable name of the object category. More...

virtual QString	getStelObjectType () const
	Returns the name that will be returned by StelObject::getType() for the objects this module manages. 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 void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...

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

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

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

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

This class manages a collection of MeteorShower objects.

It inherits from MeteorShowersMgr and is basically used to reimplement the methods defined in the StelObjectModule class.

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

Definition at line 34 of file MeteorShowers.hpp.

Constructor & Destructor Documentation

MeteorShowers::MeteorShowers ( MeteorShowersMgr * mgr )

Constructor.

virtual MeteorShowers::~MeteorShowers ( )

virtual

Destructor.

Member Function Documentation

virtual void MeteorShowers::draw ( StelCore * core )

virtual

Draw.

Reimplemented from StelModule.

virtual QString MeteorShowers::getName ( ) const

inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 81 of file MeteorShowers.hpp.

virtual QString MeteorShowers::getStelObjectType ( ) const

inlinevirtual

Returns the name that will be returned by StelObject::getType() for the objects this module manages.

Implements StelObjectModule.

Definition at line 82 of file MeteorShowers.hpp.

virtual void MeteorShowers::init ( void )

inlinevirtual

Initialize itself.

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

Implements StelModule.

Definition at line 50 of file MeteorShowers.hpp.

virtual QStringList MeteorShowers::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 MeteorShowers::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`,
		bool	inEnglish = `true`
	)		const

virtual

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.

void MeteorShowers::loadMeteorShowers ( const QVariantMap & map )

Loads all meteor showers contained in a QVariantMap.

Parameters

map

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

virtual

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.

virtual StelObjectP MeteorShowers::searchByID ( const QString & id ) const

virtual

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

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

virtual

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

Parameters

name	the english object name

Implements StelObjectModule.

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

virtual

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.

QList<SearchResult> MeteorShowers::searchEvents	(	QDate	dateFrom,
		QDate	dateTo
	)		const

Find all meteor_shower events in a given date interval.

Parameters

dateFrom
dateTo

Returns: list

virtual void MeteorShowers::update ( double deltaTime )

virtual

Update.

Parameters

deltaTime the time increment in seconds since the last call.

Implements StelModule.

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

/home/aw/devel/stellarium/0.16/plugins/MeteorShowers/src/MeteorShowers.hpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation