GridLinesMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2007 Fabien Chereau
 * Copyright (C) 2015 Georg Zotti (more grids to illustrate precession issues)
 *
 * 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 _GRIDLINESMGR_HPP_
#define _GRIDLINESMGR_HPP_

#include "VecMath.hpp"
#include "StelModule.hpp"

class SkyGrid;
class SkyLine;

class GridLinesMgr : public StelModule
{
    Q_OBJECT
    Q_PROPERTY(bool azimuthalGridDisplayed
               READ getFlagAzimuthalGrid
               WRITE setFlagAzimuthalGrid
               NOTIFY azimuthalGridDisplayedChanged)
    Q_PROPERTY(Vec3f azimuthalGridColor
               READ getColorAzimuthalGrid
               WRITE setColorAzimuthalGrid
               NOTIFY azimuthalGridColorChanged)

    Q_PROPERTY(bool equatorGridDisplayed
               READ getFlagEquatorGrid
               WRITE setFlagEquatorGrid
               NOTIFY equatorGridDisplayedChanged)
    Q_PROPERTY(Vec3f equatorGridColor
               READ getColorEquatorGrid
               WRITE setColorEquatorGrid
               NOTIFY equatorGridColorChanged)

    Q_PROPERTY(bool equatorJ2000GridDisplayed
               READ getFlagEquatorJ2000Grid
               WRITE setFlagEquatorJ2000Grid
               NOTIFY equatorJ2000GridDisplayedChanged)
    Q_PROPERTY(Vec3f equatorJ2000GridColor
               READ getColorEquatorJ2000Grid
               WRITE setColorEquatorJ2000Grid
               NOTIFY equatorJ2000GridColorChanged)

    Q_PROPERTY(bool eclipticJ2000GridDisplayed
               READ getFlagEclipticJ2000Grid
               WRITE setFlagEclipticJ2000Grid
               NOTIFY eclipticJ2000GridDisplayedChanged)
    Q_PROPERTY(Vec3f eclipticJ2000GridColor
               READ getColorEclipticJ2000Grid
               WRITE setColorEclipticJ2000Grid
               NOTIFY eclipticJ2000GridColorChanged)
    // NEW
    Q_PROPERTY(bool eclipticGridDisplayed
               READ getFlagEclipticGrid
               WRITE setFlagEclipticGrid
               NOTIFY eclipticGridDisplayedChanged)
    Q_PROPERTY(Vec3f eclipticGridColor
               READ getColorEclipticGrid
               WRITE setColorEclipticGrid
               NOTIFY eclipticGridColorChanged)

    Q_PROPERTY(bool galacticGridDisplayed
               READ getFlagGalacticGrid
               WRITE setFlagGalacticGrid
               NOTIFY galacticGridDisplayedChanged)
    Q_PROPERTY(Vec3f galacticGridColor
               READ getColorGalacticGrid
               WRITE setColorGalacticGrid
               NOTIFY galacticGridColorChanged)

    Q_PROPERTY(bool equatorLineDisplayed
               READ getFlagEquatorLine
               WRITE setFlagEquatorLine
               NOTIFY equatorLineDisplayedChanged)
    Q_PROPERTY(Vec3f equatorLineColor
               READ getColorEquatorLine
               WRITE setColorEquatorLine
               NOTIFY equatorLineColorChanged)

    Q_PROPERTY(bool equatorJ2000LineDisplayed
               READ getFlagEquatorJ2000Line
               WRITE setFlagEquatorJ2000Line
               NOTIFY equatorJ2000LineDisplayedChanged)
    Q_PROPERTY(Vec3f equatorJ2000LineColor
               READ getColorEquatorJ2000Line
               WRITE setColorEquatorJ2000Line
               NOTIFY equatorJ2000LineColorChanged)

    // This is now ecl. of date.
    Q_PROPERTY(bool eclipticLineDisplayed
               READ getFlagEclipticLine
               WRITE setFlagEclipticLine
               NOTIFY eclipticLineDisplayedChanged)
    Q_PROPERTY(Vec3f eclipticLineColor
               READ getColorEclipticLine
               WRITE setColorEclipticLine
               NOTIFY eclipticLineColorChanged)

    // new name, but replaces old ecliptic.
    Q_PROPERTY(bool eclipticJ2000LineDisplayed
               READ getFlagEclipticJ2000Line
               WRITE setFlagEclipticJ2000Line
               NOTIFY eclipticJ2000LineDisplayedChanged)
    Q_PROPERTY(Vec3f eclipticJ2000LineColor
               READ getColorEclipticJ2000Line
               WRITE setColorEclipticJ2000Line
               NOTIFY eclipticJ2000LineColorChanged)

