SolarSystem.hpp

/*
 * Stellarium
 * Copyright (C) 2002 Fabien Chereau
 * Copyright (c) 2010 Bogdan Marinov
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _SOLARSYSTEM_HPP_
#define _SOLARSYSTEM_HPP_
//sun is already defined in Sun C/Solaris
#if defined(sun)
#undef sun
#endif

#include "StelObjectModule.hpp"
#include "StelTextureTypes.hpp"
#include "Planet.hpp"
#include "StelGui.hpp"

#include <QFont>

class Orbit;
class StelTranslator;
class StelObject;
class StelCore;
class StelProjector;
class QSettings;

typedef QSharedPointer<Planet> PlanetP;

class SolarSystem : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool labelsDisplayed // This is a "forwarding property" which sets labeling into all planets.
           READ getFlagLabels
           WRITE setFlagLabels
           NOTIFY labelsDisplayedChanged)
    Q_PROPERTY(bool flagOrbits // was bool orbitsDisplayed
           READ getFlagOrbits
           WRITE setFlagOrbits
           NOTIFY flagOrbitsChanged)
    Q_PROPERTY(bool trailsDisplayed
           READ getFlagTrails
           WRITE setFlagTrails
           NOTIFY trailsDisplayedChanged)
    Q_PROPERTY(bool flagHints // was bool hintsDisplayed. This is a "forwarding property" only, without own variable.
           READ getFlagHints
           WRITE setFlagHints
           NOTIFY flagHintsChanged)
    Q_PROPERTY(bool flagPointer // was bool pointersDisplayed
           READ getFlagPointer
           WRITE setFlagPointer
           NOTIFY flagPointerChanged)
    Q_PROPERTY(bool flagNativePlanetNames // was bool nativeNamesDisplayed
           READ getFlagNativePlanetNames
           WRITE setFlagNativePlanetNames
           NOTIFY flagNativePlanetNamesChanged)
    Q_PROPERTY(bool flagTranslatedNames
           READ getFlagTranslatedNames
           WRITE setFlagTranslatedNames
           NOTIFY flagTranslatedNamesChanged)
    Q_PROPERTY(bool planetsDisplayed
           READ getFlagPlanets
           WRITE setFlagPlanets
           NOTIFY flagPlanetsDisplayedChanged
           )
    Q_PROPERTY(bool flagIsolatedOrbits
           READ getFlagIsolatedOrbits
           WRITE setFlagIsolatedOrbits
           NOTIFY flagIsolatedOrbitsChanged
           )
    Q_PROPERTY(bool flagIsolatedTrails
           READ getFlagIsolatedTrails
           WRITE setFlagIsolatedTrails
           NOTIFY flagIsolatedTrailsChanged
           )
    Q_PROPERTY(bool flagLightTravelTime
           READ getFlagLightTravelTime
           WRITE setFlagLightTravelTime
           NOTIFY flagLightTravelTimeChanged
           )
    Q_PROPERTY(bool flagUseObjModels
           READ getFlagUseObjModels
           WRITE setFlagUseObjModels
           NOTIFY flagUseObjModelsChanged
           )
    Q_PROPERTY(bool flagShowObjSelfShadows
           READ getFlagShowObjSelfShadows
           WRITE setFlagShowObjSelfShadows
           NOTIFY flagShowObjSelfShadowsChanged
           )
    Q_PROPERTY(bool flagMoonScale
           READ getFlagMoonScale
           WRITE setFlagMoonScale
           NOTIFY flagMoonScaleChanged
           )
    Q_PROPERTY(double moonScale
           READ getMoonScale
           WRITE setMoonScale
           NOTIFY moonScaleChanged
           )
    Q_PROPERTY(bool flagMinorBodyScale
           READ getFlagMinorBodyScale
           WRITE setFlagMinorBodyScale
           NOTIFY flagMinorBodyScaleChanged
           )
    Q_PROPERTY(double minorBodyScale
           READ getMinorBodyScale
           WRITE setMinorBodyScale
           NOTIFY minorBodyScaleChanged
           )
    Q_PROPERTY(double labelsAmount
           READ getLabelsAmount
           WRITE setLabelsAmount
           NOTIFY labelsAmountChanged
           )
    Q_PROPERTY(bool ephemerisMarkersDisplayed
           READ getFlagEphemerisMarkers
           WRITE setFlagEphemerisMarkers
           NOTIFY ephemerisMarkersChanged
           )
    Q_PROPERTY(bool ephemerisHorizontalCoordinates
           READ getFlagEphemerisHorizontalCoordinates
           WRITE setFlagEphemerisHorizontalCoordinates
           NOTIFY ephemerisHorizontalCoordinatesChanged
           )
    Q_PROPERTY(bool ephemerisDatesDisplayed
           READ getFlagEphemerisDates
           WRITE setFlagEphemerisDates
           NOTIFY ephemerisDatesChanged
           )    
    Q_PROPERTY(bool ephemerisMagnitudesDisplayed
           READ getFlagEphemerisMagnitudes
           WRITE setFlagEphemerisMagnitudes
           NOTIFY ephemerisMagnitudesChanged
           )

    Q_PROPERTY(bool flagCustomGrsSettings
           READ getFlagCustomGrsSettings
           WRITE setFlagCustomGrsSettings
           NOTIFY flagCustomGrsSettingsChanged
           )
    Q_PROPERTY(int customGrsLongitude
           READ getCustomGrsLongitude
           WRITE setCustomGrsLongitude
           NOTIFY customGrsLongitudeChanged
           )
    Q_PROPERTY(double customGrsDrift
           READ getCustomGrsDrift
           WRITE setCustomGrsDrift
           NOTIFY customGrsDriftChanged
           )
    Q_PROPERTY(double customGrsJD
           READ getCustomGrsJD
           WRITE setCustomGrsJD
           NOTIFY customGrsJDChanged
           )

    // Colors
    Q_PROPERTY(Vec3f orbitsColor
           READ getOrbitsColor
           WRITE setOrbitsColor
           NOTIFY orbitsColorChanged
           )
    Q_PROPERTY(Vec3f majorPlanetsOrbitsColor
           READ getMajorPlanetsOrbitsColor
           WRITE setMajorPlanetsOrbitsColor
           NOTIFY majorPlanetsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f minorPlanetsOrbitsColor
           READ getMinorPlanetsOrbitsColor
           WRITE setMinorPlanetsOrbitsColor
           NOTIFY minorPlanetsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f dwarfPlanetsOrbitsColor
           READ getDwarfPlanetsOrbitsColor
           WRITE setDwarfPlanetsOrbitsColor
           NOTIFY dwarfPlanetsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f moonsOrbitsColor
           READ getMoonsOrbitsColor
           WRITE setMoonsOrbitsColor
           NOTIFY moonsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f cubewanosOrbitsColor
           READ getCubewanosOrbitsColor
           WRITE setCubewanosOrbitsColor
           NOTIFY cubewanosOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f plutinosOrbitsColor
           READ getPlutinosOrbitsColor
           WRITE setPlutinosOrbitsColor
           NOTIFY plutinosOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f scatteredDiskObjectsOrbitsColor
           READ getScatteredDiskObjectsOrbitsColor
           WRITE setScatteredDiskObjectsOrbitsColor
           NOTIFY scatteredDiskObjectsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f oortCloudObjectsOrbitsColor
           READ getOortCloudObjectsOrbitsColor
           WRITE setOortCloudObjectsOrbitsColor
           NOTIFY oortCloudObjectsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f cometsOrbitsColor
           READ getCometsOrbitsColor
           WRITE setCometsOrbitsColor
           NOTIFY cometsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f sednoidsOrbitsColor
           READ getSednoidsOrbitsColor
           WRITE setSednoidsOrbitsColor
           NOTIFY sednoidsOrbitsColorChanged
           )
    Q_PROPERTY(Vec3f mercuryOrbitColor
           READ getMercuryOrbitColor
           WRITE setMercuryOrbitColor
           NOTIFY mercuryOrbitColorChanged
           )
    Q_PROPERTY(Vec3f venusOrbitColor
           READ getVenusOrbitColor
           WRITE setVenusOrbitColor
           NOTIFY venusOrbitColorChanged
           )
    Q_PROPERTY(Vec3f earthOrbitColor
           READ getEarthOrbitColor
           WRITE setEarthOrbitColor
           NOTIFY earthOrbitColorChanged
           )
    Q_PROPERTY(Vec3f marsOrbitColor
           READ getMarsOrbitColor
           WRITE setMarsOrbitColor
           NOTIFY marsOrbitColorChanged
           )
    Q_PROPERTY(Vec3f jupiterOrbitColor
           READ getJupiterOrbitColor
           WRITE setJupiterOrbitColor
           NOTIFY jupiterOrbitColorChanged
           )
    Q_PROPERTY(Vec3f saturnOrbitColor
           READ getSaturnOrbitColor
           WRITE setSaturnOrbitColor
           NOTIFY saturnOrbitColorChanged
           )
    Q_PROPERTY(Vec3f uranusOrbitColor
           READ getUranusOrbitColor
           WRITE setUranusOrbitColor
           NOTIFY uranusOrbitColorChanged
           )
    Q_PROPERTY(Vec3f neptuneOrbitColor
           READ getNeptuneOrbitColor
           WRITE setNeptuneOrbitColor
           NOTIFY neptuneOrbitColorChanged
           )

    // Color style
    Q_PROPERTY(QString orbitColorStyle
           READ getOrbitColorStyle
           WRITE setOrbitColorStyle
           NOTIFY orbitColorStyleChanged
           )

public:
    SolarSystem();
    virtual ~SolarSystem();

    // Methods defined in the StelModule class
    virtual void init();

    virtual void deinit();
    
    virtual void draw(StelCore *core);

    virtual void update(double deltaTime);

    virtual double getCallOrder(StelModuleActionName actionName) const;

    // Methods defined in StelObjectManager class
    virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;

    virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;

    virtual StelObjectP searchByName(const QString& name) const;

    virtual StelObjectP searchByID(const QString &id) const
    {
        return searchByName(id);
    }

    virtual QStringList listAllObjects(bool inEnglish) const;
    virtual QStringList listAllObjectsByType(const QString& objType, bool inEnglish) const;
    virtual QString getName() const { return "Solar System"; }
    virtual QString getStelObjectType() const { return Planet::PLANET_TYPE; }

public slots:
    // Method callable from script and GUI
    // Properties setters and getters
    void setFlagPlanets(bool b);
    bool getFlagPlanets() const;

    void setFlagTrails(bool b);
    bool getFlagTrails() const;

    void setFlagHints(bool b);
    bool getFlagHints() const;

    void setFlagLabels(bool b);
    bool getFlagLabels() const;

    void setLabelsAmount(double a) {if(a!=labelsAmount) {labelsAmount=a; emit labelsAmountChanged(a);}}
    double getLabelsAmount(void) const {return labelsAmount;}

    void setFlagOrbits(bool b);
    bool getFlagOrbits() const {return flagOrbits;}

    void setFlagPointer(bool b) { if (b!=flagPointer) { flagPointer=b; emit flagPointerChanged(b); }}
    bool getFlagPointer() const { return flagPointer;}

    void setFlagLightTravelTime(bool b);
    bool getFlagLightTravelTime(void) const {return flagLightTravelTime;}

    void setFlagUseObjModels(bool b) { if(b!=flagUseObjModels) { flagUseObjModels = b; emit flagUseObjModelsChanged(b); } }
    bool getFlagUseObjModels(void) const { return flagUseObjModels; }

    void setFlagShowObjSelfShadows(bool b);
    bool getFlagShowObjSelfShadows(void) const { return flagShowObjSelfShadows; }

    void setFontSize(float newFontSize);

    void setLabelsColor(const Vec3f& c);
    const Vec3f& getLabelsColor(void) const;

    void setOrbitsColor(const Vec3f& c);
    Vec3f getOrbitsColor(void) const;

    void setMajorPlanetsOrbitsColor(const Vec3f& c);
    Vec3f getMajorPlanetsOrbitsColor(void) const;

    void setMoonsOrbitsColor(const Vec3f& c);
    Vec3f getMoonsOrbitsColor(void) const;

    void setMinorPlanetsOrbitsColor(const Vec3f& c);
    Vec3f getMinorPlanetsOrbitsColor(void) const;

    void setDwarfPlanetsOrbitsColor(const Vec3f& c);
    Vec3f getDwarfPlanetsOrbitsColor(void) const;

    void setCubewanosOrbitsColor(const Vec3f& c);
    Vec3f getCubewanosOrbitsColor(void) const;

    void setPlutinosOrbitsColor(const Vec3f& c);
    Vec3f getPlutinosOrbitsColor(void) const;

    void setScatteredDiskObjectsOrbitsColor(const Vec3f& c);
    Vec3f getScatteredDiskObjectsOrbitsColor(void) const;

    void setOortCloudObjectsOrbitsColor(const Vec3f& c);
    Vec3f getOortCloudObjectsOrbitsColor(void) const;

    void setCometsOrbitsColor(const Vec3f& c);
    Vec3f getCometsOrbitsColor(void) const;

    void setSednoidsOrbitsColor(const Vec3f& c);
    Vec3f getSednoidsOrbitsColor(void) const;

    void setMercuryOrbitColor(const Vec3f& c);
    Vec3f getMercuryOrbitColor(void) const;

    void setVenusOrbitColor(const Vec3f& c);
    Vec3f getVenusOrbitColor(void) const;

    void setEarthOrbitColor(const Vec3f& c);
    Vec3f getEarthOrbitColor(void) const;

    void setMarsOrbitColor(const Vec3f& c);
    Vec3f getMarsOrbitColor(void) const;

    void setJupiterOrbitColor(const Vec3f& c);
    Vec3f getJupiterOrbitColor(void) const;

    void setSaturnOrbitColor(const Vec3f& c);
    Vec3f getSaturnOrbitColor(void) const;

    void setUranusOrbitColor(const Vec3f& c);
    Vec3f getUranusOrbitColor(void) const;

    void setNeptuneOrbitColor(const Vec3f& c);
    Vec3f getNeptuneOrbitColor(void) const;

    void setTrailsColor(const Vec3f& c) {trailColor=c;}
    Vec3f getTrailsColor() const {return trailColor;}

    void setPointerColor(const Vec3f& c) {pointerColor=c;}
    Vec3f getPointerColor() const {return pointerColor;}

    void setFlagMoonScale(bool b);
    bool getFlagMoonScale(void) const {return flagMoonScale;}

    void setMoonScale(double f);
    double getMoonScale(void) const {return moonScale;}

    void setFlagMinorBodyScale(bool b);
    bool getFlagMinorBodyScale(void) const {return flagMinorBodyScale;}

    void setMinorBodyScale(double f);
    double getMinorBodyScale(void) const {return minorBodyScale;}

    void updateI18n();

    float getPlanetVMagnitude(QString planetName, bool withExtinction=false) const;

    QString getPlanetType(QString planetName) const;

    double getDistanceToPlanet(QString planetName) const;

    double getElongationForPlanet(QString planetName) const;

    double getPhaseAngleForPlanet(QString planetName) const;

    float getPhaseForPlanet(QString planetName) const;

    void setApparentMagnitudeAlgorithmOnEarth(QString algorithm);

    QString getApparentMagnitudeAlgorithmOnEarth() const;

    void setFlagNativePlanetNames(bool b);
    bool getFlagNativePlanetNames(void) const;

    void setFlagTranslatedNames(bool b);
    bool getFlagTranslatedNames(void) const;

    void setFlagIsolatedTrails(bool b);
    bool getFlagIsolatedTrails(void) const;

    void setFlagIsolatedOrbits(bool b);
    bool getFlagIsolatedOrbits(void) const;

    void setFlagCustomGrsSettings(bool b);
    bool getFlagCustomGrsSettings();

    void setCustomGrsLongitude(int longitude);
    int getCustomGrsLongitude();

    void setCustomGrsDrift(double drift);
    double getCustomGrsDrift();

    // TODO (GZ): Clarify whether this is JD or rather JDE?
    void setCustomGrsJD(double JD);
    double getCustomGrsJD();

    void setOrbitColorStyle(QString style);
    QString getOrbitColorStyle() const;

    QStringList getObjectsList(QString objType="all") const;

signals:
    void labelsDisplayedChanged(bool b);
    void flagOrbitsChanged(bool b);
    void flagHintsChanged(bool b);
    void trailsDisplayedChanged(bool b);
    void flagPointerChanged(bool b);
    void flagNativePlanetNamesChanged(bool b);
    void flagTranslatedNamesChanged(bool b);
    void flagPlanetsDisplayedChanged(bool b);
    void flagIsolatedOrbitsChanged(bool b);
    void flagIsolatedTrailsChanged(bool b);
    void flagLightTravelTimeChanged(bool b);
    void flagUseObjModelsChanged(bool b);
    void flagShowObjSelfShadowsChanged(bool b);
    void flagMoonScaleChanged(bool b);
    void moonScaleChanged(double f);
    void flagMinorBodyScaleChanged(bool b);
    void minorBodyScaleChanged(double f);
    void labelsAmountChanged(double f);
    void ephemerisMarkersChanged(bool b);
    void ephemerisHorizontalCoordinatesChanged(bool b);
    void ephemerisDatesChanged(bool b);
    void ephemerisMagnitudesChanged(bool b);
    void flagCustomGrsSettingsChanged(bool b);
    void customGrsLongitudeChanged(int l);
    void customGrsDriftChanged(double drift);
    void customGrsJDChanged(double JD);

    void orbitsColorChanged(const Vec3f & color) const;
    void majorPlanetsOrbitsColorChanged(const Vec3f & color) const;
    void minorPlanetsOrbitsColorChanged(const Vec3f & color) const;
    void dwarfPlanetsOrbitsColorChanged(const Vec3f & color) const;
    void moonsOrbitsColorChanged(const Vec3f & color) const;
    void cubewanosOrbitsColorChanged(const Vec3f & color) const;
    void plutinosOrbitsColorChanged(const Vec3f & color) const;
    void scatteredDiskObjectsOrbitsColorChanged(const Vec3f & color) const;
    void oortCloudObjectsOrbitsColorChanged(const Vec3f & color) const;
    void cometsOrbitsColorChanged(const Vec3f & color) const;
    void sednoidsOrbitsColorChanged(const Vec3f & color) const;
    void mercuryOrbitColorChanged(const Vec3f & color) const;
    void venusOrbitColorChanged(const Vec3f & color) const;
    void earthOrbitColorChanged(const Vec3f & color) const;
    void marsOrbitColorChanged(const Vec3f & color) const;
    void jupiterOrbitColorChanged(const Vec3f & color) const;
    void saturnOrbitColorChanged(const Vec3f & color) const;
    void uranusOrbitColorChanged(const Vec3f & color) const;
    void neptuneOrbitColorChanged(const Vec3f & color) const;

    void orbitColorStyleChanged(QString style) const;

    void solarSystemDataReloaded();

public:
    // Other public methods
    PlanetP searchByEnglishName(QString planetEnglishName) const;

    PlanetP searchMinorPlanetByEnglishName(QString planetEnglishName) const;

    PlanetP getSun() const {return sun;}

    PlanetP getEarth() const {return earth;}

    PlanetP getMoon() const {return moon;}

    bool nearLunarEclipse();

    QStringList getAllPlanetEnglishNames() const;

    QStringList getAllPlanetLocalizedNames() const;

    QStringList getAllMinorPlanetCommonEnglishNames() const;

    void reloadPlanets();

    bool removeMinorPlanet(QString name);

    double getEclipseFactor(const StelCore *core) const;

    void computePositions(double dateJDE, PlanetP observerPlanet);

    const QList<PlanetP>& getAllPlanets() const {return systemPlanets;}
    const QList<PlanetP>& getAllMinorBodies() const {return systemMinorBodies;}
    const QStringList getMinorBodiesList() const { return minorBodies; }

    const Vec3d getLightTimeSunPosition() const { return lightTimeSunPosition; }

private slots:
    void selectedObjectChange(StelModule::StelModuleSelectAction action);

    void updateSkyCulture(const QString& skyCultureDir);

    void reloadShaders();

    void setFlagEphemerisMarkers(bool b);
    bool getFlagEphemerisMarkers() const;

    void setFlagEphemerisHorizontalCoordinates(bool b);
    bool getFlagEphemerisHorizontalCoordinates() const;

    void setFlagEphemerisDates(bool b);
    bool getFlagEphemerisDates() const;

    void setFlagEphemerisMagnitudes(bool b);
    bool getFlagEphemerisMagnitudes() const;

private:
    StelObjectP search(Vec3d v, const StelCore* core) const;

    void computeTransMatrices(double dateJDE, const Vec3d& observerPos = Vec3d(0.));

    void drawPointer(const StelCore* core);

    void loadPlanets();

    bool loadPlanets(const QString& filePath);

    void recreateTrails();

    unsigned char BvToColorIndex(float bV);

    void setFlagPermanentOrbits(bool b);

    int shadowPlanetCount;
    PlanetP sun;
    PlanetP moon;
    PlanetP earth;

    void setSelected(const QString& englishName);
    void setSelected(PlanetP obj);
    PlanetP getSelected(void) const {return selected;}
    PlanetP selected;

    // Separate Moon and minor body scale values. The latter make sense to zoom up and observe irregularly formed 3D objects like minor moons of the outer planets.
    // TBD: It may be wise to remove the sphereScale value from the Planet class: that is only used by the Moon.
    bool flagMoonScale;
    double moonScale;
    bool flagMinorBodyScale;
    double minorBodyScale;

    QFont planetNameFont;

    double labelsAmount;

    QList<PlanetP> systemPlanets;
    QList<PlanetP> systemMinorBodies;

    // Master settings
    bool flagOrbits;
    bool flagLightTravelTime;
    bool flagUseObjModels;
    bool flagShowObjSelfShadows;

    StelTextureSP texPointer;
    StelTextureSP texCircle;                    // The symbolic circle texture

    bool flagShow;
    bool flagPointer;                           // show red cross selection pointer?
    bool flagNativePlanetNames;                 // show native names for planets?
    bool flagTranslatedNames;                   // show translated names?
    bool flagIsolatedTrails;
    bool flagIsolatedOrbits;
    bool ephemerisMarkersDisplayed;
    bool ephemerisDatesDisplayed;
    bool ephemerisMagnitudesDisplayed;
    bool ephemerisHorizontalCoordinates;

    class TrailGroup* allTrails;
    StelGui* gui;
    QSettings* conf;
    LinearFader trailFader;
    Vec3f trailColor;
    Vec3f pointerColor;

    QHash<QString, QString> planetNativeNamesMap;
    QStringList minorBodies;

    Vec3d lightTimeSunPosition;         // when observing a solar eclipse, we need solar position 8 minutes ago.
                            // Direct shift caused problems (LP:#1699648), circumvented with this construction.
    // 0.16pre observation GZ: this list contains pointers to all orbit objects,
    // while the planets don't own their orbit objects.
    // Would it not be better to hand over the orbit object ownership to the Planet object?
    // This list could then be removed.
    // In case this was originally intended to provide some fast access for time-dependent computation with the same JD,
    // note that we must also always compensate to light time travel, so likely each computation has to be done twice,
    // with current JDE and JDE-lightTime(distance).
    QList<Orbit*> orbits;           // Pointers on created elliptical orbits. 0.16pre: WHY DO WE NEED THIS???
};


#endif // _SOLARSYSTEM_HPP_