Stellarium 0.15.1
List of all members | Classes | Public Member Functions
MeteorShowers Class Reference

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 ~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< SearchResultsearchEvents (QDate dateFrom, QDate dateTo) const
 Find all meteor_shower events in a given date interval. More...
 
virtual QList< StelObjectPsearchAround (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 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
 
- Public Member Functions inherited from MeteorShowersMgr
 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...
 
MeteorShowersgetMeteorShowers ()
 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 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...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from MeteorShowersMgr
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 inherited from MeteorShowersMgr
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 inherited from MeteorShowersMgr
void downloadStatusChanged (DownloadStatus)
 
void enablePluginChanged (bool b)
 
void enableLabelsChanged (bool b)
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (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 StelActionaddAction (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...
 
- Properties inherited from MeteorShowersMgr
bool enablePlugin
 
bool enableLabels
 

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

virtual QStringList MeteorShowers::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

Parameters
inEnglishlist 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

Reimplemented from MeteorShowersMgr.

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
objPrefixthe first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsdecide if start of word is searched
inEnglishlist 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 MeteorShowersMgr.

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
vequatorial position at epoch J2000.
limitFovangular diameter of the searching zone in degree.
corethe core instance to use.
Returns
the list of all the displayed objects contained in the defined zone.

Reimplemented from MeteorShowersMgr.

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

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

Parameters
namethe english object name

Reimplemented from MeteorShowersMgr.

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

Find a StelObject by name.

Parameters
nameI18nThe translated name for the current sky locale.
Returns
The matching StelObject if exists or the empty StelObject if not found.

Reimplemented from MeteorShowersMgr.

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
deltaTimethe time increment in seconds since the last call.

Reimplemented from MeteorShowersMgr.


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