ConstellationMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2002 Fabien Chereau
 * Copyright (C) 2012 Timothy Reaves
 *
 * 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 _CONSTELLATIONMGR_HPP_
#define _CONSTELLATIONMGR_HPP_

#include "StelObjectType.hpp"
#include "StelObjectModule.hpp"
#include "StelProjectorType.hpp"

#include <vector>
#include <QString>
#include <QStringList>
#include <QFont>

class StelToneReproducer;
class StarMgr;
class Constellation;
class StelProjector;
class StelPainter;

class ConstellationMgr : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool artDisplayed
               READ getFlagArt
               WRITE setFlagArt
               NOTIFY artDisplayedChanged)
    Q_PROPERTY(float artFadeDuration
               READ getArtFadeDuration
               WRITE setArtFadeDuration
               NOTIFY artFadeDurationChanged)
    Q_PROPERTY(float artIntensity
               READ getArtIntensity
               WRITE setArtIntensity
               NOTIFY artIntensityChanged)
    Q_PROPERTY(Vec3f boundariesColor
               READ getBoundariesColor
               WRITE setBoundariesColor
               NOTIFY boundariesColorChanged)
    Q_PROPERTY(bool boundariesDisplayed
               READ getFlagBoundaries
               WRITE setFlagBoundaries
               NOTIFY boundariesDisplayedChanged)
    Q_PROPERTY(float fontSize
               READ getFontSize
               WRITE setFontSize
               NOTIFY fontSizeChanged)
    Q_PROPERTY(bool isolateSelected
               READ getFlagIsolateSelected
               WRITE setFlagIsolateSelected
               NOTIFY isolateSelectedChanged)   
    Q_PROPERTY(Vec3f linesColor
               READ getLinesColor
               WRITE setLinesColor
               NOTIFY linesColorChanged)
    Q_PROPERTY(bool linesDisplayed
               READ getFlagLines
               WRITE setFlagLines
               NOTIFY linesDisplayedChanged)
    Q_PROPERTY(Vec3f namesColor
               READ getLabelsColor
               WRITE setLabelsColor
               NOTIFY namesColorChanged)
    Q_PROPERTY(bool namesDisplayed
               READ getFlagLabels
               WRITE setFlagLabels
               NOTIFY namesDisplayedChanged)
    Q_PROPERTY(ConstellationDisplayStyle constellationDisplayStyle
               READ getConstellationDisplayStyle
               WRITE setConstellationDisplayStyle
               NOTIFY constellationsDisplayStyleChanged)


public:
    ConstellationMgr(StarMgr *stars);
    virtual ~ConstellationMgr();

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

    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;

    // GZ: I see dubious descriptions and non-fitting var names: objPrefix should just be "string" or "obj",
    // and useStartOfWord likely should be described as "decide if start of word is searched"  (2x)
    virtual QStringList listMatchingObjectsI18n(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
    virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
    virtual QStringList listAllObjects(bool inEnglish) const;
    virtual QStringList listAllObjectsByType(const QString& objType, bool inEnglish) const { Q_UNUSED(objType) Q_UNUSED(inEnglish) return QStringList(); }
    virtual QString getName() const { return "Constellations"; }
    enum ConstellationDisplayStyle
    {
        constellationsAbbreviated = 0,
        constellationsNative      = 1,
        constellationsTranslated  = 2,
        constellationsEnglish     = 3 // Maybe this is not useful?
    };

    // Properties setters and getters
public slots:   
    void setFlagArt(const bool displayed);
    bool getFlagArt(void) const;

    void setArtFadeDuration(const float duration);
    float getArtFadeDuration() const;

    void setArtIntensity(const double intensity);
    double getArtIntensity() const;

    void setBoundariesColor(const Vec3f& color);
    Vec3f getBoundariesColor() const;

    void setFlagBoundaries(const bool displayed);
    bool getFlagBoundaries(void) const;

    void setFlagIsolateSelected(const bool isolate);
    bool getFlagIsolateSelected(void) const;

    void setFlagConstellationPick(const bool mode);
    bool getFlagConstellationPick(void) const;

    void setLinesColor(const Vec3f& color);
    Vec3f getLinesColor() const;

    void setFlagLines(const bool displayed);
    bool getFlagLines(void) const;

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

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

    void setFontSize(const float newFontSize);
    float getFontSize() const;

    void setConstellationDisplayStyle(int style);
    ConstellationDisplayStyle getConstellationDisplayStyle();
    QString getConstellationDisplayStyleString();

    void setConstellationLineThickness(const double thickness);
    double getConstellationLineThickness() const { return constellationLineThickness; }


signals:
    void artDisplayedChanged(const bool displayed) const;
    void artFadeDurationChanged(const float duration) const;
    void artIntensityChanged(const double intensity) const;
    void boundariesColorChanged(const Vec3f & color) const;
    void boundariesDisplayedChanged(const bool displayed) const;
    void fontSizeChanged(const float newSize) const;
    void isolateSelectedChanged(const bool isolate) const;  
    void linesColorChanged(const Vec3f & color) const;
    void linesDisplayedChanged(const bool displayed) const;
    void namesColorChanged(const Vec3f & color) const;
    void namesDisplayedChanged(const bool displayed) const;
    void constellationsDisplayStyleChanged(const ConstellationDisplayStyle style) const;

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

    void setStelStyle(const QString& section);

    void updateSkyCulture(const QString& skyCultureDir);

    void updateI18n();

private:
    void loadNames(const QString& namesFile);

    void loadLinesAndArt(const QString& fileName, const QString& artfileName, const QString& cultureName);

    bool loadBoundaries(const QString& conCatFile);

    void loadSeasonalRules(const QString& rulesFile);

    void drawLines(StelPainter& sPainter, const StelCore* core) const;
    void drawArt(StelPainter& sPainter) const;
    void drawNames(StelPainter& sPainter) const;
    void drawBoundaries(StelPainter& sPainter) const;
    void setSelectedConst(Constellation* c);
    void unsetSelectedConst(Constellation* c);
    void setSelected(const QString& abbreviation);
    StelObjectP setSelectedStar(const QString& abbreviation);
    void setSelected(const StelObject* s) {if (!s) setSelectedConst(NULL); else setSelectedConst(isStarIn(s));}
    void deselect() {setSelected(NULL);}
    StelObject* getSelected(void) const;
    void deselectConstellations(void);

    std::vector<Constellation*> selected; // More than one can be selected at a time

    Constellation* isStarIn(const StelObject *s) const;
    Constellation* findFromAbbreviation(const QString& abbreviation) const;
    std::vector<Constellation*> asterisms;
    QFont asterFont;
    StarMgr* hipStarMgr;

    bool isolateSelected;
    bool constellationPickEnabled;
    std::vector<std::vector<Vec3f> *> allBoundarySegments;

    QString lastLoadedSkyCulture;   // Store the last loaded sky culture directory name

    ConstellationDisplayStyle constellationDisplayStyle;

    // These are THE master settings - individual constellation settings can vary based on selection status
    float artFadeDuration;
    float artIntensity;
    bool artDisplayed;
    bool boundariesDisplayed;
    bool linesDisplayed;
    bool namesDisplayed;

    // Store the thickness of lines of the constellations
    float constellationLineThickness;
};

#endif // _CONSTELLATIONMGR_HPP_