Stellarium  0.90.0
List of all members | Public Types | Public Slots | Signals | Public Member Functions
Supernovae Class Reference

Main class of the Historical Supernovae plugin. More...

#include <Supernovae.hpp>

+ Inheritance diagram for Supernovae:
+ Collaboration diagram for Supernovae:

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 displayMessage (const QString &message, const QString hexColor="#999999")
 Display a message. This is used for plugin-specific warnings and such. More...
 
void messageTimeout (void)
 
void reloadCatalog (void)
 

Signals

void updateStateChanged (Supernovae::UpdateState state)
 
void jsonUpdateComplete (void)
 Emitted after a JSON update has run. More...
 

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< StelObjectPsearchAround (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 Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching satellite if exists or Q_NULLPTR. 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 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...
 
SupernovaP getByID (const QString &id) const
 get a supernova 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...
 
QDateTime getLastUpdate (void)
 Get the date and time the supernovae 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...
 
QString getSupernovaeList () const
 Get list of supernovae. More...
 
float getLowerLimitBrightness () const
 Get lower limit of brightness for displayed supernovae. More...
 
int getCountSupernovae (void) const
 Get count of supernovae from catalog. More...
 
- Public Member Functions inherited from StelObjectModule
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 passed object name. More...
 
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

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

Detailed Description

Main class of the Historical Supernovae plugin.

Author
Alexander Wolf

Definition at line 68 of file Supernovae.hpp.

Member Enumeration Documentation

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 74 of file Supernovae.hpp.

Member Function Documentation

virtual bool Supernovae::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 Supernovae::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 Supernovae::displayMessage ( const QString &  message,
const QString  hexColor = "#999999" 
)
slot

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

virtual void Supernovae::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

SupernovaP Supernovae::getByID ( const QString &  id) const

get a supernova object by identifier

virtual double Supernovae::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
actionNamethe 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 Supernovae::getCountSupernovae ( void  ) const
inline

Get count of supernovae from catalog.

Definition at line 167 of file Supernovae.hpp.

QDateTime Supernovae::getLastUpdate ( void  )
inline

Get the date and time the supernovae were updated.

Definition at line 148 of file Supernovae.hpp.

float Supernovae::getLowerLimitBrightness ( ) const

Get lower limit of brightness for displayed supernovae.

virtual QString Supernovae::getName ( ) const
inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 118 of file Supernovae.hpp.

int Supernovae::getSecondsToUpdate ( void  )

Get the number of seconds till the next update.

virtual QString Supernovae::getStelObjectType ( ) const
inlinevirtual

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

Implements StelObjectModule.

Definition at line 119 of file Supernovae.hpp.

QString Supernovae::getSupernovaeList ( ) const

Get list of supernovae.

int Supernovae::getUpdateFrequencyDays ( void  )
inline

Get the update frequency in days.

Definition at line 151 of file Supernovae.hpp.

bool Supernovae::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 142 of file Supernovae.hpp.

UpdateState Supernovae::getUpdateState ( void  )
inline

Get the current updateState.

Definition at line 158 of file Supernovae.hpp.

virtual void Supernovae::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void Supernovae::jsonUpdateComplete ( void  )
signal

Emitted after a JSON update has run.

virtual QStringList Supernovae::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

Implements StelObjectModule.

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

Set up the plugin with default values.

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

void Supernovae::saveSettingsToConfig ( void  )

Save the settings to the main configuration file.

virtual QList<StelObjectP> Supernovae::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
va vector representing the position in th sky around which to search for nebulae.
limitFovthe field of view around the position v in which to search for satellites.
corethe StelCore to use for computations.
Returns
an list containing the satellites located inside the limitFov circle around position v.

Implements StelObjectModule.

virtual StelObjectP Supernovae::searchByID ( const QString &  id) const
inlinevirtual

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

Parameters
namethe english object name

Implements StelObjectModule.

Definition at line 111 of file Supernovae.hpp.

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

Return the matching satellite if exists or Q_NULLPTR.

Parameters
nameThe case in-sensistive standard program name

Implements StelObjectModule.

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

Return the matching satellite object's pointer if exists or Q_NULLPTR.

Parameters
nameI18nThe case in-sensistive satellite name

Implements StelObjectModule.

void Supernovae::setUpdatesEnabled ( bool  b)
inline

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

Parameters
bif true, updates will be enabled, else they will be disabled

Definition at line 145 of file Supernovae.hpp.

virtual void Supernovae::update ( double  deltaTime)
inlinevirtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.

Definition at line 89 of file Supernovae.hpp.

void Supernovae::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 Supernovae::updateStateChanged ( Supernovae::UpdateState  state)
signal
Parameters
statethe new update state.

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