Exoplanets.hpp

/*
 * Copyright (C) 2012 Alexander Wolf
 *
 * 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 _EXOPLANETS_HPP_
#define _EXOPLANETS_HPP_

#include "StelObjectModule.hpp"
#include "StelObject.hpp"
#include "StelFader.hpp"
#include "StelTextureTypes.hpp"
#include "Exoplanet.hpp"
#include <QFont>
#include <QVariantMap>
#include <QDateTime>
#include <QList>
#include <QSharedPointer>

class QNetworkAccessManager;
class QNetworkReply;
class QSettings;
class QTimer;
class ExoplanetsDialog;
class StelPainter;
class StelButton;

typedef QSharedPointer<Exoplanet> ExoplanetP;

class Exoplanets : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool showExoplanets
           READ getFlagShowExoplanets
           WRITE setFlagShowExoplanets
           NOTIFY flagExoplanetsVisibilityChanged
           )
public: 
    enum UpdateState {
        Updating,       
        CompleteNoUpdates,  
        CompleteUpdates,    
        DownloadError,      
        OtherError      
    };
    
    Exoplanets();
    virtual ~Exoplanets();

    // Methods defined in the StelModule class
    virtual void init();
    virtual void deinit();
    virtual void update(double deltaTime);
    virtual void draw(StelCore* core);
    virtual void drawPointer(StelCore* core, StelPainter& painter);
    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 QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=true) const;

    virtual QStringList listAllObjects(bool inEnglish) const;

    virtual QString getName() const { return "Exoplanets"; }

    ExoplanetP getByID(const QString& id);

    virtual bool configureGui(bool show=true);

    void restoreDefaults(void);

    void loadConfiguration(void);

    void saveConfiguration(void);

    bool getUpdatesEnabled(void) {return updatesEnabled;}
    void setUpdatesEnabled(bool b) {updatesEnabled=b;}

    void setEnableAtStartup(bool b) { enableAtStartup=b; }
    bool getEnableAtStartup(void) { return enableAtStartup; }

    QDateTime getLastUpdate(void) {return lastUpdate;}

    int getUpdateFrequencyHours(void) {return updateFrequencyHours;}
    void setUpdateFrequencyHours(int hours) {updateFrequencyHours = hours;}

    int getSecondsToUpdate(void);

    UpdateState getUpdateState(void) {return updateState;}

    QList<double> getExoplanetsData(int mode)
    {
        switch(mode)
        {
            case 1:
                return EPSemiAxisAll;
                break;
            case 2:
                return EPMassAll;
                break;
            case 3:
                return EPRadiusAll;
                break;
            case 4:
                return EPPeriodAll;
                break;
            case 5:
                return EPAngleDistanceAll;
                break;
            default:
                return EPEccentricityAll;
        }
    }

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

    void jsonUpdateComplete(void);

    void flagExoplanetsVisibilityChanged(bool b);

public slots:
    void updateJSON(void);

    void setFlagShowExoplanets(bool b);
    bool getFlagShowExoplanets(void) { return flagShowExoplanets; }

    void setFlagShowExoplanetsDesignations(bool b);
    bool getFlagShowExoplanetsDesignations(void);

    void setFlagShowExoplanetsButton(bool b);
    bool getFlagShowExoplanetsButton(void) { return flagShowExoplanetsButton; }

    bool getDisplayMode(void);
    void setDisplayMode(bool b);

    bool getTimelineMode(void);
    void setTimelineMode(bool b);

    bool getHabitableMode(void);
    void setHabitableMode(bool b);

    Vec3f getMarkerColor(bool habitable);
    void setMarkerColor(const Vec3f& c, bool h);

    int getCountPlanetarySystems(void) const
    {
        return PSCount;
    }

    int getCountAllExoplanets(void) const
    {
        return EPCountAll;
    }

    int getCountHabitableExoplanets(void) const
    {
        return EPCountPH;
    }

private:
    // Font used for displaying our text
    QFont font;

    // if existing, delete Satellites section in main config.ini, then create with default values
    void resetConfiguration(void);

    // Upgrade config.ini: rename old key settings to new
    void upgradeConfigIni(void);

    void restoreDefaultJsonFile(void);

    void readJsonFile(void);

    bool backupJsonFile(bool deleteOriginal=false);

    int getJsonFileFormatVersion(void);

    bool checkJsonFileFormat(void);

    QVariantMap loadEPMap(QString path=QString());

    void setEPMap(const QVariantMap& map);

    static void translations();

    QString jsonCatalogPath;

    int PSCount;
    int EPCountAll;
    int EPCountPH;

    QList<double> EPEccentricityAll, EPSemiAxisAll, EPMassAll, EPRadiusAll, EPPeriodAll, EPAngleDistanceAll;

    StelTextureSP texPointer;
    QList<ExoplanetP> ep;

    // variables and functions for the updater
    UpdateState updateState;
    QNetworkAccessManager* downloadMgr;
    QString updateUrl;  
    QTimer* updateTimer;
    QTimer* messageTimer;
    QList<int> messageIDs;
    bool updatesEnabled;
    QDateTime lastUpdate;
    int updateFrequencyHours;   
    bool enableAtStartup;

    QSettings* conf;

    // GUI
    ExoplanetsDialog* exoplanetsConfigDialog;
    bool flagShowExoplanets;
    bool flagShowExoplanetsButton;
    StelButton* toolbarButton;
    class StelProgressController* progressBar;

private slots:
    void checkForUpdate(void);
    void updateDownloadComplete(QNetworkReply* reply);

    void displayMessage(const QString& message, const QString hexColor="#999999");
    void messageTimeout(void);

    void reloadCatalog(void);
};



#include <QObject>
#include "StelPluginInterface.hpp"

class ExoplanetsStelPluginInterface : public QObject, public StelPluginInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID StelPluginInterface_iid)
    Q_INTERFACES(StelPluginInterface)
public:
    virtual StelModule* getStelModule() const;
    virtual StelPluginInfo getPluginInfo() const;
};

#endif /*_EXOPLANETS_HPP_*/