Data Structures
struct	exoplanetData

class	ExoplanetsDialog
	Main window of the Exoplanets plugin. More...

class	Exoplanet
	An exoplanet object represents one extrasolar planetary system in the sky. More...

class	Exoplanets
	Main class of the Exoplanets plugin. More...

Typedefs
typedef QSharedPointer< Exoplanet >	ExoplanetP

Detailed Description

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

Data Structure Documentation

◆ exoplanetData

struct exoplanetData

Data Fields
double	angleDistance	Exoplanet orbit inclination.
bool	conservative	Method of detection of exoplanet.
QString	detectionMethod	Exoplanet Earth Similarity Index.
int	discovered	Exoplanet angle distance.
double	eccentricity	Exoplanet orbit semi-major axis (AU)
int	ESI	Average stellar flux of the planet in Earth fluxes (Earth = 1.0 SE).
int	flux	Exoplanet surface temperature in kelvins (K) assuming a 0.3 bond albedo (Earth = 255 K).
double	inclination	Exoplanet orbit eccentricity.
double	mass	Exoplanet proper name.
QString	pclass	Exoplanet discovered year.
double	period	Exoplanet radius (Rjup)
QString	planetName
QString	planetProperName	Exoplanet designation.
double	radius	Exoplanet mass (Mjup)
double	semiAxis	Exoplanet period (days)
int	SurfTemp	Exoplanet classification from host star spectral type (F, G, K, M), habitable zone (hot, warm, cold) and size (miniterran, subterran, terran, superterran, jovian, neptunian)

◆ ExoplanetsDialog

class ExoplanetsDialog

Main window of the Exoplanets plugin.

Public Types
enum	ExoplanetsColumns { EPSExoplanetName , EPSExoplanetMass , EPSExoplanetRadius , EPSExoplanetPeriod , EPSExoplanetSemiAxes , EPSExoplanetEccentricity , EPSExoplanetInclination , EPSExoplanetAngleDistance , EPSStarMagnitude , EPSStarRadius , EPSExoplanetDetectionMethod , EPSCount }

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

Member Enumeration Documentation

◆ ExoplanetsColumns

enum ExoplanetsDialog::ExoplanetsColumns

Enumerator
EPSCount	total number of columns

◆ Exoplanet

class Exoplanet

An exoplanet object represents one extrasolar planetary system in the sky.

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

QString	getType (void) const override
	Get the type of object.

QString	getObjectType (void) const override
	Get the type of object.

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

float	getSelectPriority (const StelCore *core) const override
	Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.

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, 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
	Get the visual magnitude.

QString	getNameI18n (void) const override
	Get the localized name of host star.

QString	getEnglishName (void) const override
	Get the english name.

bool	isVMagnitudeDefined () const

QString	getDesignation (void) const

QStringList	getDesignations (void) const

QStringList	getExoplanetsEnglishNames (void) const

QStringList	getExoplanetsNamesI18n (void) const

QStringList	getExoplanetsDesignations (void) const

bool	isDiscovered (const StelCore *core)

int	getCountExoplanets (void) const

int	getCountHabitableExoplanets (void) const

QList< double >	getData (int mode)

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

Friends
class	Exoplanets

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

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

virtual QString	getMagnitudeInfoString (const StelCore *core, const InfoStringGroup &flags, const int decimals=1) const
	Format the magnitude info string for the object. 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...

Constructor & Destructor Documentation

◆ Exoplanet()

Exoplanet::Exoplanet ( const QVariantMap & map )

Parameters

id	The official designation for a exoplanet, e.g. "Kepler-10 b"

Member Function Documentation

◆ getID()

QString Exoplanet::getID ( void ) const

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.

◆ getInfoMap()

QVariantMap Exoplanet::getInfoMap ( const StelCore * core ) const

overridevirtual

Return a map like StelObject, but with a few extra tags also available in getMap().

distance = distance in pc
stype = Spectral type of star
smass = Mass of star in Msun
smetal = [Fe/H] of star
sradius = Radius of star in Rsun
effectiveTemp = Effective temperature of star in K
hasHabitablePlanets (true/false)

