Observability.hpp

/*
 * Copyright (C) 2012 Ivan Marti-Vidal
 *
 * 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 OBSERVABILITY_HPP_
#define OBSERVABILITY_HPP_

#include "StelModule.hpp"
#include <QFont>
#include <QString>
#include <QPair>
#include "VecMath.hpp"
#include "SolarSystem.hpp"
#include "Planet.hpp"
#include "StelFader.hpp"

class QPixmap;
class StelButton;
class ObservabilityDialog;

class Observability : public StelModule
{
    Q_OBJECT
    Q_PROPERTY(bool flagShowReport
           READ isShownReport
           WRITE showReport
           NOTIFY flagReportVisibilityChanged
           )
public:
    Observability();
    virtual ~Observability();
    virtual void init();
    virtual void update(double) {;}
    virtual void draw(StelCore* core);
    virtual double getCallOrder(StelModuleActionName actionName) const;

    virtual bool configureGui(bool show=true);


    void loadConfiguration();

    bool getShowFlags(int);

    Vec3f getFontColor(void);
    
    int getFontSize(void);

    int getTwilightAltitude();

    int getHorizonAltitude();

    bool isShownReport() const {return flagShowReport;}

signals:
    void flagReportVisibilityChanged(bool b);

public slots:
    void resetConfiguration();
    void saveConfiguration();
    
    
    void enableTodayField(bool enabled = true);
    void enableAcroCosField(bool enabled = true);
    void enableGoodNightsField(bool enabled = true);
    void enableOppositionField(bool enabled = true);
    void enableFullMoonField(bool enabled = true);
    
    
    void setFontColor(const Vec3f& color);
    void setFontSize(int size);

    void setTwilightAltitude(int altitude);

    void setHorizonAltitude(int altitude);
    
    void showReport(bool b);

    
private slots:
    void updateMessageText();

    
private:
    ObservabilityDialog* configDialog;

    void setDateFormat(bool b) { dmyFormat=b; }
    bool getDateFormat(void) { return dmyFormat; }

    double calculateHourAngle(double latitude, double elevation, double declination);

    double HourAngle2(double RA, double ST);

    bool calculateSolarSystemEvents(StelCore* core, int bodyType);

    int calculateAcroCos(int& acroRise, int& acroSet, int& cosRise, int& cosSet);


    int calculateHeli(int imethod, int& heliRise, int& heliSet);


    void getSunMoonCoords(StelCore* core, QPair<double, double> JD,
                  double& raSun, double& decSun,
                  double& raMoon, double& decMoon,
                  double& eclLon, bool getBack);


    void getPlanetCoords(StelCore* core,QPair<double, double> JD,
                 double &RA, double &Dec, bool getBack);

    void getMoonDistance(StelCore* core, QPair<double, double> JD,
                 double& distance, bool getBack);

    double Lambda(double RA1, double Dec1, double RA2, double Dec2);

    void double2hms(double t, int &h,int &m,int &s);

    double sign(double d);

    QString formatAsDate(int dayNumber);

    QString formatAsDateRange(int startDay, int endDay);

    double toUnsignedRA(double RA);

    void updatePlanetData(StelCore* core);

    void updateSunData(StelCore* core);

    void updateSunH();

    void toRADec(Vec3d vec3d, double& ra, double& dec);

    QPair<double, double> yearJD[366]; // GZ: This had to become a QPair of JD.first=JD_UT, JD.second=JDE

    bool CheckRise(int day);

    // GZ: Made true constants out of those, and improved accuracy of some.
    static const double Rad2Deg, Rad2Hr, UA, TFrac, halfpi, MoonT, RefFullMoon, MoonPerilune;

    double nextFullMoon, prevFullMoon, GMTShift, Jan1stJD;

    double twilightAltRad;

    int twilightAltDeg;
    
    double refractedHorizonAlt;

    double horizonAltitude;

    int horizonAltDeg;

    double selRA, selDec, mylat, mylon, alti, horizH, culmAlt;

    QPair<double, double> myJD;

    double sunRA[366];
    double sunDec[366];

    double sunSidT[4][366];

    double objectRA[366]; 
    double objectDec[366];
    double objectH0[366];

    double objectSidT[2][366];

    double MoonRise, MoonSet, MoonCulm, lastJDMoon;

    Vec3d EarthPos[366];

    Vec3d ObserverLoc, Pos1, Pos2, RotObserver; //, Pos3;

    Mat4d LocTrans;

    Planet* myEarth;
    Planet* myMoon;
    Planet* myPlanet;

    int curYear;
    int nDays;

    QString selName;
    QString lineBestNight;
    QString lineObservableRange;
    QString lineAcroCos, lineHeli;

    QString RiseTime, SetTime, CulmTime;

    QStringList monthNames;

    bool dmyFormat;

    Vec3d EquPos, LocPos;

    bool isStar, isMoon, isSun, isScreen;

    bool hasRisen;
    bool configChanged;
    bool souChanged;
    int lastType;
    
    bool show_AcroCos, show_Good_Nights, show_Best_Night, show_Today, show_FullMoon; //, show_Crescent, show_SuperMoon;

    QFont font;
    Vec3f fontColor;
    bool flagShowReport;
    int fontSize;
    StelButton* button;

    QString msgSetsAt, msgRoseAt, msgSetAt, msgRisesAt, msgCircumpolar, msgNoRise, msgCulminatesAt, msgCulminatedAt, msgH, msgM, msgS;
    QString msgSrcNotObs, msgNoACRise, msgGreatElong, msgLargSSep, msgNone, msgAcroRise, msgNoAcroRise, msgCosmRise, msgNoCosmRise;
        QString msgHeliRise, msgHeliSet, msgNoHeliRise;
    QString msgWholeYear, msgNotObs, msgAboveHoriz, msgToday, msgThisYear, msgPrevFullMoon, msgNextFullMoon;

};


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

class ObservabilityStelPluginInterface : 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 /*OBSERVABILITY_HPP_*/