Stellarium
HEAD
|
Data Structures | |
class | SupernovaeDialog |
class | Supernova |
A Supernova object represents one supernova on the sky. More... | |
class | Supernovae |
Main class of the Historical Supernovae plugin. More... | |
Typedefs | |
typedef QSharedPointer< Supernova > | SupernovaP |
The Historical Supernovae plugin displays the positions some historical supernovae brighter than 10 visual magnitude.
Supernovae Catalog
The supernovae catalog is stored on the disk in JSON format, in a file named "supernovae.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.
class SupernovaeDialog |
Public Slots | |
void | retranslate () override |
void | refreshUpdateValues (void) |
Public Slots inherited from StelDialog | |
virtual void | styleChanged (const QString &style) |
Apply application style change. | |
virtual void | retranslate ()=0 |
Retranslate the content of the dialog. More... | |
virtual void | setVisible (bool) |
On the first call with "true" populates the window contents. | |
virtual 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... | |
Protected Member Functions | |
void | createDialogContent () override |
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 (const QString &dialogName=QString("Default"), QObject *parent=nullptr) | |
bool | visible () const |
Returns true if the dialog contents have been constructed and are currently shown. | |
QString | getDialogName () const |
Protected Slots inherited from StelDialog | |
bool | askConfirmation (const QString &message=q_("Are you sure? This will delete your customized data.")) |
void | messageBox (const QString &title, const QString &message) |
void | enableKineticScrolling (bool b) |
enable kinetic scrolling. This should be connected to StelApp's StelGui signal flagUseKineticScrollingChanged. | |
void | handleFontChanged () |
connect from StelApp to handle font and font size changes. | |
void | handleColorSchemeChanged () |
connect from StelApp to handle CSS style changes | |
virtual void | updateNightModeProperty (bool n) |
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 (QLineEdit *lineEdit, const QString &propName) |
Helper function to connect a QLineEdit to an integer StelProperty. More... | |
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 (AngleSpinBox *spinBox, const QString &propName) |
Helper function to connect an AngleSpinBox to a double or float StelProperty representing decimal degrees. 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 | connectStringProperty (QComboBox *comboBox, const QString &propName) |
Helper function to connect a QComboBox to a QString StelProperty. More... | |
static void | connectStringProperty (QLineEdit *lineEdit, const QString &propName) |
Helper function to connect a QLineEdit to a QString StelProperty. More... | |
static void | connectBoolProperty (QAbstractButton *checkBox, const QString &propName) |
Helper function to connect a checkbox to a bool StelProperty. More... | |
static void | connectBoolProperty (QGroupBox *checkBox, const QString &propName) |
Helper function to connect a groupbox 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. | |
QList< QWidget * > | kineticScrollingList |
A list of widgets where kinetic scrolling can be activated or deactivated The list must be filled once, in the constructor or init() of fillDialog() etc. More... | |
Properties inherited from StelDialog | |
bool | visible |
class Supernova |
A Supernova object represents one supernova on the sky.
Details about the supernovas are passed using a QVariant which contains a map of data from the json file.
Public Member Functions | |
Supernova (const QVariantMap &map) | |
QVariantMap | getMap (void) const |
Get a QVariantMap which describes the supernova. More... | |
QString | getType (void) const override |
Return object's type. It should be the name of the class. | |
QString | getObjectType (void) const override |
Return object's type. More... | |
QString | getObjectTypeI18n (void) const override |
Return object's type. It should be translated lowercase name of the type of the object. | |
QString | getID (void) const override |
Returns a unique identifier for this object. More... | |
QString | getInfoString (const StelCore *core, const InfoStringGroup &flags) const override |
Get an HTML string to describe the object. More... | |
QVariantMap | getInfoMap (const StelCore *core) const override |
Return a map like StelObject::getInfoMap(), but with a few extra tags also available in getMap(). More... | |
Vec3f | getInfoColor (void) const override |
Get a color used to display info about the object. | |
Vec3d | getJ2000EquatorialPos (const StelCore *core) const override |
Get observer-centered equatorial coordinates at equinox J2000, including aberration. | |
float | getVMagnitude (const StelCore *core) const override |
Return object's apparent V magnitude as seen from observer, without including extinction. | |
QString | getNameI18n (void) const override |
Return translated object's name. | |
QString | getEnglishName (void) const override |
Return object's name in english. | |
Public Member Functions inherited from StelObject | |
SphericalRegionP | getRegion () const override |
Default implementation of the getRegion method. More... | |
Vec3d | getPointInRegion () const override |
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... | |
float | getParallacticAngle (const StelCore *core) const |
Get parallactic angle, which is the deviation between zenith angle and north angle. [radians]. | |
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... | |
virtual Vec4d | getRTSTime (const StelCore *core, const double altitude=0.) const |
Compute time of rise, transit and set for celestial object for current location. More... | |
float | getVMagnitudeWithExtinction (const StelCore *core, const float knownVMag=-1000.f) const |
Return object's apparent V magnitude as seen from observer including extinction. More... | |
virtual float | getSelectPriority (const StelCore *) const |
Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. | |
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 |
virtual double | getAngularRadius (const StelCore *core) const |
Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos(). More... | |
virtual float | getAirmass (const StelCore *core) const |
Return airmass value for the object (for atmosphere-dependent calculations) More... | |
Static Public Attributes | |
static const QString | SUPERNOVA_TYPE |
Static Public Attributes inherited from StelObject | |
static constexpr InfoStringGroup | AllInfo |
A pre-defined "all available" set of specifiers for the getInfoString flags argument to getInfoString. More... | |
static constexpr InfoStringGroup | DefaultInfo |
A pre-defined "default" set of specifiers for the getInfoString flags argument to getInfoString It appears useful to propose this set as post-install settings and let users configure more on demand. More... | |
static constexpr InfoStringGroup | ShortInfo = static_cast<InfoStringGroup>(Name|CatalogNumber|Magnitude|RaDecJ2000) |
A pre-defined "shortest useful" set of specifiers for the getInfoString flags argument to getInfoString. | |
Protected Member Functions | |
QString | getMagnitudeInfoString (const StelCore *core, const InfoStringGroup &flags, const int decimals=1) const override |
Format the magnitude info string for the object. More... | |
Protected Member Functions inherited from StelObject | |
QString | getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Format the positional info string containing J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. More... | |
QString | getSolarLunarInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Add a section to the InfoString with just horizontal data for the Sun and Moon, when observed from Earth. More... | |
void | postProcessInfoString (QString &str, const InfoStringGroup &flags) const |
Apply post processing on the info string. More... | |
Friends | |
class | Supernovae |
Additional Inherited Members | |
Public Types inherited from StelObject | |
enum | InfoStringGroupFlags { None = 0x00000000 , Name = 0x00000001 , CatalogNumber = 0x00000002 , Magnitude = 0x00000004 , RaDecJ2000 = 0x00000008 , RaDecOfDate = 0x00000010 , AltAzi = 0x00000020 , Distance = 0x00000040 , Elongation = 0x00000080 , Size = 0x00000100 , Velocity = 0x00000200 , ProperMotion = 0x00000400 , Extra = 0x00000800 , HourAngle = 0x00001000 , AbsoluteMagnitude = 0x00002000 , GalacticCoord = 0x00004000 , SupergalacticCoord = 0x00008000 , OtherCoord = 0x00010000 , ObjectType = 0x00020000 , EclipticCoordJ2000 = 0x00040000 , EclipticCoordOfDate = 0x00080000 , IAUConstellation = 0x00100000 , SiderealTime = 0x00200000 , RTSTime = 0x00400000 , SolarLunarPosition = 0x00800000 , Script = 0x01000000 , DebugAid = 0x02000000 , NoFont = 0x04000000 , PlainText = 0x08000000 } |
Used as named bitfield flags as specifiers to filter results of getInfoString. More... | |
Public Slots inherited from StelObject | |
virtual void | setExtraInfoString (const InfoStringGroup &flags, const QString &str) |
Allow additions to the Info String. More... | |
virtual void | addToExtraInfoString (const StelObject::InfoStringGroup &flags, const QString &str) |
Add str to the extra string. More... | |
QStringList | getExtraInfoStrings (const InfoStringGroup &flags) const |
Retrieve an (unsorted) QStringList of all extra info strings that match flags. More... | |
void | removeExtraInfoStrings (const InfoStringGroup &flags) |
Remove the extraInfoStrings with the given flags. More... | |
Supernova::Supernova | ( | const QVariantMap & | map | ) |
id | The official designation for a supernova, e.g. "SN 1054A" |
|
inlineoverridevirtual |
Returns a unique identifier for this object.
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.
|
overridevirtual |
Return a map like StelObject::getInfoMap(), but with a few extra tags also available in getMap().
Reimplemented from StelObject.
|
overridevirtual |
Get an HTML string to describe the object.
core | A pointer to the core @flags a set of flags with information types to include. |
Implements StelObject.
|
overrideprotectedvirtual |
Format the magnitude info string for the object.
core | |
flags | |
decimals | significant digits after the comma. |
Reimplemented from StelObject.
QVariantMap Supernova::getMap | ( | void | ) | const |
Get a QVariantMap which describes the supernova.
Could be used to create a duplicate.
|
inlineoverridevirtual |
Return object's type.
It should be English lowercase name of the astronomical type of the object. The purpose of this string is a distinction or further refinement over object class name retrieved with getType(): Planet objects can be planets, moons, or even the Sun. The Sun should however return "star". Nebula objects should return their actual type like "open cluster", "galaxy", "nebula", ...
Implements StelObject.
class Supernovae |
Main class of the Historical Supernovae plugin.
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 resources described in the module section of the module.ini file and update the local JSON file. | |
void | displayMessage (const QString &message, const QString &hexColor="#999999") |
Display a message. This is used for plugin-specific warnings and such. | |
void | reloadCatalog (void) |
void | setFontSize (int s) |
Connect this to StelApp font size. | |
Signals | |
void | updateStateChanged (Supernovae::UpdateState state) |
void | jsonUpdateComplete (void) |
Emitted after a JSON update has run. | |
Public Member Functions | |
void | init () override |
Initialize itself. More... | |
void | deinit () override |
Called before the module will be deleted, and before the OpenGL context is suppressed. More... | |
void | draw (StelCore *core) override |
Execute all the drawing functions for this module. More... | |
virtual void | drawPointer (StelCore *core, StelPainter &painter) |
double | getCallOrder (StelModuleActionName actionName) const override |
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... | |
QList< StelObjectP > | searchAround (const Vec3d &v, double limitFov, const StelCore *core) const override |
Used to get a list of objects which are near to some position. More... | |
StelObjectP | searchByNameI18n (const QString &nameI18n) const override |
Return the matching supernova object's pointer if exists or Q_NULLPTR. More... | |
StelObjectP | searchByName (const QString &name) const override |
Return the matching supernova if exists or Q_NULLPTR. More... | |
StelObjectP | searchByID (const QString &id) const override |
Return the matching supernova if exists, or an "empty" pointer. More... | |
QStringList | listAllObjects (bool inEnglish) const override |
List all StelObjects. More... | |
QString | getName () const override |
Gets a user-displayable name of the object category. | |
QString | getStelObjectType () const override |
Returns the name that will be returned by StelObject::getType() for the objects this module manages. | |
SupernovaP | getByID (const QString &id) const |
get a supernova object by identifier | |
bool | configureGui (bool show=true) override |
Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. | |
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. | |
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. | |
int | getUpdateFrequencyDays (void) |
Get the update frequency in days. | |
void | setUpdateFrequencyDays (int days) |
int | getSecondsToUpdate (void) |
Get the number of seconds till the next update. | |
UpdateState | getUpdateState (void) |
Get the current updateState. | |
QString | getSupernovaeList () const |
Get list of supernovae. | |
float | getLowerLimitBrightness () const |
Get lower limit of brightness for displayed supernovae. | |
int | getCountSupernovae (void) const |
Get count of supernovae from catalog. | |
const QList< SupernovaP > & | getAllBrightSupernovae () const |
Get the list of all bright historical supernovae. | |
Public Member Functions inherited from StelObjectModule | |
virtual QStringList | listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=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 | |
StelModule () | |
Constructor. Every derived class MUST call setObjectName(className) in its constructor. | |
virtual QSettings * | getSettings () |
Return module-specific settings. More... | |
virtual void | update (double deltaTime) |
Update the module with respect to the time. More... | |
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 address 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... | |
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... | |
StelAction * | addAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="") |
convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More... | |
|
overridevirtual |
Called before the module will be deleted, and before the OpenGL context is suppressed.
Deinitialize all OpenGL texture in this method.
Reimplemented from StelModule.
|
overridevirtual |
Execute all the drawing functions for this module.
core | the core to use for the drawing |
Reimplemented from StelModule.
|
overridevirtual |
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 whether or not the plugin will try to update catalog data from the internet.
|
overridevirtual |
Initialize itself.
If the initialization takes significant time, the progress should be displayed on the loading bar.
Implements StelModule.
|
overridevirtual |
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 Supernovae 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.
|
overridevirtual |
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 supernovae. |
limitFov | the field of view around the position v in which to search for supernovae. |
core | the StelCore to use for computations. |
Implements StelObjectModule.
|
inlineoverridevirtual |
Return the matching supernova if exists, or an "empty" pointer.
id | The supernova id |
Implements StelObjectModule.
|
overridevirtual |
Return the matching supernova if exists or Q_NULLPTR.
name | The case in-sensitive english supernova name |
Implements StelObjectModule.
|
overridevirtual |
Return the matching supernova object's pointer if exists or Q_NULLPTR.
nameI18n | The case in-sensitive localized supernova 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 |
|
signal |
state | the new update state. |