Stellarium 0.15.2
|
Main class of the Historical Supernovae plugin. More...
#include <Supernovae.hpp>
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< StelObjectP > | searchAround (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 NULL. More... | |
virtual StelObjectP | searchByName (const QString &name) const |
Return the matching satellite if exists or NULL. More... | |
virtual QStringList | listAllObjects (bool inEnglish) const |
List all StelObjects. More... | |
virtual QString | getName () const |
SupernovaP | getByID (const QString &id) |
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 () |
Get list of supernovae. More... | |
float | getLowerLimitBrightness () |
Get lower limit of brightness for displayed supernovae. More... | |
int | getCountSupernovae (void) |
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 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... | |
Main class of the Historical Supernovae plugin.
Definition at line 68 of file Supernovae.hpp.
Used for keeping for track of the download/update status.
Definition at line 74 of file Supernovae.hpp.
|
virtual |
Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.
Reimplemented from StelModule.
|
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.
|
slot |
Display a message. This is used for plugin-specific warnings and such.
|
virtual |
Execute all the drawing functions for this module.
core | the core to use for the drawing |
Reimplemented from StelModule.
SupernovaP Supernovae::getByID | ( | const QString & | id | ) |
get a supernova object by identifier
|
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.
actionName | the name of the action for which we want the call order |
Reimplemented from StelModule.
|
inline |
Get count of supernovae from catalog.
Definition at line 161 of file Supernovae.hpp.
|
inline |
Get the date and time the supernovae were updated.
Definition at line 142 of file Supernovae.hpp.
float Supernovae::getLowerLimitBrightness | ( | ) |
Get lower limit of brightness for displayed supernovae.
int Supernovae::getSecondsToUpdate | ( | void | ) |
Get the number of seconds till the next update.
QString Supernovae::getSupernovaeList | ( | ) |
Get list of supernovae.
|
inline |
Get the update frequency in days.
Definition at line 145 of file Supernovae.hpp.
|
inline |
Get whether or not the plugin will try to update catalog data from the internet.
Definition at line 136 of file Supernovae.hpp.
|
inline |
Get the current updateState.
Definition at line 152 of file Supernovae.hpp.
|
virtual |
Initialize itself.
If the initialization takes significant time, the progress should be displayed on the loading bar.
Implements StelModule.
|
signal |
Emitted after a JSON update has run.
|
virtual |
List all StelObjects.
inEnglish | list names in English (true) or translated (false) |
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 |
Used to get a list of objects which are near to some position.
v | a vector representing the position in th sky around which to search for nebulae. |
limitFov | the field of view around the position v in which to search for satellites. |
core | the StelCore to use for computations. |
Implements StelObjectModule.
|
virtual |
Return the matching satellite if exists or NULL.
name | The case in-sensistive standard program name |
Implements StelObjectModule.
|
virtual |
Return the matching satellite object's pointer if exists or NULL.
nameI18n | The case in-sensistive satellite name |
Implements StelObjectModule.
|
inline |
Set whether or not the plugin will try to update catalog data from the internet.
b | if true, updates will be enabled, else they will be disabled |
Definition at line 139 of file Supernovae.hpp.
|
inlinevirtual |
Update the module with respect to the time.
deltaTime | the time increment in second since last call. |
Implements StelModule.
Definition at line 89 of file Supernovae.hpp.
|
slot |
Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.
|
signal |
state | the new update state. |