ArchaeoLines.hpp

/*
 * Copyright (C) 2014 Georg Zotti
 *
 * 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 ARCHAEOLINES_HPP_
#define ARCHAEOLINES_HPP_

#include <QFont>
#include <QColor>
#include <QKeyEvent>
#include "VecMath.hpp"
#include "StelModule.hpp"
#include "StelFader.hpp"
#include "StelCore.hpp"
#include "StelObjectMgr.hpp"

class QTimer;
class QPixmap;
class StelButton;
class ArchaeoLinesDialog;
class ArchaeoLine;

class ArchaeoLine : QObject
{
    Q_OBJECT
    Q_PROPERTY(Vec3f color READ getColor WRITE setColor NOTIFY colorChanged)
    Q_PROPERTY(bool flagLabel READ isLabelVisible WRITE setLabelVisible NOTIFY flagLabelChanged)
    Q_PROPERTY(double definingAngle READ getDefiningAngle WRITE setDefiningAngle NOTIFY definingAngleChanged)

    //Need to register Enum with Qt to be able to use it as Q_PROPERTY
    //or in signals/slots
    Q_ENUMS(Line)
public:
    enum Line { // we must start with the planet lines to allow proper handling in the combobox.
        CurrentPlanetNone, // actually a placeholder for counting/testing. By itself it makes no sense, i.e. deactivates the planet line
        CurrentPlanetMercury,
        CurrentPlanetVenus,
        CurrentPlanetMars,
        CurrentPlanetJupiter,
        CurrentPlanetSaturn,
        Equinox,
        Solstices,
        Crossquarters,
        MajorStandstill,
        MinorStandstill,
        ZenithPassage,
        NadirPassage,
        SelectedObject,
        CurrentSun,
        CurrentMoon,
        CustomDeclination1,
        CustomDeclination2,
        GeographicLocation1, // The following types are in altaz frame!
        GeographicLocation2,
        CustomAzimuth1,
        CustomAzimuth2
    };

    ArchaeoLine(ArchaeoLine::Line lineType, double definingAngle);
    virtual ~ArchaeoLine(){}
    void draw(StelCore* core, float intensity=1.0f) const;
    const Vec3f& getColor() const {return color;}
    bool isDisplayed(void) const {return fader;}
signals:
    void colorChanged(Vec3f c);
    void flagLabelChanged(bool on);
    void definingAngleChanged(double angle);
public slots:
    void setColor(const Vec3f& c);
    void update(double deltaTime) {fader.update((int)(deltaTime*1000));}
    void setFadeDuration(float duration) {fader.setDuration((int)(duration*1000.f));}
    void setDisplayed(const bool displayed){fader = displayed;}
    void setFontSize(double newSize){font.setPixelSize(newSize);}
    void setDefiningAngle(double angle);
    double getDefiningAngle(void) const {return definingAngle;} // returns declination for most, or azimuth.
    void updateLabel();
    void setLabelVisible(bool b);
    bool isLabelVisible() const{return flagLabel;}
    void setLineType(ArchaeoLine::Line line) {lineType=line; updateLabel();} // Meaningful only for CurrentPlanet... types
    void setLabel(const QString newLabel){label=newLabel;}
    QString getLabel() const {return label;}

private:
    ArchaeoLine::Line lineType;
    double definingAngle; // degrees. This is declination for non-azimuth lines, azimuth for geographic locations and custom azimuths.
    Vec3f color;
    StelCore::FrameType frameType;
    bool flagLabel; 
    QString label;
    LinearFader fader;
    QFont font;
};

class ArchaeoLines : public StelModule
{
    Q_OBJECT
    Q_PROPERTY(bool enabled
           READ isEnabled
           WRITE enableArchaeoLines
           NOTIFY archaeoLinesEnabledChanged)
    Q_PROPERTY(bool flagShowEquinox
                READ   isEquinoxDisplayed
                WRITE  showEquinox
                NOTIFY showEquinoxChanged
           )
    Q_PROPERTY(bool flagShowSolstices
                READ   isSolsticesDisplayed
                WRITE  showSolstices
                NOTIFY showSolsticesChanged
           )
    Q_PROPERTY(bool flagShowCrossquarters
                READ   isCrossquartersDisplayed
                WRITE  showCrossquarters
                NOTIFY showCrossquartersChanged
           )
    Q_PROPERTY(bool flagShowMajorStandstills
                READ   isMajorStandstillsDisplayed
                WRITE  showMajorStandstills
                NOTIFY showMajorStandstillsChanged
           )
    Q_PROPERTY(bool flagShowMinorStandstills
                READ   isMinorStandstillsDisplayed
                WRITE  showMinorStandstills
                NOTIFY showMinorStandstillsChanged
           )
    Q_PROPERTY(bool flagShowZenithPassage
                READ   isZenithPassageDisplayed
                WRITE  showZenithPassage
                NOTIFY showZenithPassageChanged
           )
    Q_PROPERTY(bool flagShowNadirPassage
                READ   isNadirPassageDisplayed
                WRITE  showNadirPassage
                NOTIFY showNadirPassageChanged
           )
    Q_PROPERTY(bool flagShowSelectedObject
                READ   isSelectedObjectDisplayed
                WRITE  showSelectedObject
                NOTIFY showSelectedObjectChanged
           )
    Q_PROPERTY(bool flagShowCurrentSun
                READ   isCurrentSunDisplayed
                WRITE  showCurrentSun
                NOTIFY showCurrentSunChanged
           )
    Q_PROPERTY(bool flagShowCurrentMoon
                READ   isCurrentMoonDisplayed
                WRITE  showCurrentMoon
                NOTIFY showCurrentMoonChanged
           )
    Q_PROPERTY(ArchaeoLine::Line enumShowCurrentPlanet
                READ   whichCurrentPlanetDisplayed
                WRITE  showCurrentPlanet
                NOTIFY currentPlanetChanged)
    Q_PROPERTY(bool flagShowGeographicLocation1
                READ   isGeographicLocation1Displayed
                WRITE  showGeographicLocation1
                NOTIFY showGeographicLocation1Changed
           )
    Q_PROPERTY(bool flagShowGeographicLocation2
                READ   isGeographicLocation2Displayed
                WRITE  showGeographicLocation2
                NOTIFY showGeographicLocation2Changed
           )
    Q_PROPERTY(double geographicLocation1Longitude
                READ   getGeographicLocation1Longitude
                WRITE  setGeographicLocation1Longitude
                NOTIFY geographicLocation1Changed)
    Q_PROPERTY(double geographicLocation1Latitude
                READ   getGeographicLocation1Latitude
                WRITE  setGeographicLocation1Latitude
                NOTIFY geographicLocation1Changed)
    Q_PROPERTY(double geographicLocation2Longitude
                READ   getGeographicLocation2Longitude
                WRITE  setGeographicLocation2Longitude
                NOTIFY geographicLocation2Changed)
    Q_PROPERTY(double geographicLocation2Latitude
                READ   getGeographicLocation2Latitude
                WRITE  setGeographicLocation2Latitude
                NOTIFY geographicLocation2Changed)
    Q_PROPERTY(bool flagShowCustomAzimuth1
                READ   isCustomAzimuth1Displayed
                WRITE  showCustomAzimuth1
                NOTIFY showCustomAzimuth1Changed
           )
    Q_PROPERTY(bool flagShowCustomAzimuth2
                READ   isCustomAzimuth2Displayed
                WRITE  showCustomAzimuth2
                NOTIFY showCustomAzimuth2Changed
           )
    // Note: following 2 are only "forwarding properties", no proper variables!
    Q_PROPERTY(double customAzimuth1
                READ getCustomAzimuth1
                WRITE setCustomAzimuth1
                NOTIFY customAzimuth1Changed)
    Q_PROPERTY(double customAzimuth2
                READ getCustomAzimuth2
                WRITE setCustomAzimuth2
                NOTIFY customAzimuth2Changed)
    Q_PROPERTY(bool flagShowCustomDeclination1
                READ   isCustomDeclination1Displayed
                WRITE  showCustomDeclination1
                NOTIFY showCustomDeclination1Changed
           )
    Q_PROPERTY(bool flagShowCustomDeclination2
                READ   isCustomDeclination2Displayed
                WRITE  showCustomDeclination2
                NOTIFY showCustomDeclination2Changed
           )
    // Note: following 2 are only "forwarding properties", no proper variables!
    Q_PROPERTY(double customDeclination1
                READ getCustomDeclination1
                WRITE setCustomDeclination1
                NOTIFY customDeclination1Changed)
    Q_PROPERTY(double customDeclination2
                READ getCustomDeclination2
                WRITE setCustomDeclination2
                NOTIFY customDeclination2Changed)

    // More "forwarding properties" for geo locations and custom azimuths/declination labels.
    Q_PROPERTY(QString geographicLocation1Label READ getGeographicLocation1Label WRITE setGeographicLocation1Label NOTIFY geographicLocation1LabelChanged)
    Q_PROPERTY(QString geographicLocation2Label READ getGeographicLocation2Label WRITE setGeographicLocation2Label NOTIFY geographicLocation2LabelChanged)
    Q_PROPERTY(QString customAzimuth1Label READ getCustomAzimuth1Label WRITE setCustomAzimuth1Label NOTIFY customAzimuth1LabelChanged)
    Q_PROPERTY(QString customAzimuth2Label READ getCustomAzimuth2Label WRITE setCustomAzimuth2Label NOTIFY customAzimuth2LabelChanged)
    Q_PROPERTY(QString customDeclination1Label READ getCustomDeclination1Label WRITE setCustomDeclination1Label NOTIFY customDeclination1LabelChanged)
    Q_PROPERTY(QString customDeclination2Label READ getCustomDeclination2Label WRITE setCustomDeclination2Label NOTIFY customDeclination2LabelChanged)

public:
    ArchaeoLines();
    virtual ~ArchaeoLines();
    

    // Methods defined in the StelModule class
    virtual void init();
    virtual void update(double deltaTime);
    virtual void draw(StelCore* core);
    virtual double getCallOrder(StelModuleActionName actionName) const;
    virtual void handleKeys(class QKeyEvent* event){event->setAccepted(false);}
    virtual bool configureGui(bool show=true);

    //bool isDmsFormat() const { return flagUseDmsFormat; } // NOT SURE IF USEFUL

    void restoreDefaultSettings();

    void loadSettings();

signals:
    void archaeoLinesEnabledChanged(bool on);
    void showEquinoxChanged(bool on);
    void showSolsticesChanged(bool on);
    void showCrossquartersChanged(bool on);
    void showMajorStandstillsChanged(bool on);
    void showMinorStandstillsChanged(bool on);
    void showZenithPassageChanged(bool on);
    void showNadirPassageChanged(bool on);
    void showSelectedObjectChanged(bool on);
    void showCurrentSunChanged(bool on);
    void showCurrentMoonChanged(bool on);
    void showGeographicLocation1Changed(bool on);
    void showGeographicLocation2Changed(bool on);
    void geographicLocation1Changed();
    void geographicLocation2Changed();
    void showCustomAzimuth1Changed(bool on);
    void showCustomAzimuth2Changed(bool on);
    void customAzimuth1Changed(double az);
    void customAzimuth2Changed(double az);
    void showCustomDeclination1Changed(bool on);
    void showCustomDeclination2Changed(bool on);
    void customDeclination1Changed(double dec);
    void customDeclination2Changed(double dec);
    void currentPlanetChanged(ArchaeoLine::Line l); // meaningful only CurrentPlanetNone...CurrentPlanetSaturn.
    void geographicLocation1LabelChanged(QString label);
    void geographicLocation2LabelChanged(QString label);
    void customAzimuth1LabelChanged(QString label);
    void customAzimuth2LabelChanged(QString label);
    void customDeclination1LabelChanged(QString label);
    void customDeclination2LabelChanged(QString label);

public slots:
    void enableArchaeoLines(bool b);
    //void useDmsFormat(bool b);

    bool isEnabled() const {return flagShowArchaeoLines;}
    bool isEquinoxDisplayed() const {return flagShowEquinox;}
    bool isSolsticesDisplayed() const {return flagShowSolstices;}
    bool isCrossquartersDisplayed() const {return flagShowCrossquarters;}
    bool isMajorStandstillsDisplayed() const {return flagShowMajorStandstills;}
    bool isMinorStandstillsDisplayed() const {return flagShowMinorStandstills;}
    bool isZenithPassageDisplayed() const {return flagShowZenithPassage;}
    bool isNadirPassageDisplayed() const {return flagShowNadirPassage;}
    bool isSelectedObjectDisplayed() const {return flagShowSelectedObject;}
    bool isCurrentSunDisplayed() const {return flagShowCurrentSun;}
    bool isCurrentMoonDisplayed() const {return flagShowCurrentMoon;}
    ArchaeoLine::Line whichCurrentPlanetDisplayed() const {return enumShowCurrentPlanet;}
    bool isGeographicLocation1Displayed() const {return flagShowGeographicLocation1;}
    bool isGeographicLocation2Displayed() const {return flagShowGeographicLocation2;}
    bool isCustomAzimuth1Displayed() const {return flagShowCustomAzimuth1;}
    bool isCustomAzimuth2Displayed() const {return flagShowCustomAzimuth2;}
    bool isCustomDeclination1Displayed() const {return flagShowCustomDeclination1;}
    bool isCustomDeclination2Displayed() const {return flagShowCustomDeclination2;}


    void showEquinox(bool b);
    void showSolstices(bool b);
    void showCrossquarters(bool b);
    void showMajorStandstills(bool b);
    void showMinorStandstills(bool b);
    void showZenithPassage(bool b);
    void showNadirPassage(bool b);
    void showSelectedObject(bool b);
    void showCurrentSun(bool b);
    void showCurrentMoon(bool b);
    void showCurrentPlanet(ArchaeoLine::Line l); // Allowed values for l: CurrentPlanetNone...CurrentPlanetSaturn.
    void showCurrentPlanetNamed(QString planet); // Allowed values for planet: "none", "Mercury", "Venus", "Mars", "Jupiter", "Saturn".
    void showGeographicLocation1(bool b);
    void showGeographicLocation2(bool b);
    void setGeographicLocation1Longitude(double lng);
    void setGeographicLocation1Latitude(double lat);
    void setGeographicLocation2Longitude(double lng);
    void setGeographicLocation2Latitude(double lat);
    void setGeographicLocation1Label(QString label);
    void setGeographicLocation2Label(QString label);
    QString getGeographicLocation1Label(){return geographicLocation1Line->getLabel();}
    QString getGeographicLocation2Label(){return geographicLocation2Line->getLabel();}
    double getGeographicLocation1Longitude() const {return geographicLocation1Longitude; }
    double getGeographicLocation1Latitude()  const {return geographicLocation1Latitude; }
    double getGeographicLocation2Longitude() const {return geographicLocation2Longitude; }
    double getGeographicLocation2Latitude()  const {return geographicLocation2Latitude; }
    void showCustomAzimuth1(bool b);
    void showCustomAzimuth2(bool b);
    void setCustomAzimuth1(double az);
    double getCustomAzimuth1() const { return customAzimuth1Line->getDefiningAngle(); }
    void setCustomAzimuth2(double az);
    double getCustomAzimuth2() const { return customAzimuth2Line->getDefiningAngle(); }
    void setCustomAzimuth1Label(QString label);
    void setCustomAzimuth2Label(QString label);
    QString getCustomAzimuth1Label(){return customAzimuth1Line->getLabel();}
    QString getCustomAzimuth2Label(){return customAzimuth2Line->getLabel();}
    void showCustomDeclination1(bool b);
    void showCustomDeclination2(bool b);
    void setCustomDeclination1(double dec);
    double getCustomDeclination1() const { return customDeclination1Line->getDefiningAngle(); }
    void setCustomDeclination2(double dec);
    double getCustomDeclination2() const { return customDeclination2Line->getDefiningAngle(); }
    void setCustomDeclination1Label(QString label);
    void setCustomDeclination2Label(QString label);
    QString getCustomDeclination1Label(){return customDeclination1Line->getLabel();}
    QString getCustomDeclination2Label(){return customDeclination2Line->getLabel();}

    // called by the dialog GUI, converts GUI's QColor (0..255) to Stellarium's Vec3f float color.
    void setLineColor(ArchaeoLine::Line whichLine, QColor color);
    // called by the dialog UI, converts Stellarium's Vec3f float color to QColor (0..255).
    QColor getLineColor(ArchaeoLine::Line whichLine) const;
    double getLineAngle(ArchaeoLine::Line whichLine) const;
    QString getLineLabel(ArchaeoLine::Line whichLine) const;

private slots:
    void updateObserverLocation(StelLocation loc);
    static double getAzimuthForLocation(double longObs, double latObs, double longTarget, double latTarget);

private:
    QFont font;
    bool flagShowArchaeoLines;
    //bool withDecimalDegree;
    //bool flagUseDmsFormat;
    LinearFader lineFader;

    Vec3f equinoxColor;
    Vec3f solsticesColor;
    Vec3f crossquartersColor;
    Vec3f majorStandstillColor;
    Vec3f minorStandstillColor;
    Vec3f zenithPassageColor;
    Vec3f nadirPassageColor;
    Vec3f selectedObjectColor;
    Vec3f currentSunColor;
    Vec3f currentMoonColor;
    Vec3f currentPlanetColor;
    Vec3f geographicLocation1Color;
    Vec3f geographicLocation2Color;
    Vec3f customAzimuth1Color;
    Vec3f customAzimuth2Color;
    Vec3f customDeclination1Color;
    Vec3f customDeclination2Color;

    bool flagShowEquinox;
    bool flagShowSolstices;
    bool flagShowCrossquarters;
    bool flagShowMajorStandstills;
    bool flagShowMinorStandstills;
    bool flagShowZenithPassage;
    bool flagShowNadirPassage;
    bool flagShowSelectedObject;
    bool flagShowCurrentSun;
    bool flagShowCurrentMoon;
    ArchaeoLine::Line enumShowCurrentPlanet;
    bool flagShowGeographicLocation1;
    double geographicLocation1Longitude;
    double geographicLocation1Latitude;
    bool flagShowGeographicLocation2;
    double geographicLocation2Longitude;
    double geographicLocation2Latitude;
    bool flagShowCustomAzimuth1;
    bool flagShowCustomAzimuth2;
    bool flagShowCustomDeclination1;
    bool flagShowCustomDeclination2;
    double lastJDE; // cache last-time-computed to every 10 days or so?

    ArchaeoLine * equinoxLine;
    ArchaeoLine * northernSolsticeLine;
    ArchaeoLine * southernSolsticeLine;
    ArchaeoLine * northernCrossquarterLine;
    ArchaeoLine * southernCrossquarterLine;
    ArchaeoLine * northernMajorStandstillLine0;
    ArchaeoLine * northernMajorStandstillLine1;
    ArchaeoLine * northernMinorStandstillLine2;
    ArchaeoLine * northernMinorStandstillLine3;
    ArchaeoLine * southernMinorStandstillLine4;
    ArchaeoLine * southernMinorStandstillLine5;
    ArchaeoLine * southernMajorStandstillLine6;
    ArchaeoLine * southernMajorStandstillLine7;
    ArchaeoLine * zenithPassageLine;
    ArchaeoLine * nadirPassageLine;
    ArchaeoLine * selectedObjectLine;
    ArchaeoLine * currentSunLine;
    ArchaeoLine * currentMoonLine;
    ArchaeoLine * currentPlanetLine;
    ArchaeoLine * geographicLocation1Line;
    ArchaeoLine * geographicLocation2Line;
    ArchaeoLine * customAzimuth1Line;
    ArchaeoLine * customAzimuth2Line;
    ArchaeoLine * customDeclination1Line;
    ArchaeoLine * customDeclination2Line;

    StelButton* toolbarButton;
  
    QSettings* conf;

    // GUI
    ArchaeoLinesDialog* configDialog;
    StelCore* core; // used quite often, better keep a reference...
    StelObjectMgr* objMgr;
};



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

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

#endif /*ARCHAEOLINES_HPP_*/