    Q_PROPERTY(bool precessionCirclesDisplayed
               READ getFlagPrecessionCircles
               WRITE setFlagPrecessionCircles
               NOTIFY precessionCirclesDisplayedChanged)
    Q_PROPERTY(Vec3f precessionCirclesColor
               READ getColorPrecessionCircles
               WRITE setColorPrecessionCircles
               NOTIFY precessionCirclesColorChanged)

    Q_PROPERTY(bool meridianLineDisplayed
               READ getFlagMeridianLine
               WRITE setFlagMeridianLine
               NOTIFY meridianLineDisplayedChanged)
    Q_PROPERTY(Vec3f meridianLineColor
               READ getColorMeridianLine
               WRITE setColorMeridianLine
               NOTIFY meridianLineColorChanged)

    Q_PROPERTY(bool longitudeLineDisplayed
               READ getFlagLongitudeLine
               WRITE setFlagLongitudeLine
               NOTIFY longitudeLineDisplayedChanged)
    Q_PROPERTY(Vec3f longitudeLineColor
               READ getColorLongitudeLine
               WRITE setColorLongitudeLine
               NOTIFY longitudeLineColorChanged)

    Q_PROPERTY(bool horizonLineDisplayed
               READ getFlagHorizonLine
               WRITE setFlagHorizonLine
               NOTIFY horizonLineDisplayedChanged)
    Q_PROPERTY(Vec3f horizonLineColor
               READ getColorHorizonLine
               WRITE setColorHorizonLine
               NOTIFY horizonLineColorChanged)

    Q_PROPERTY(bool galacticEquatorLineDisplayed
               READ getFlagGalacticEquatorLine
               WRITE setFlagGalacticEquatorLine
               NOTIFY galacticEquatorLineDisplayedChanged)
    Q_PROPERTY(Vec3f galacticEquatorLineColor
               READ getColorGalacticEquatorLine
               WRITE setColorGalacticEquatorLine
               NOTIFY galacticEquatorLineColorChanged)

public:
    GridLinesMgr();
    virtual ~GridLinesMgr();

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

    virtual QString getModuleID() const {return "GridLinesMgr";}

    virtual void draw(StelCore* core);

    virtual void update(double deltaTime);

    virtual double getCallOrder(StelModuleActionName actionName) const;

    // Setter and getters
public slots:
    void setFlagAzimuthalGrid(const bool displayed);
    bool getFlagAzimuthalGrid(void) const;
    Vec3f getColorAzimuthalGrid(void) const;
    void setColorAzimuthalGrid(const Vec3f& newColor);

    void setFlagEquatorGrid(const bool displayed);
    bool getFlagEquatorGrid(void) const;
    Vec3f getColorEquatorGrid(void) const;
    void setColorEquatorGrid(const Vec3f& newColor);

    void setFlagEquatorJ2000Grid(const bool displayed);
    bool getFlagEquatorJ2000Grid(void) const;
    Vec3f getColorEquatorJ2000Grid(void) const;
    void setColorEquatorJ2000Grid(const Vec3f& newColor);

    void setFlagEclipticJ2000Grid(const bool displayed);
    bool getFlagEclipticJ2000Grid(void) const;
    Vec3f getColorEclipticJ2000Grid(void) const;
    void setColorEclipticJ2000Grid(const Vec3f& newColor);

    void setFlagEclipticGrid(const bool displayed);
    bool getFlagEclipticGrid(void) const;
    Vec3f getColorEclipticGrid(void) const;
    void setColorEclipticGrid(const Vec3f& newColor);

    void setFlagGalacticGrid(const bool displayed);
    bool getFlagGalacticGrid(void) const;
    Vec3f getColorGalacticGrid(void) const;
    void setColorGalacticGrid(const Vec3f& newColor);

    void setFlagEquatorLine(const bool displayed);
    bool getFlagEquatorLine(void) const;
    Vec3f getColorEquatorLine(void) const;
    void setColorEquatorLine(const Vec3f& newColor);

    void setFlagEquatorJ2000Line(const bool displayed);
    bool getFlagEquatorJ2000Line(void) const;
    Vec3f getColorEquatorJ2000Line(void) const;
    void setColorEquatorJ2000Line(const Vec3f& newColor);

    void setFlagEclipticJ2000Line(const bool displayed);
    bool getFlagEclipticJ2000Line(void) const;
    Vec3f getColorEclipticJ2000Line(void) const;
    void setColorEclipticJ2000Line(const Vec3f& newColor);

    void setFlagEclipticLine(const bool displayed);
    bool getFlagEclipticLine(void) const;
    Vec3f getColorEclipticLine(void) const;
    void setColorEclipticLine(const Vec3f& newColor);