Reimplemented from StelObject.

◆ getInfoString()

QString Exoplanet::getInfoString	(	const StelCore *	core,
		const InfoStringGroup &	flags
	)		const

overridevirtual

Get an HTML string to describe the object.

Parameters

core	A pointer to the core @flags a set of flags with information types to include.

Implements StelObject.

◆ getMap()

QVariantMap Exoplanet::getMap ( void ) const

Get a QVariantMap which describes the exoplanet.

Could be used to create a duplicate.

◆ isDiscovered()

bool Exoplanet::isDiscovered ( const StelCore * core )

Returns: whether system has been discovered by the current year.

◆ Exoplanets

class Exoplanets

Main class of the Exoplanets plugin.

Author: Alexander Wolf

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 resources described in the module section of the module.ini file and update the local JSON file.

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	setFlagShowExoplanetsNumbers (bool b)
	Enable/disable display of number of exoplanets in exoplanetary system. More...

bool	getFlagShowExoplanetsNumbers (void) const
	Get status to display of designations of exoplanets in exoplanetary system. More...

void	setFlagShowExoplanetsButton (bool b)
	Define whether the button toggling exoplanets should be visible.

bool	getFlagShowExoplanetsButton (void) const

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 () const
	Get color for markers of exoplanetary systems. More...

void	setMarkerColor (const Vec3f &c)
	Set color for markers of exoplanetary systems. More...

Vec3f	getHabitableColor () const
	Get color for markers of habitable exoplanetary systems. More...

void	setHabitableColor (const Vec3f &c)
	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 (Exoplanets::TemperatureScale tscale)
	Set the temperature scale.

Exoplanets::TemperatureScale	getCurrentTemperatureScale () const
	Get the current temperature scale.

QString	getCurrentTemperatureScaleKey (void) const
	Get the key of current temperature scale.

void	setCurrentTemperatureScaleKey (const QString &key)
	Set the temperature scale from its key.

void	setFontSize (int s)
	Connect this to StelApp font size.

Signals
void	updateStateChanged (Exoplanets::UpdateState state)

void	jsonUpdateComplete (void)
	emitted after a JSON update has run.

void	flagExoplanetsVisibilityChanged (bool b)

void	markerColorChanged (Vec3f)

void	habitableColorChanged (Vec3f)

void	displayModeChanged (bool)

void	timelineModeChanged (bool)

void	habitableModeChanged (bool)

void	flagShowExoplanetsDesignationsChanged (bool)

void	flagShowExoplanetsNumbersChanged (bool)

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	update (double deltaTime) override
	Update the module with respect to the time. 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 exoplanet system object's pointer if exists or Q_NULLPTR. More...

StelObjectP	searchByName (const QString &name) const override
	Return the matching exoplanet system if exists or Q_NULLPTR. More...

StelObjectP	searchByID (const QString &id) const override
	Return the matching exoplanet system if exists or Q_NULLPTR. More...

QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const override
	Find and return the list of at most maxNbItem objects auto-completing the passed object name. 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.

ExoplanetP	getByID (const QString &id) const
	get a exoplanet 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	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

const QList< ExoplanetP > &	getAllExoplanetarySystems () const
	Get the list of all exoplanetary systems.

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
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.

virtual QSettings *	getSettings ()
	Return module-specific settings. 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...

Properties
bool	showExoplanets

Vec3f	markerColor

Vec3f	habitableColor

bool	flagDisplayMode

bool	flagTimelineMode

bool	flagHabitableMode

bool	flagShowExoplanetsDesignations

bool	flagShowExoplanetsNumbers

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

Member Enumeration Documentation

◆ UpdateState

enum Exoplanets::UpdateState

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.

Member Function Documentation

◆ deinit()

void Exoplanets::deinit ( )

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.

◆ draw()

void Exoplanets::draw ( StelCore * core )

overridevirtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

double Exoplanets::getCallOrder ( StelModuleActionName actionName ) const

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.

Parameters

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

◆ getCountAllExoplanets

int Exoplanets::getCountAllExoplanets ( void ) const

inlineslot

