Stellarium  0.16.0
List of all members | Public Types | Public Slots | Signals | Public Member Functions | Properties
Exoplanets Class Reference

Main class of the Exoplanets plugin. More...

#include <Exoplanets.hpp>

+ Inheritance diagram for Exoplanets:
+ Collaboration diagram for Exoplanets:

Public Types

enum  UpdateState {
  Updating, CompleteNoUpdates, CompleteUpdates, DownloadError,
  OtherError
}
 Used for keeping for track of the download/update status. More...
 
- Public Types inherited from StelModule
enum  StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
 Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
 
enum  StelModuleActionName {
  ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves,
  ActionHandleKeys
}
 Define the possible action for which an order is defined. More...
 

Public Slots

void updateJSON (void)
 Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. More...
 
void 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. More...
 
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...
 

Signals

void updateStateChanged (Exoplanets::UpdateState state)
 
void jsonUpdateComplete (void)
 emitted after a JSON update has run. More...
 
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< StelObjectPsearchAround (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. More...
 
virtual QString getStelObjectType () const
 Returns the name that will be returned by StelObject::getType() for the objects this module manages. More...
 
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 loadConfiguration (void)
 Read (or re-read) settings from the main config file. More...
 
void saveConfiguration (void)
 Save the settings to the main configuration file. More...
 
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 More...
 
int getUpdateFrequencyHours (void) const
 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) const
 Get the current updateState. More...
 
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. More...
 
virtual QString getAuthorName () const
 Get the name of the module author. More...
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author. More...
 
virtual void handleMouseClicks (class QMouseEvent *)
 Handle mouse clicks. More...
 
virtual void handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual void handleKeys (class QKeyEvent *e)
 Handle key events. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 

Properties

bool showExoplanets
 

Additional Inherited Members

- Protected Member Functions inherited from StelModule
class StelActionaddAction (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 StelActionaddAction (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...
 

Detailed Description

Main class of the Exoplanets plugin.

Author
Alexander Wolf

Definition at line 70 of file Exoplanets.hpp.

Member Enumeration Documentation

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.

Definition at line 81 of file Exoplanets.hpp.

Member Function Documentation

virtual bool Exoplanets::configureGui ( bool  show = true)
virtual

Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.

Reimplemented from StelModule.

virtual void Exoplanets::deinit ( )
virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void Exoplanets::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

ExoplanetP Exoplanets::getByID ( const QString &  id)

get a exoplanet object by identifier

virtual double Exoplanets::getCallOrder ( StelModuleActionName  actionName) const
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.

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

int Exoplanets::getCountAllExoplanets ( void  ) const
inlineslot

Get count of exoplanets from catalog.

Returns
count of all exoplanets

Definition at line 300 of file Exoplanets.hpp.

int Exoplanets::getCountHabitableExoplanets ( void  ) const
inlineslot

Get count of potentially habitable exoplanets from catalog.

Returns
count of potentially habitable exoplanets

Definition at line 307 of file Exoplanets.hpp.

int Exoplanets::getCountPlanetarySystems ( void  ) const
inlineslot

Get count of planetary systems from catalog.

Returns
count of planetary systems

Definition at line 293 of file Exoplanets.hpp.

bool Exoplanets::getDisplayMode ( void  ) const
slot

Get status to display of distribution of exoplanetary systems.

Returns
true if distribution of exoplanetary systems is enabled
bool Exoplanets::getFlagShowExoplanets ( void  ) const
inlineslot

Get status to display of markers of exoplanetary systems.

Returns
true if it's visible

Definition at line 244 of file Exoplanets.hpp.

bool Exoplanets::getFlagShowExoplanetsDesignations ( void  ) const
slot

Get status to display of designations of exoplanetary systems.

Returns
true if it's visible
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
QDateTime Exoplanets::getLastUpdate ( void  ) const
inline

get the date and time the TLE elements were updated

Definition at line 162 of file Exoplanets.hpp.

Vec3f Exoplanets::getMarkerColor ( bool  habitable) const
slot

Get color for markers of exoplanetary systems.

Parameters
hset false if you want get color of markers of potentially habitable exoplanets
Returns
color
virtual QString Exoplanets::getName ( ) const
inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 129 of file Exoplanets.hpp.

int Exoplanets::getSecondsToUpdate ( void  )

get the number of seconds till the next update

virtual QString Exoplanets::getStelObjectType ( ) const
inlinevirtual

Returns the name that will be returned by StelObject::getType() for the objects this module manages.

Implements StelObjectModule.

Definition at line 130 of file Exoplanets.hpp.

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
int Exoplanets::getUpdateFrequencyHours ( void  ) const
inline

get the update frequency in hours

Definition at line 165 of file Exoplanets.hpp.

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

Definition at line 153 of file Exoplanets.hpp.

UpdateState Exoplanets::getUpdateState ( void  ) const
inline

Get the current updateState.

Definition at line 172 of file Exoplanets.hpp.

virtual void Exoplanets::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void Exoplanets::jsonUpdateComplete ( void  )
signal

emitted after a JSON update has run.

virtual QStringList Exoplanets::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

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

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

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

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe 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.

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

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::saveConfiguration ( void  )

Save the settings to the main configuration file.

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

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

Parameters
va vector representing the position in th sky around which to search for nebulae.
limitFovthe field of view around the position v in which to search for exoplanets.
corethe StelCore to use for computations.
Returns
an list containing the exoplanets located inside the limitFov circle around position v.

Implements StelObjectModule.

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

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters
namethe english object name

Implements StelObjectModule.

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

Return the matching satellite if exists or Q_NULLPTR.

Parameters
nameThe case in-sensistive standard program name

Implements StelObjectModule.

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

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

Parameters
nameI18nThe case in-sensistive satellite name

Implements StelObjectModule.

void Exoplanets::setDisplayMode ( bool  b)
slot

Enable/disable display of distribution of exoplanetary systems.

Parameters
b
void Exoplanets::setFlagShowExoplanets ( bool  b)
slot

Enable/disable display of markers of exoplanetary systems.

Parameters
bboolean flag
void Exoplanets::setFlagShowExoplanetsButton ( bool  b)
slot

Define whether the button toggling exoplanets should be visible.

void Exoplanets::setFlagShowExoplanetsDesignations ( bool  b)
slot

Enable/disable display of designations of exoplanetary systems.

Parameters
bboolean flag
void Exoplanets::setHabitableMode ( bool  b)
slot

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

Parameters
b
void Exoplanets::setMarkerColor ( const Vec3f c,
bool  h 
)
slot

Set color for markers of exoplanetary systems.

Parameters
ccolor
hset 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);
void Exoplanets::setTimelineMode ( bool  b)
slot

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

Parameters
b
void Exoplanets::setUpdatesEnabled ( bool  b)
inline

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

Parameters
bif true, updates will be enabled, else they will be disabled

Definition at line 156 of file Exoplanets.hpp.

virtual void Exoplanets::update ( double  deltaTime)
virtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.

void Exoplanets::updateJSON ( void  )
slot

Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.

void Exoplanets::updateStateChanged ( Exoplanets::UpdateState  state)
signal
Parameters
statethe new update state.

The documentation for this class was generated from the following file: