Stellarium 0.12.3
|
This is an example of a plug-in which can be dynamically loaded into stellarium. More...
#include <Exoplanets.hpp>
Public Types | |
enum | UpdateState { Updating, CompleteNoUpdates, CompleteUpdates, DownloadError, OtherError } |
Used for keeping for track of the download/update status. 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 | setFlagShowExoplanets (bool b) |
bool | getFlagShowExoplanets (void) |
void | setFlagShowExoplanetsButton (bool b) |
Define whether the button toggling exoplanets should be visible. More... | |
bool | getFlagShowExoplanetsButton (void) |
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) |
Signals | |
void | updateStateChanged (Exoplanets::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 deleted, and before the renderer is destroyed. More... | |
virtual void | update (double deltaTime) |
Update the module with respect to the time. More... | |
virtual void | draw (StelCore *core, class StelRenderer *renderer) |
Execute all the drawing functions for this module. More... | |
virtual void | drawPointer (StelCore *core, class StelRenderer *renderer, StelProjectorP projector) |
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 | listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const |
Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name. More... | |
virtual QStringList | listMatchingObjects (const QString &objPrefix, int maxNbItem=5) const |
Find and return the list of at most maxNbItem objects auto-completing the passed object English name. More... | |
virtual QStringList | listAllObjects (bool inEnglish) const |
virtual QString | getName () const |
ExoplanetP | getByID (const QString &id) |
get a exoplanet 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 TLE data from the internet More... | |
void | setUpdatesEnabled (bool b) |
set whether or not the plugin will try to update TLE data from the internet More... | |
bool | getDisplayMode (void) |
void | setDisplayMode (bool b) |
bool | getTimelineMode (void) |
void | setTimelineMode (bool b) |
void | setEnableAtStartup (bool b) |
bool | getEnableAtStartup (void) |
QDateTime | getLastUpdate (void) |
get the date and time the TLE elements were updated More... | |
int | getUpdateFrequencyHours (void) |
get the update frequency in hours More... | |
void | setUpdateFrequencyHours (int hours) |
int | getSecondsToUpdate (void) |
get the number of seconds till the next update More... | |
UpdateState | getUpdateState (void) |
Get the current updateState. More... | |
This is an example of a plug-in which can be dynamically loaded into stellarium.
Definition at line 44 of file Exoplanets.hpp.
Used for keeping for track of the download/update status.
Definition at line 50 of file Exoplanets.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 deleted, and before the renderer is destroyed.
Deinitialize all textures 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 |
renderer | Renderer to draw with. |
Reimplemented from StelModule.
ExoplanetP Exoplanets::getByID | ( | const QString & | id | ) |
get a exoplanet 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 the date and time the TLE elements were updated
Definition at line 140 of file Exoplanets.hpp.
int Exoplanets::getSecondsToUpdate | ( | void | ) |
get the number of seconds till the next update
|
inline |
get the update frequency in hours
Definition at line 143 of file Exoplanets.hpp.
|
inline |
get whether or not the plugin will try to update TLE data from the internet
Definition at line 125 of file Exoplanets.hpp.
|
inline |
Get the current updateState.
Definition at line 150 of file Exoplanets.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 |
Find and return the list of at most maxNbItem objects auto-completing the passed object English name.
objPrefix | the case insensitive first letters of the searched object |
maxNbItem | the maximum number of returned object names |
Implements StelObjectModule.
|
virtual |
Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.
objPrefix | the case insensitive first letters of the searched object |
maxNbItem | the maximum number of returned object names |
Implements StelObjectModule.
void Exoplanets::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 Exoplanets::restoreDefaults | ( | void | ) |
Set up the plugin with default values.
This means clearing out the Exoplanets section in the main config.ini (if one already exists), and populating it with default values. It also creates the default exoplanets.json file from the resource embedded in the plugin lib/dll file.
void Exoplanets::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 exoplanets. |
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.
|
slot |
Define whether the button toggling exoplanets should be visible.
|
inline |
set whether or not the plugin will try to update TLE data from the internet
b | if true, updates will be enabled, else they will be disabled |
Definition at line 128 of file Exoplanets.hpp.
|
virtual |
Update the module with respect to the time.
deltaTime | the time increment in second since last call. |
Implements StelModule.
|
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. |