Get count of exoplanets from catalog.

Returns: count of all exoplanets

◆ getCountHabitableExoplanets

int Exoplanets::getCountHabitableExoplanets ( void ) const

inlineslot

Get count of potentially habitable exoplanets from catalog.

Returns: count of potentially habitable exoplanets

◆ getCountPlanetarySystems

int Exoplanets::getCountPlanetarySystems ( void ) const

inlineslot

Get count of planetary systems from catalog.

Returns: count of planetary systems

◆ getDisplayMode

bool Exoplanets::getDisplayMode ( void ) const

slot

Get status to display of distribution of exoplanetary systems.

Returns: true if distribution of exoplanetary systems is enabled

◆ getFlagShowExoplanets

bool Exoplanets::getFlagShowExoplanets ( void ) const

inlineslot

Get status to display of markers of exoplanetary systems.

Returns: true if it's visible

◆ getFlagShowExoplanetsDesignations

bool Exoplanets::getFlagShowExoplanetsDesignations ( void ) const

slot

Get status to display of designations of exoplanetary systems.

Returns: true if it's visible

◆ getFlagShowExoplanetsNumbers

bool Exoplanets::getFlagShowExoplanetsNumbers ( void ) const

slot

Get status to display of designations of exoplanets in exoplanetary system.

Returns: true if it's visible

◆ getHabitableColor

Vec3f Exoplanets::getHabitableColor ( ) const

slot

Get color for markers of habitable exoplanetary systems.

Parameters

h	set false if you want get color of markers of potentially habitable exoplanets

Returns: color

◆ getHabitableMode

bool Exoplanets::getHabitableMode ( void ) const

slot

Get status to display of exoplanetary systems with the potentially habitable exoplanets.

Returns: true if systems with only potentially habitable exoplanets are visible

◆ getMarkerColor

Vec3f Exoplanets::getMarkerColor ( ) const

slot

Get color for markers of exoplanetary systems.

Parameters

h	set false if you want get color of markers of potentially habitable exoplanets

Returns: color

◆ getTimelineMode

bool Exoplanets::getTimelineMode ( void ) const

slot

Get status to display of systems with exoplanets after their discovery.

Returns: true if markers of exoplanetary systems are visible after discovery of exoplanets

◆ getUpdatesEnabled()

bool Exoplanets::getUpdatesEnabled ( void ) const

inline

get whether or not the plugin will try to update TLE data from the internet

Returns: true if updates are set to be done, false otherwise

◆ init()

void Exoplanets::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

QStringList Exoplanets::listAllObjects ( bool inEnglish ) const

overridevirtual

List all StelObjects.

Parameters

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

◆ listMatchingObjects()

QStringList Exoplanets::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

overridevirtual

Find and return the list of at most maxNbItem objects auto-completing the passed object name.

Parameters

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

Returns: a list of matching object name by order of relevance, or an empty list if nothing match

Reimplemented from StelObjectModule.

◆ loadConfiguration()

void Exoplanets::loadConfiguration ( 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).

◆ restoreDefaults()

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.

◆ searchAround()

QList<StelObjectP> Exoplanets::searchAround	(	const Vec3d &	v,
		double	limitFov,
		const StelCore *	core
	)		const

overridevirtual

Used to get a list of objects which are near to some position.

Parameters

v	a vector representing the position in th sky around which to search for exoplanets.
limitFov	the field of view around the position v in which to search for exoplanets.
core	the StelCore to use for computations.

Returns: a list containing the exoplanets located inside the limitFov circle around position v.

Implements StelObjectModule.

◆ searchByID()

StelObjectP Exoplanets::searchByID ( const QString & id ) const

overridevirtual

Return the matching exoplanet system if exists or Q_NULLPTR.

Parameters

id	The exoplanet system id

Implements StelObjectModule.

◆ searchByName()

StelObjectP Exoplanets::searchByName ( const QString & name ) const

overridevirtual

Return the matching exoplanet system if exists or Q_NULLPTR.

Parameters

name	The case in-sensitive english exoplanet system name

Implements StelObjectModule.

◆ searchByNameI18n()

