Stellarium 0.13.2
SolarSystem.hpp
1 /*
2  * Stellarium
3  * Copyright (C) 2002 Fabien Chereau
4  * Copyright (c) 2010 Bogdan Marinov
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
19  */
20 
21 #ifndef _SOLARSYSTEM_HPP_
22 #define _SOLARSYSTEM_HPP_
23 //sun is already defined in Sun C/Solaris
24 #if defined(sun)
25 #undef sun
26 #endif
27 
28 #include "StelObjectModule.hpp"
29 #include "StelTextureTypes.hpp"
30 #include "Planet.hpp"
31 
32 #include <QFont>
33 
34 class Orbit;
35 class StelTranslator;
36 class StelObject;
37 class StelCore;
38 class StelProjector;
39 class QSettings;
40 
41 typedef QSharedPointer<Planet> PlanetP;
42 
47 {
48  Q_OBJECT
49  Q_PROPERTY(bool labelsDisplayed
50  READ getFlagLabels
51  WRITE setFlagLabels)
52  Q_PROPERTY(bool orbitsDisplayed
53  READ getFlagOrbits
54  WRITE setFlagOrbits)
55  Q_PROPERTY(bool trailsDisplayed
56  READ getFlagTrails
57  WRITE setFlagTrails)
58 
59 public:
60  SolarSystem();
61  virtual ~SolarSystem();
62 
64  // Methods defined in the StelModule class
70  virtual void init();
71 
72  virtual void deinit();
73 
78  virtual void draw(StelCore *core);
79 
82  virtual void update(double deltaTime);
83 
85  virtual double getCallOrder(StelModuleActionName actionName) const;
86 
88  // Methods defined in StelObjectManager class
97  virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;
98 
102  virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;
103 
107  virtual StelObjectP searchByName(const QString& name) const;
108 
116  virtual QStringList listMatchingObjectsI18n(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
124  virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
125  virtual QStringList listAllObjects(bool inEnglish) const { Q_UNUSED(inEnglish) return QStringList(); }
126  virtual QStringList listAllObjectsByType(const QString& objType, bool inEnglish) const;
127  virtual QString getName() const { return "Solar System"; }
128 
129 public slots:
131  // Method callable from script and GUI
132  // Properties setters and getters
134  void setFlagPlanets(bool b);
136  bool getFlagPlanets() const;
137 
139  void setFlagTrails(bool b);
141  bool getFlagTrails() const;
142 
144  void setFlagHints(bool b);
146  bool getFlagHints() const;
147 
149  void setFlagLabels(bool b);
151  bool getFlagLabels() const;
152 
156  void setLabelsAmount(float a) {labelsAmount=a;}
159  float getLabelsAmount(void) const {return labelsAmount;}
160 
162  void setFlagOrbits(bool b);
164  bool getFlagOrbits() const {return flagOrbits;}
165 
167  void setFlagMarkers(bool b) { flagMarker=b; }
169  bool getFlagMarkers() const {return flagMarker;}
170 
172  void setFlagLightTravelTime(bool b);
175  bool getFlagLightTravelTime(void) const {return flagLightTravelTime;}
176 
178  void setFontSize(float newFontSize);
179 
186  void setLabelsColor(const Vec3f& c);
188  const Vec3f& getLabelsColor(void) const;
189 
196  void setOrbitsColor(const Vec3f& c);
198  Vec3f getOrbitsColor(void) const;
199 
206  void setTrailsColor(const Vec3f& c) {trailColor=c;}
208  Vec3f getTrailsColor() const {return trailColor;}
209 
216  void setPointersColor(const Vec3f& c) {pointerColor=c;}
218  Vec3f getPointersColor() const {return pointerColor;}
219 
221  void setFlagMoonScale(bool b);
223  bool getFlagMoonScale(void) const {return flagMoonScale;}
224 
226  void setMoonScale(double f);
228  float getMoonScale(void) const {return moonScale;}
229 
231  void updateI18n();
232 
237  float getPlanetVMagnitude(QString planetName, bool withExtinction=false) const;
238 
242  QString getPlanetType(QString planetName) const;
243 
247  double getDistanceToPlanet(QString planetName) const;
248 
252  double getElongationForPlanet(QString planetName) const;
253 
257  double getPhaseAngleForPlanet(QString planetName) const;
258 
262  float getPhaseForPlanet(QString planetName) const;
263 
277  void setApparentMagnitudeAlgorithmOnEarth(QString algorithm);
278 
280  QString getApparentMagnitudeAlgorithmOnEarth() const;
281 
282 public:
284  // Other public methods
288  PlanetP searchByEnglishName(QString planetEnglishName) const;
289 
291  PlanetP getSun() const {return sun;}
292 
294  PlanetP getEarth() const {return earth;}
295 
297  PlanetP getMoon() const {return moon;}
298 
300  bool nearLunarEclipse();
301 
303  QStringList getAllPlanetEnglishNames() const;
304 
306  QStringList getAllPlanetLocalizedNames() const;
307 
309  void reloadPlanets();
310 
312  // DEPRECATED
318  QString getPlanetHashString();
319 
324  void computePositions(double date, const Vec3d& observerPos = Vec3d(0.));
325 
328  const QList<PlanetP>& getAllPlanets() const {return systemPlanets;}
329 
330 private slots:
332  void selectedObjectChange(StelModule::StelModuleSelectAction action);
333 
335  void setStelStyle(const QString& section);
336 
337 
338 private:
344  StelObjectP search(Vec3d v, const StelCore* core) const;
345 
348  void computeTransMatrices(double date, const Vec3d& observerPos = Vec3d(0.));
349 
351  void drawPointer(const StelCore* core);
352 
357  void loadPlanets();
358 
360  bool loadPlanets(const QString& filePath);
361 
362  void recreateTrails();
363 
364 
366  int shadowPlanetCount;
367  PlanetP sun;
368  PlanetP moon;
369  PlanetP earth;
370 
373  void setSelected(const QString& englishName);
375  void setSelected(PlanetP obj);
377  PlanetP getSelected(void) const {return selected;}
379  PlanetP selected;
380 
381  // Moon scale value
382  bool flagMoonScale;
383  float moonScale;
384 
385  QFont planetNameFont;
386 
388  float labelsAmount;
389 
391  QList<PlanetP> systemPlanets;
392 
393  // Master settings
394  bool flagOrbits;
395  bool flagLightTravelTime;
396 
398  StelTextureSP texPointer;
399 
400  bool flagShow;
401  bool flagMarker;
402 
403  class TrailGroup* allTrails;
404  LinearFader trailFader;
405  Vec3f trailColor;
406  Vec3f pointerColor;
407 
409  // DEPRECATED
411  QList<Orbit*> orbits; // Pointers on created elliptical orbits
412 };
413 
414 
415 #endif // _SOLARSYSTEM_HPP_
double getElongationForPlanet(QString planetName) const
Get elongation for Solar system bodies from scripts.
void setLabelsAmount(float a)
Set the amount of planet labels.
float getPhaseForPlanet(QString planetName) const
Get phase for Solar system bodies from scripts.
Definition: Orbit.hpp:22
virtual void update(double deltaTime)
Update time-varying components.
QStringList getAllPlanetEnglishNames() const
Get the list of all the planet english names.
void setFlagOrbits(bool b)
Set flag which determines if planet orbits are drawn or hidden.
bool getFlagMoonScale(void) const
Get the current value of the flag which determines if Earth's moon is scaled or not.
QString getApparentMagnitudeAlgorithmOnEarth() const
Get the algorithm used for computation of apparent magnitudes for planets in case observer on the Ear...
virtual double getCallOrder(StelModuleActionName actionName) const
Used to determine what order to draw the various StelModules.
void setFlagMoonScale(bool b)
Set flag which determines if Earth's moon is scaled or not.
PlanetP getSun() const
Get the Planet object pointer for the Sun.
PlanetP getEarth() const
Get the Planet object pointer for the Earth.
Class used to translate strings to any language.
Implementation of StelFader which implements a linear transition.
Definition: StelFader.hpp:77
The base abstract class for sky objects used in Stellarium like Stars, Planets, Constellations etc...
Definition: StelObject.hpp:36
void reloadPlanets()
Reload the planets.
Define the StelTextureSP type.
float getLabelsAmount(void) const
Get the amount of planet labels.
bool nearLunarEclipse()
Determine if a lunar eclipse is close at hand?
Main class for Stellarium core processing.
Definition: StelCore.hpp:46
bool getFlagMarkers() const
Get the current value of the flag which determines if planet markers are drawn or hidden...
virtual QStringList listMatchingObjectsI18n(const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
Find objects by translated name prefix.
PlanetP getMoon() const
Get the Planet object pointer for Earth's moon.
bool getFlagTrails() const
Get the current value of the flag which determines if planet trails are drawn or hidden.
void setFlagHints(bool b)
Set flag which determines if planet hints are drawn or hidden along labels.
void setPointersColor(const Vec3f &c)
Set the color used to draw planet pointers.
Vec3f getPointersColor() const
Get the current color used to draw planet pointers.
float getMoonScale(void) const
Get the display scaling factor for Earth's oon.
bool getFlagLightTravelTime(void) const
Get the current value of the flag which determines if light travel time calculation is used or not...
void setFlagLabels(bool b)
Set flag which determines if planet labels are drawn or hidden.
void setApparentMagnitudeAlgorithmOnEarth(QString algorithm)
Set the algorithm for computation of apparent magnitudes for planets in case observer on the Earth...
bool getFlagLabels() const
Get the current value of the flag which determines if planet labels are drawn or hidden.
bool getFlagPlanets() const
Get the current value of the flag which determines if planet are drawn or hidden. ...
Specialization of StelModule which manages a collection of StelObject.
virtual QList< StelObjectP > searchAround(const Vec3d &v, double limitFov, const StelCore *core) const
Search for SolarSystem objects in some area around a point.
const QList< PlanetP > & getAllPlanets() const
Get the list of all the bodies of the solar system.
void setOrbitsColor(const Vec3f &c)
Set the color used to draw planet orbit lines.
This StelObjectModule derivative is used to model SolarSystem bodies.
Definition: SolarSystem.hpp:46
Vec3f getTrailsColor() const
Get the current color used to draw planet trails lines.
Provide the main interface to all operations of projecting coordinates from sky to screen...
double getDistanceToPlanet(QString planetName) const
Get distance to Solar system bodies from scripts.
QStringList getAllPlanetLocalizedNames() const
Get the list of all the planet localized names.
Vec3f getOrbitsColor(void) const
Get the current color used to draw planet orbit lines.
double getPhaseAngleForPlanet(QString planetName) const
Get phase angle for Solar system bodies from scripts.
virtual void init()
Initialize the SolarSystem.
StelModuleActionName
Define the possible action for which an order is defined.
Definition: StelModule.hpp:117
void setFlagMarkers(bool b)
Set flag which determines if planet markers are drawn or hidden.
virtual QStringList listMatchingObjects(const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
Find objects by translated name prefix.
virtual StelObjectP searchByNameI18n(const QString &nameI18n) const
Search for a SolarSystem object based on the localised name.
void computePositions(double date, const Vec3d &observerPos=Vec3d(0.))
Compute the position and transform matrix for every element of the solar system.
void setLabelsColor(const Vec3f &c)
Set the color used to draw planet labels.
StelModuleSelectAction
Enum used when selecting objects to define whether to add to, replace, or remove from the existing se...
Definition: StelModule.hpp:109
void setTrailsColor(const Vec3f &c)
Set the color used to draw planet trails lines.
void setFontSize(float newFontSize)
Set planet names font size.
bool getFlagOrbits() const
Get the current value of the flag which determines if planet orbits are drawn or hidden.
void setMoonScale(double f)
Set the display scaling factor for Earth's moon.
void updateI18n()
Translate names. (public so that SolarSystemEditor can call it).
virtual void deinit()
Called before the module will be delete, and before the openGL context is suppressed.
QSharedPointer< StelTexture > StelTextureSP
Use shared pointer to simplify memory managment.
bool getFlagHints() const
Get the current value of the flag which determines if planet hints are drawn or hidden along labels...
void setFlagPlanets(bool b)
Set flag which determines if planets are drawn or hidden.
QString getPlanetType(QString planetName) const
Get type for Solar system bodies from scripts.
float getPlanetVMagnitude(QString planetName, bool withExtinction=false) const
Get the V magnitude for Solar system bodies from scripts.
const Vec3f & getLabelsColor(void) const
Get the current color used to draw planet labels.
QString getPlanetHashString()
Get a hash of locale and ssystem.ini names for use with the TUI.
void setFlagTrails(bool b)
Set flag which determines if planet trails are drawn or hidden.
void setFlagLightTravelTime(bool b)
Set flag which determines if the light travel time calculation is used or not.
PlanetP searchByEnglishName(QString planetEnglishName) const
Get a pointer to a Planet object.
virtual void draw(StelCore *core)
Draw SolarSystem objects (planets).
virtual StelObjectP searchByName(const QString &name) const
Search for a SolarSystem object based on the English name.