Nebula.hpp

/*
 * Stellarium
 * Copyright (C) 2002 Fabien Chereau
 * Copyright (C) 2011 Alexander Wolf
 *
 * 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 _NEBULA_HPP_
#define _NEBULA_HPP_

#include <QString>
#include "StelObject.hpp"
#include "StelTranslator.hpp"
#include "StelProjectorType.hpp"

class QDataStream;

class Nebula : public StelObject
{
friend class NebulaMgr;
public:
    Nebula();
    ~Nebula();

    virtual QString getInfoString(const StelCore *core, const InfoStringGroup& flags) const;
    virtual QString getType() const {return "Nebula";}
    virtual Vec3d getJ2000EquatorialPos(const StelCore*) const {return XYZ;}
    virtual double getCloseViewFov(const StelCore* core = NULL) const;
    virtual float getVMagnitude(const StelCore* core, bool withExtinction=false) const;
    virtual float getSelectPriority(const StelCore* core) const;
    virtual Vec3f getInfoColor() const;
    virtual QString getNameI18n() const {return nameI18;}
    virtual QString getEnglishName() const {return englishName;}
    virtual double getAngularSize(const StelCore*) const {return angularSize*0.5;}
    virtual SphericalRegionP getRegion() const {return pointRegion;}

    // Methods specific to Nebula
    void setLabelColor(const Vec3f& v) {labelColor = v;}
    void setCircleColor(const Vec3f& v) {circleColor = v;}

    QString getTypeString() const;

private:
    friend struct DrawNebulaFuncObject;

    struct NebulaHintTextures
    {
        class StelTextureNew* texCircle;  
        class StelTextureNew* texGalaxy;
        class StelTextureNew* texOpenCluster;
        class StelTextureNew* texGlobularCluster;
        class StelTextureNew* texDiffuseNebula;
        class StelTextureNew* texPlanetaryNebula;
        class StelTextureNew* texOpenClusterWithNebulosity;
        bool initialized;

        NebulaHintTextures(): initialized(false){}
        ~NebulaHintTextures();
        void lazyInit(class StelRenderer* renderer);
    };
    
    enum NebulaType
    {
        NebGx=0,     
        NebOc=1,     
        NebGc=2,     
        NebN=3,      
        NebPn=4,     
        NebDn=5,     
        NebIg=6,     
        NebCn=7,     
        NebUnknown=8 
    };

    void translateName(StelTranslator& trans) {nameI18 = trans.qtranslate(englishName);}

    bool readNGC(char *record);
    void readNGC(QDataStream& in);
            
    void drawHints(StelRenderer* renderer, float maxMagHints, NebulaHintTextures& hintTextures);
    void drawLabel(StelRenderer* renderer, StelProjectorP projector, float maxMagLabel);

    unsigned int M_nb;              // Messier Catalog number
    unsigned int NGC_nb;            // New General Catalog number
    unsigned int IC_nb;             // Index Catalog number
    unsigned int C_nb;              // Caldwell Catalog number
    QString englishName;            // English name
    QString nameI18;                // Nebula name
    float mag;                      // Apparent magnitude
    float angularSize;              // Angular size in degree
    Vec3d XYZ;                      // Cartesian equatorial position
    Vec3d XY;                       // Store temporary 2D position
    NebulaType nType;

    SphericalRegionP pointRegion;

    static float hintsBrightness;

    static Vec3f labelColor, circleColor;
    static float circleScale;       // Define the scaling of the hints circle
};

#endif // _NEBULA_HPP_