StelObjectP Exoplanets::searchByNameI18n ( const QString & nameI18n ) const

overridevirtual

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

Parameters

nameI18n The case in-sensitive localized exoplanet system name

Implements StelObjectModule.

◆ setDisplayMode

void Exoplanets::setDisplayMode ( bool b )

slot

Enable/disable display of distribution of exoplanetary systems.

Parameters

b

◆ setFlagShowExoplanets

void Exoplanets::setFlagShowExoplanets ( bool b )

slot

Enable/disable display of markers of exoplanetary systems.

Parameters

b	boolean flag

◆ setFlagShowExoplanetsDesignations

void Exoplanets::setFlagShowExoplanetsDesignations ( bool b )

slot

Enable/disable display of designations of exoplanetary systems.

Parameters

b	boolean flag

◆ setFlagShowExoplanetsNumbers

void Exoplanets::setFlagShowExoplanetsNumbers ( bool b )

slot

Enable/disable display of number of exoplanets in exoplanetary system.

Parameters

b	boolean flag

◆ setHabitableColor

void Exoplanets::setHabitableColor ( const Vec3f & c )

slot

Set color for markers of exoplanetary systems.

Parameters

c	color
h	set true if you want set color for potentially habitable exoplanets // example of usage in scripts Exoplanets.setHabitableColor(Vec3f(1.0,0.0,0.0), true);

◆ setHabitableMode

void Exoplanets::setHabitableMode ( bool b )

slot

Enable/disable display of exoplanetary systems with the potentially habitable exoplanets only.

Parameters

b

◆ setMarkerColor

void Exoplanets::setMarkerColor ( const Vec3f & c )

slot

Set color for markers of exoplanetary systems.

Parameters

c	color
h	set true if you want set color for potentially habitable exoplanets // example of usage in scripts Exoplanets.setMarkerColor(Vec3f(1.0,0.0,0.0), true);

◆ setTimelineMode

void Exoplanets::setTimelineMode ( bool b )

slot

Enable/disable display of systems with exoplanets after their discovery only.

Parameters

b

◆ setUpdatesEnabled()

void Exoplanets::setUpdatesEnabled ( bool b )

inline

set whether or not the plugin will try to update TLE data from the internet

Parameters

b	if true, updates will be enabled, else they will be disabled

◆ update()

void Exoplanets::update ( double deltaTime )

overridevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Reimplemented from StelModule.

◆ updateStateChanged

void Exoplanets::updateStateChanged ( Exoplanets::UpdateState state )

signal

Parameters

state the new update state.

Data Structures

Typedefs

Detailed Description

Data Structure Documentation

◆ exoplanetData

◆ ExoplanetsDialog

Public Types

Public Slots

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ ExoplanetsColumns

◆ Exoplanet

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ Exoplanet()

Member Function Documentation

◆ getID()

◆ getInfoMap()

◆ getInfoString()

◆ getMap()

◆ isDiscovered()

◆ Exoplanets

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Member Enumeration Documentation

◆ UpdateState

Member Function Documentation

◆ deinit()

◆ draw()

◆ getCallOrder()

◆ getCountAllExoplanets

◆ getCountHabitableExoplanets

◆ getCountPlanetarySystems

◆ getDisplayMode

◆ getFlagShowExoplanets

◆ getFlagShowExoplanetsDesignations

◆ getFlagShowExoplanetsNumbers

◆ getHabitableColor

◆ getHabitableMode

◆ getMarkerColor

◆ getTimelineMode

◆ getUpdatesEnabled()

◆ init()

◆ listAllObjects()

◆ listMatchingObjects()

◆ loadConfiguration()

◆ restoreDefaults()

◆ searchAround()

◆ searchByID()

◆ searchByName()

◆ searchByNameI18n()

◆ setDisplayMode

◆ setFlagShowExoplanets

◆ setFlagShowExoplanetsDesignations

◆ setFlagShowExoplanetsNumbers

◆ setHabitableColor

◆ setHabitableMode

◆ setMarkerColor

◆ setTimelineMode

◆ setUpdatesEnabled()

◆ update()

◆ updateStateChanged