Stellarium
0.17.0
|
Data Structures | |
struct | exoplanetData |
class | ExoplanetsDialog |
Main window of the Exoplanets plugin. More... | |
class | Exoplanet |
A exoplanet object represents one planetary system on the sky. More... | |
class | Exoplanets |
Main class of the Exoplanets plugin. More... | |
Typedefs | |
typedef QSharedPointer< Exoplanet > | ExoplanetP |
The Exoplanets plugin plots the position of stars with exoplanets. Exoplanets data is derived from The Extrasolar Planets Encyclopaedia. List of potential habitable exoplanets and data about them were taken from The Habitable Exoplanets Catalog by Planetary Habitability Laboratory.
Exoplanets Catalog
The exoplanets catalog is stored on the disk in JSON format, in a file named "exoplanets.json". A default copy is embedded in the plug-in at compile time. A working copy is kept in the user data directory.
Configuration
The plug-ins' configuration data is stored in Stellarium's main configuration file (section [Exoplanets]).
struct exoplanetData |
Data Fields | ||
---|---|---|
float | angleDistance | Exoplanet orbit inclination. |
bool | conservative | Method of detection of exoplanet. |
QString | detectionMethod | Exoplanet Earth Similarity Index. |
int | discovered | Exoplanet angle distance. |
float | eccentricity | Exoplanet orbit semi-major axis (AU) |
int | EqTemp | Exoplanet classification from host star spectral type (F, G, K, M), habitable zone (hot, warm, cold) and size (miniterran, subterran, terran, superterran, jovian, neptunian) |
int | ESI | Average stellar flux of the planet in Earth fluxes (Earth = 1.0 SE). |
int | flux | Exoplanet equilibrium temperature in kelvins (K) assuming a 0.3 bond albedo (Earth = 255 K). |
float | inclination | Exoplanet orbit eccentricity. |
float | mass | Exoplanet proper name. |
QString | pclass | Exoplanet discovered year. |
float | period | Exoplanet radius (Rjup) |
QString | planetName | |
QString | planetProperName | Exoplanet designation. |
float | radius | Exoplanet mass (Mjup) |
float | semiAxis | Exoplanet period (days) |
class ExoplanetsDialog |
Public Slots | |
void | retranslate () |
void | refreshUpdateValues (void) |
Public Slots inherited from StelDialog | |
virtual void | retranslate ()=0 |
Retranslate the content of the dialog. More... | |
void | setVisible (bool) |
On the first call with "true" populates the window contents. | |
void | close () |
Closes the window (the window widget is not deleted, just not visible). | |
void | handleMovedTo (QPoint newPos) |
Adds dialog location to config.ini; should be connected in createDialogContent() | |
virtual void | handleDialogSizeChanged (QSizeF size) |
Stores dialog sizes into config.ini; should be connected from the proxy. More... | |
QString | getDialogName () |
Protected Member Functions | |
void | createDialogContent () |
Initialize the dialog widgets and connect the signals/slots. | |
Additional Inherited Members | |
Signals inherited from StelDialog | |
void | visibleChanged (bool) |
Public Member Functions inherited from StelDialog | |
StelDialog (QString dialogName="Default", QObject *parent=Q_NULLPTR) | |
bool | visible () const |
Returns true if the dialog contents have been constructed and are currently shown. | |
Static Protected Member Functions inherited from StelDialog | |
static void | connectCheckBox (QAbstractButton *checkBox, const QString &actionName) |
Helper function to connect a checkbox to the StelAction with the specified name. | |
static void | connectCheckBox (QAbstractButton *checkBox, StelAction *action) |
Helper function to connect a checkbox to the given StelAction. | |
static void | connectIntProperty (QSpinBox *spinBox, const QString &propName) |
Helper function to connect a QSpinBox to an integer StelProperty. More... | |
static void | connectIntProperty (QComboBox *comboBox, const QString &propName) |
Helper function to connect a QComboBox to an integer StelProperty. More... | |
static void | connectIntProperty (QSlider *slider, const QString &propName, int minValue, int maxValue) |
Helper function to connect a QSlider to an double or float StelProperty. More... | |
static void | connectDoubleProperty (QDoubleSpinBox *spinBox, const QString &propName) |
Helper function to connect a QDoubleSpinBox to an double or float StelProperty. More... | |
static void | connectDoubleProperty (QSlider *slider, const QString &propName, double minValue, double maxValue) |
Helper function to connect a QSlider to an double or float StelProperty. More... | |
static void | connectBoolProperty (QAbstractButton *checkBox, const QString &propName) |
Helper function to connect a checkbox to a bool StelProperty. More... | |
Protected Attributes inherited from StelDialog | |
QWidget * | dialog |
The main dialog. | |
class CustomProxy * | proxy |
QString | dialogName |
The name should be set in derived classes' constructors and can be used to store and retrieve the panel locations. | |
Properties inherited from StelDialog | |
bool | visible |
class Exoplanet |
Details about the exoplanets are passed using a QVariant which contains a map of data from the json file.
Public Member Functions | |
Exoplanet (const QVariantMap &map) | |
QVariantMap | getMap (void) const |
Get a QVariantMap which describes the exoplanet. More... | |
virtual QString | getType (void) const |
Get the type of object. | |
virtual QString | getID (void) const |
Returns a unique identifier for this object. More... | |
virtual float | getSelectPriority (const StelCore *core) const |
Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. | |
virtual QString | getInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Get an HTML string to describe the object. More... | |
virtual QVariantMap | getInfoMap (const StelCore *core) const |
Return a map like StelObject, but with a few extra tags also available in getMap(). More... | |
virtual Vec3f | getInfoColor (void) const |
Get a color used to display info about the object. | |
virtual Vec3d | getJ2000EquatorialPos (const StelCore *) const |
Get observer-centered equatorial coordinates at equinox J2000. | |
virtual float | getVMagnitude (const StelCore *core) const |
Get the visual magnitude. | |
virtual double | getAngularSize (const StelCore *core) const |
Get the angular size of host star. | |
virtual QString | getNameI18n (void) const |
Get the localized name of host star. | |
virtual QString | getEnglishName (void) const |
Get the english name. | |
QString | getDesignation (void) const |
QStringList | getExoplanetsEnglishNames (void) const |
QStringList | getExoplanetsNamesI18n (void) const |
QStringList | getExoplanetsDesignations (void) const |
bool | isDiscovered (const StelCore *core) |
void | update (double deltaTime) |
int | getCountExoplanets (void) const |
int | getCountHabitableExoplanets (void) const |
QList< double > | getData (int mode) |
Public Member Functions inherited from StelObject | |
virtual SphericalRegionP | getRegion () const |
Default implementation of the getRegion method. More... | |
virtual Vec3d | getPointInRegion () const |
Default implementation of the getPointInRegion method. More... | |
Vec3d | getEquinoxEquatorialPos (const StelCore *core) const |
Get observer-centered equatorial coordinate at the current equinox The frame has its Z axis at the planet's current rotation axis At time 2000-01-01 this frame is almost the same as J2000, but ONLY if the observer is on earth. | |
Vec3d | getEquinoxEquatorialPosApparent (const StelCore *core) const |
Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position. | |
Vec3d | getEquinoxEquatorialPosAuto (const StelCore *core) const |
Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active. | |
Vec3d | getGalacticPos (const StelCore *core) const |
Get observer-centered galactic coordinates. | |
Vec3d | getSupergalacticPos (const StelCore *core) const |
Get observer-centered supergalactic coordinates. | |
Vec3d | getSiderealPosGeometric (const StelCore *core) const |
Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More... | |
Vec3d | getSiderealPosApparent (const StelCore *core) const |
Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e. More... | |
Vec3d | getAltAzPosGeometric (const StelCore *core) const |
Get observer-centered alt/az position It is the geometric position, i.e. More... | |
Vec3d | getAltAzPosApparent (const StelCore *core) const |
Get observer-centered alt/az position It is the apparent position, i.e. More... | |
Vec3d | getAltAzPosAuto (const StelCore *core) const |
Get observer-centered alt/az position It is the automatic position, i.e. More... | |
bool | isAboveHorizon (const StelCore *core) const |
Checking position an object above mathematical horizon for current location. More... | |
bool | isAboveRealHorizon (const StelCore *core) const |
Checking position an object above real horizon for current location. More... | |
float | getVMagnitudeWithExtinction (const StelCore *core) const |
Return object's apparent V magnitude as seen from observer including extinction. More... | |
virtual double | getCloseViewFov (const StelCore *) const |
Return the best FOV in degree to use for a close view of the object. | |
virtual double | getSatellitesFov (const StelCore *) const |
Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites) | |
virtual double | getParentSatellitesFov (const StelCore *) const |
Static Public Attributes | |
static const QString | EXOPLANET_TYPE |
Static Public Attributes inherited from StelObject | |
static const InfoStringGroupFlags | AllInfo |
A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More... | |
static const InfoStringGroupFlags | ShortInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000) |
A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. | |
Friends | |
class | Exoplanets |
Additional Inherited Members | |
Public Types inherited from StelObject | |
enum | InfoStringGroupFlags { Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008, RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Size = 0x00000080, Velocity = 0x00000100, Extra = 0x00000200, HourAngle = 0x00000400, AbsoluteMagnitude = 0x00000800, GalacticCoord = 0x00001000, SupergalacticCoord = 0x00002000, ObjectType = 0x00004000, EclipticCoordJ2000 = 0x00008000, EclipticCoordOfDate = 0x00010000, IAUConstellation = 0x00020000, SiderealTime = 0x00040000, NoFont = 0x00080000, PlainText = 0x00100000 } |
Used as named bitfield flags as specifiers to filter results of getInfoString. More... | |
Protected Member Functions inherited from StelObject | |
QString | getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Format the positional info string contain J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. for the object. | |
void | postProcessInfoString (QString &str, const InfoStringGroup &flags) const |
Apply post processing on the info string. | |
Exoplanet::Exoplanet | ( | const QVariantMap & | map | ) |
id | The official designation for a exoplanet, e.g. "Kepler-10 b" |
|
inlinevirtual |
The ID should be unique for all objects of the same type, but may freely conflict with IDs of other types, so getType() must also be tested.
With this it should be possible to at least identify the same object in a different instance of Stellarium running the same version, but it would even be better if the ID provides some degree of forward-compatibility. For some object types (e.g. planets) this may simply return getEnglishName(), but better candidates may be official designations or at least (stable) internal IDs.
An object may have multiple IDs (different catalog numbers, etc). StelObjectMgr::searchByID() should search through all ID variants, but this method only returns one of them.
Implements StelObject.
|
virtual |
Reimplemented from StelObject.
|
virtual |
core | A pointer to the core a set of flags with information types to include. |
Implements StelObject.
QVariantMap Exoplanet::getMap | ( | void | ) | const |
Could be used to create a duplicate.
class Exoplanets |
Public Types | |
enum | UpdateState { Updating, CompleteNoUpdates, CompleteUpdates, DownloadError, OtherError } |
Used for keeping for track of the download/update status. More... | |
enum | TemperatureScale { Kelvin = 0, Celsius = 1, Fahrenheit = 2 } |
Available temperature scales. | |
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 | setFlagShowExoplanets (bool b) |
Enable/disable display of markers of exoplanetary systems. More... | |
bool | getFlagShowExoplanets (void) const |
Get status to display of markers of exoplanetary systems. More... | |
void | setFlagShowExoplanetsDesignations (bool b) |
Enable/disable display of designations of exoplanetary systems. More... | |
bool | getFlagShowExoplanetsDesignations (void) const |
Get status to display of designations of exoplanetary systems. More... | |
void | setFlagShowExoplanetsButton (bool b) |
Define whether the button toggling exoplanets should be visible. | |
bool | getFlagShowExoplanetsButton (void) |
bool | getDisplayMode (void) const |
Get status to display of distribution of exoplanetary systems. More... | |
void | setDisplayMode (bool b) |
Enable/disable display of distribution of exoplanetary systems. More... | |
bool | getTimelineMode (void) const |
Get status to display of systems with exoplanets after their discovery. More... | |
void | setTimelineMode (bool b) |
Enable/disable display of systems with exoplanets after their discovery only. More... | |
bool | getHabitableMode (void) const |
Get status to display of exoplanetary systems with the potentially habitable exoplanets. More... | |
void | setHabitableMode (bool b) |
Enable/disable display of exoplanetary systems with the potentially habitable exoplanets only. More... | |
Vec3f | getMarkerColor (bool habitable) const |
Get color for markers of exoplanetary systems. More... | |
void | setMarkerColor (const Vec3f &c, bool h) |
Set color for markers of exoplanetary systems. More... | |
int | getCountPlanetarySystems (void) const |
Get count of planetary systems from catalog. More... | |
int | getCountAllExoplanets (void) const |
Get count of exoplanets from catalog. More... | |
int | getCountHabitableExoplanets (void) const |
Get count of potentially habitable exoplanets from catalog. More... | |
void | setCurrentTemperatureScale (TemperatureScale tscale) |
Set the temperature scale. | |
TemperatureScale | getCurrentTemperatureScale () const |
Get the current temperature scale. | |
QString | getCurrentTemperatureScaleKey (void) const |
Get the key of current temperature scale. | |
void | setCurrentTemperatureScaleKey (QString key) |
Set the temperature scale from its key. | |
Signals | |
void | updateStateChanged (Exoplanets::UpdateState state) |
void | jsonUpdateComplete (void) |
emitted after a JSON update has run. | |
void | flagExoplanetsVisibilityChanged (bool b) |
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 deltaTime) |
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 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 | 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 the passed object name. More... | |
virtual QStringList | listAllObjects (bool inEnglish) const |
List all StelObjects. More... | |
virtual QString | getName () const |
Gets a user-displayable name of the object category. | |
virtual QString | getStelObjectType () const |
Returns the name that will be returned by StelObject::getType() for the objects this module manages. | |
ExoplanetP | getByID (const QString &id) |
get a exoplanet object by identifier | |
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 | loadConfiguration (void) |
Read (or re-read) settings from the main config file. More... | |
void | saveConfiguration (void) |
Save the settings to the main configuration file. | |
bool | getUpdatesEnabled (void) const |
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... | |
void | setEnableAtStartup (bool b) |
bool | getEnableAtStartup (void) const |
QDateTime | getLastUpdate (void) const |
get the date and time the TLE elements were updated | |
int | getUpdateFrequencyHours (void) const |
get the update frequency in hours | |
void | setUpdateFrequencyHours (int hours) |
int | getSecondsToUpdate (void) |
get the number of seconds till the next update | |
UpdateState | getUpdateState (void) const |
Get the current updateState. | |
QList< double > | getExoplanetsData (int mode) const |
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. | |
virtual QString | getAuthorName () const |
Get the name of the module author. | |
virtual QString | getAuthorEmail () const |
Get the email adress of the module author. | |
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... | |
Properties | |
bool | showExoplanets |
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... | |
|
virtual |
Reimplemented from StelModule.
|
virtual |
Deinitialize all openGL texture in this method.
Reimplemented from StelModule.
|
virtual |
core | the core to use for the drawing |
Reimplemented from StelModule.
|
virtual |
actionName | the name of the action for which we want the call order |
Reimplemented from StelModule.
|
inlineslot |
|
inlineslot |
|
inlineslot |
|
slot |
|
inlineslot |
|
slot |
|
slot |
|
slot |
h | set false if you want get color of markers of potentially habitable exoplanets |
|
slot |
|
inline |
|
virtual |
If the initialization takes significant time, the progress should be displayed on the loading bar.
Implements StelModule.
|
virtual |
inEnglish | list names in English (true) or translated (false) |
Implements StelObjectModule.
|
virtual |
objPrefix | the case insensitive first letters of the searched object |
maxNbItem | the maximum number of returned object names |
useStartOfWords | the autofill mode for returned objects names |
Reimplemented from StelObjectModule.
void Exoplanets::loadConfiguration | ( | void | ) |
This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).
void Exoplanets::restoreDefaults | ( | void | ) |
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.
|
virtual |
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 |
name | the english object name |
Implements StelObjectModule.
|
virtual |
name | The case in-sensistive standard program name |
Implements StelObjectModule.
|
virtual |
nameI18n | The case in-sensistive satellite name |
Implements StelObjectModule.
|
slot |
b |
|
slot |
b | boolean flag |
|
slot |
b | boolean flag |
|
slot |
b |
|
slot |
c | color |
h | set true if you want set color for potentially habitable exoplanets // example of usage in scripts |
|
slot |
b |
|
inline |
b | if true, updates will be enabled, else they will be disabled |
|
virtual |
deltaTime | the time increment in second since last call. |
Implements StelModule.
|
slot |
|
signal |
state | the new update state. |