Stellarium 0.14.3
List of all members | Public Types | Public Slots | Signals | Public Member Functions
MeteorShowersMgr Class Reference

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

#include <MeteorShowersMgr.hpp>

Public Types

enum  DownloadStatus { OUTDATED, UPDATING, UPDATED, FAILED }
 

Public Slots

void setEnableAtStartup (const bool &b)
 Enable the meteor showers plugin at Stellarium startup. More...
 
void setShowEnableButton (const bool &show)
 Show/hide the button that enable/disable the meteor showers plugin. More...
 
void setShowSearchButton (const bool &show)
 Show/hide the button that opens the search dialog. More...
 
void setEnableMarker (const bool &b)
 Enable/disable radiant marker. More...
 
void setActiveRadiantOnly (const bool &b)
 True if user wants to see the active radiants only. More...
 
void setEnableLabels (const bool &b)
 Enable/disable radiant labels. More...
 
void setFontSize (int pixelSize)
 Set the font size (used on radiant labels). More...
 
void setUpdateFrequencyHours (const int &hours)
 Set the update frequency in hours. More...
 
void setEnableAutoUpdates (const bool &b)
 Enable/disable automatic catalog updates from the internet. More...
 
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)
 

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...
 
MeteorShowersgetMeteorShowers ()
 Gets the MeteorShowers instance. More...
 
void setEnablePlugin (const bool &b)
 Enable/disable the meteor showers plugin. More...
 
bool getEnablePlugin ()
 
bool getActiveRadiantOnly ()
 True if user wants to see the active radiants only. More...
 
bool getShowEnableButton ()
 Get the status of the enable button on the toolbar. More...
 
bool getShowSearchButton ()
 Get the status of the search button on the toolbar. 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 ()
 
bool getEnableAtStartup ()
 True if the plugin is enabled at Stellarium startup. More...
 
int getFontSize ()
 Set the font size (used on radiant labels). More...
 
QFont getFont ()
 Get the font. More...
 
bool getEnableLabels ()
 Enable/disable radiant labels. More...
 
bool getEnableMarker ()
 Enable/disable radiant marker. More...
 
int getUpdateFrequencyHours ()
 Gets the update frequency in hours. More...
 
bool getEnableAutoUpdates ()
 Enable/disable catalog updates from the internet. 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 ()
 
virtual void deinit ()
 
virtual void update (double deltaTime)
 
virtual void draw (StelCore *core)
 
virtual double getCallOrder (StelModuleActionName actionName) const
 
virtual bool configureGui (bool show=true)
 
virtual QList< StelObjectPsearchAround (const Vec3d &, double, const StelCore *) const
 
virtual StelObjectP searchByNameI18n (const QString &) const
 
virtual StelObjectP searchByName (const QString &) const
 
virtual QStringList listMatchingObjectsI18n (const QString &, int, bool) const
 
virtual QStringList listMatchingObjects (const QString &, int, bool) const
 
virtual QStringList listAllObjects (bool) const
 
virtual QStringList listAllObjectsByType (const QString &, bool) const
 
virtual QString getName () const
 

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 52 of file MeteorShowersMgr.hpp.

Constructor & Destructor Documentation

MeteorShowersMgr::MeteorShowersMgr ( )

Constructor.

virtual MeteorShowersMgr::~MeteorShowersMgr ( )
virtual

Destructor.

Member Function Documentation

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

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

bool MeteorShowersMgr::getActiveRadiantOnly ( )
inline

True if user wants to see the active radiants only.

Definition at line 97 of file MeteorShowersMgr.hpp.

StelTextureSP MeteorShowersMgr::getBolideTexture ( )
inline

Gets the bolide texture.

Returns
texture

Definition at line 78 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableAtStartup ( void  )
inline

True if the plugin is enabled at Stellarium startup.

Definition at line 120 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableAutoUpdates ( )
inline

Enable/disable catalog updates from the internet.

Definition at line 138 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableLabels ( )
inline

Enable/disable radiant labels.

Definition at line 129 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getEnableMarker ( )
inline

Enable/disable radiant marker.

Definition at line 132 of file MeteorShowersMgr.hpp.

QFont MeteorShowersMgr::getFont ( )
inline

Get the font.

Definition at line 126 of file MeteorShowersMgr.hpp.

int MeteorShowersMgr::getFontSize ( void  )
inline

Set the font size (used on radiant labels).

Definition at line 123 of file MeteorShowersMgr.hpp.

MeteorShowers* MeteorShowersMgr::getMeteorShowers ( )
inline

Gets the MeteorShowers instance.

Returns
MeteorShowers instance

Definition at line 90 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 82 of file MeteorShowersMgr.hpp.

StelTextureSP MeteorShowersMgr::getRadiantTexture ( )
inline

Gets the radiant texture.

Returns
texture

Definition at line 86 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getShowEnableButton ( )
inline

Get the status of the enable button on the toolbar.

Returns
true if it's visible

Definition at line 101 of file MeteorShowersMgr.hpp.

bool MeteorShowersMgr::getShowSearchButton ( )
inline

Get the status of the search button on the toolbar.

Returns
true if it's visible

Definition at line 105 of file MeteorShowersMgr.hpp.

int MeteorShowersMgr::getUpdateFrequencyHours ( )
inline

Gets the update frequency in hours.

Definition at line 135 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.

void MeteorShowersMgr::setActiveRadiantOnly ( const bool &  b)
slot

True if user wants to see the active radiants only.

void MeteorShowersMgr::setColorARC ( const Vec3f &  rgb)

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

void MeteorShowersMgr::setColorARG ( const Vec3f &  rgb)

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

void MeteorShowersMgr::setColorIR ( const Vec3f &  rgb)

Set the color of the inactive radiant.

void MeteorShowersMgr::setEnableAtStartup ( const bool &  b)
slot

Enable the meteor showers plugin at Stellarium startup.

void MeteorShowersMgr::setEnableAutoUpdates ( const bool &  b)
slot

Enable/disable automatic catalog updates from the internet.

void MeteorShowersMgr::setEnableLabels ( const bool &  b)
slot

Enable/disable radiant labels.

void MeteorShowersMgr::setEnableMarker ( const bool &  b)
slot

Enable/disable radiant marker.

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

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.

void MeteorShowersMgr::setShowSearchButton ( const bool &  show)
slot

Show/hide the button that opens the search dialog.

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.

void MeteorShowersMgr::setUrl ( const QString &  url)

Set the URL for downloading the meteor showers catalog.

void MeteorShowersMgr::updateCatalog ( )
slot

Download the Meteor Showers catalog from the Internet.


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