    void setFlagPrecessionCircles(const bool displayed);
    bool getFlagPrecessionCircles(void) const;
    Vec3f getColorPrecessionCircles(void) const;
    void setColorPrecessionCircles(const Vec3f& newColor);

    void setFlagMeridianLine(const bool displayed);
    bool getFlagMeridianLine(void) const;
    Vec3f getColorMeridianLine(void) const;
    void setColorMeridianLine(const Vec3f& newColor);

    void setFlagLongitudeLine(const bool displayed);
    bool getFlagLongitudeLine(void) const;
    Vec3f getColorLongitudeLine(void) const;
    void setColorLongitudeLine(const Vec3f& newColor);

    void setFlagHorizonLine(const bool displayed);
    bool getFlagHorizonLine(void) const;
    Vec3f getColorHorizonLine(void) const;
    void setColorHorizonLine(const Vec3f& newColor);

    void setFlagGalacticEquatorLine(const bool displayed);
    void setFlagGalacticPlaneLine(const bool displayed) { setFlagGalacticEquatorLine(displayed); }
    bool getFlagGalacticEquatorLine(void) const;
    bool getFlagGalacticPlaneLine(void) const { return getFlagGalacticEquatorLine(); }
    Vec3f getColorGalacticEquatorLine(void) const;
    void setColorGalacticEquatorLine(const Vec3f& newColor);
signals:
    void azimuthalGridDisplayedChanged(const bool) const;
    void azimuthalGridColorChanged(const Vec3f & newColor) const;
    void equatorGridDisplayedChanged(const bool displayed) const;
    void equatorGridColorChanged(const Vec3f & newColor) const;
    void equatorJ2000GridDisplayedChanged(const bool displayed) const;
    void equatorJ2000GridColorChanged(const Vec3f & newColor) const;
    void eclipticGridDisplayedChanged(const bool displayed) const;
    void eclipticGridColorChanged(const Vec3f & newColor) const;
    void eclipticJ2000GridDisplayedChanged(const bool displayed) const;
    void eclipticJ2000GridColorChanged(const Vec3f & newColor) const;
    void galacticGridDisplayedChanged(const bool displayed) const;
    void galacticGridColorChanged(const Vec3f & newColor) const;
    void equatorLineDisplayedChanged(const bool displayed) const;
    void equatorLineColorChanged(const Vec3f & newColor) const;
    void equatorJ2000LineDisplayedChanged(const bool displayed) const;
    void equatorJ2000LineColorChanged(const Vec3f & newColor) const;
    void eclipticLineDisplayedChanged(const bool displayed) const;
    void eclipticLineColorChanged(const Vec3f & newColor) const;
    void eclipticJ2000LineDisplayedChanged(const bool displayed) const;
    void eclipticJ2000LineColorChanged(const Vec3f & newColor) const;
    void precessionCirclesDisplayedChanged(const bool displayed) const;
    void precessionCirclesColorChanged(const Vec3f & newColor) const;
    void meridianLineDisplayedChanged(const bool displayed) const;
    void meridianLineColorChanged(const Vec3f & newColor) const;
    void longitudeLineDisplayedChanged(const bool displayed) const;
    void longitudeLineColorChanged(const Vec3f & newColor) const;
    void horizonLineDisplayedChanged(const bool displayed) const;
    void horizonLineColorChanged(const Vec3f & newColor) const;
    void galacticEquatorLineDisplayedChanged(const bool displayed) const;
    void galacticEquatorLineColorChanged(const Vec3f & newColor) const;


private slots:
    void setStelStyle(const QString& section);
    void updateLineLabels();

private:
    SkyGrid * equGrid;      // Equatorial grid
    SkyGrid * equJ2000Grid;     // Equatorial J2000 grid
    SkyGrid * galacticGrid;     // Galactic grid
    SkyGrid * eclGrid;      // Ecliptic of Date grid
    SkyGrid * eclJ2000Grid;     // Ecliptic J2000 grid
    SkyGrid * aziGrid;      // Azimuthal grid
    SkyLine * equatorLine;      // Celestial Equator line
    SkyLine * equatorJ2000Line; // Celestial Equator of J2000 line
    SkyLine * eclipticLine;     // Ecliptic line
    SkyLine * eclipticJ2000Line;    // Ecliptic line of J2000
    SkyLine * precessionCircleN;    // Northern precession circle
    SkyLine * precessionCircleS;    // Southern precession circle
    SkyLine * meridianLine;     // Meridian line
    SkyLine * longitudeLine;    // Opposition/conjunction longitude line
    SkyLine * horizonLine;      // Horizon line
    SkyLine * galacticEquatorLine;  // line depicting the Galactic equator as defined by the IAU definition of Galactic coordinates (System II, 1958)
};

#endif // _GRIDLINESMGR_HPP_