Constellation.hpp

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

#include "StelObject.hpp"
#include "StelUtils.hpp"
#include "StelFader.hpp"
#include "StelTextureTypes.hpp"
#include "StelSphereGeometry.hpp"
#include "ConstellationMgr.hpp"

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

class StarMgr;
class StelPainter;

class Constellation : public StelObject
{
    friend class ConstellationMgr;
private:
    Constellation();
    ~Constellation();

    // StelObject method to override
    virtual QString getInfoString(const StelCore*, const InfoStringGroup& flags) const;

    virtual QString getType() const {return "Constellation";}

    virtual Vec3d getJ2000EquatorialPos(const StelCore*) const {return XYZname;}

    virtual double getAngularSize(const StelCore*) const {Q_ASSERT(0); return 0;} // TODO

    bool read(const QString& record, StarMgr *starMgr);

    void drawName(StelPainter& sPainter, ConstellationMgr::ConstellationDisplayStyle style) const;
    void drawArt(StelPainter& sPainter) const;
    void drawBoundaryOptim(StelPainter& sPainter) const;

    const Constellation* isStarIn(const StelObject*) const;

    StelObjectP getBrightestStarInConstellation(void) const;

    QString getNameI18n() const {return nameI18;}
    QString getEnglishName() const {return englishName;}
    QString getShortName() const {return abbreviation;}
    void drawOptim(StelPainter& sPainter, const StelCore* core, const SphericalCap& viewportHalfspace) const;
    void drawArtOptim(StelPainter& sPainter, const SphericalRegion& region) const;
    void update(int deltaTime);
    void setFlagLines(const bool b) {lineFader=b;}
    void setFlagBoundaries(const bool b) {boundaryFader=b;}
    void setFlagLabels(const bool b) {nameFader=b;}
    void setFlagArt(const bool b) {artFader=b;}
    bool getFlagLines() const {return lineFader;}
    bool getFlagBoundaries() const {return boundaryFader;}
    bool getFlagLabels() const {return nameFader;}
    bool getFlagArt() const {return artFader;}

    bool checkVisibility() const;

    QString nameI18;
    QString englishName;
    QString nativeName;
    QString abbreviation;
    Vec3d XYZname;
    Vec3d XYname;
    unsigned int numberOfSegments;
    int beginSeason;
    int endSeason;
    StelObjectP* asterism;

    StelTextureSP artTexture;
    StelVertexArray artPolygon;
    SphericalCap boundingCap;

    LinearFader artFader, lineFader, nameFader, boundaryFader;
    std::vector<std::vector<Vec3f> *> isolatedBoundarySegments;
    std::vector<std::vector<Vec3f> *> sharedBoundarySegments;

    static Vec3f lineColor;
    static Vec3f labelColor;
    static Vec3f boundaryColor;

    static bool singleSelected; 
    static bool seasonalRuleEnabled;
    // set by ConstellationMgr to fade out art on small FOV values
    // see LP:#1294483
    static float artIntensityFovScale;
};

#endif // _CONSTELLATION_HPP_