Nebula.hpp

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

#include "StelObject.hpp"
#include "StelTranslator.hpp"
#include "StelTextureTypes.hpp"

#include <QString>

class StelPainter;
class QDataStream;

// This only draws nebula icons. For the DSO images, see StelSkylayerMgr and StelSkyImageTile.
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) 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;

    float getSurfaceBrightness(const StelCore* core) const;
    float getSurfaceBrightnessWithExtinction(const StelCore* core) const;

private:
    friend struct DrawNebulaFuncObject;
    
    enum NebulaType
    {
        NebGx=0,     
        NebOc=1,     
        NebGc=2,     
        NebN=3,      
        NebPn=4,     
        NebDn=5,     
        NebIg=6,     
        NebCn=7,     
        NebUnknown=8,
        NebHII=9,    
        NebRn=10,    
        NebHa=11     
    };

    enum HIIFormType
    {
        FormCir=1,   
        FormEll=2,   
        FormIrr=3    
    };

    enum HIIStructureType
    {
        StructureAmo=1,   
        StructureCon=2,   
        StructureFil=3    
    };

    enum HIIBrightnessType
    {
        Faintest=1,
        Moderate=2,
        Brightest=3
    };

    enum HaBrightnessType
    {
        HaFaint=1,
        HaMedium=2,
        HaBright=3,
        HaVeryBright=4
    };

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

    bool readNGC(char *record);
    void readNGC(QDataStream& in);
    bool readBarnard(QString record);
    bool readSharpless(QString record);
    bool readVandenBergh(QString record);
    bool readRCW(QString record);
    bool readLDN(QString record);
    bool readLBN(QString record);

    void drawLabel(StelPainter& sPainter, float maxMagLabel);
    void drawHints(StelPainter& sPainter, float maxMagHints);


    QString getHIIFormTypeString() const;
    QString getHIIStructureTypeString() const;
    QString getHIIBrightnessTypeString() const;
    QString getHaBrightnessTypeString() const;

    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
    unsigned int B_nb;              // Barnard Catalog number (Dark Nebulae)
    unsigned int Sh2_nb;            // Sharpless Catalog number (Catalogue of HII Regions (Sharpless, 1959))
    unsigned int VdB_nb;            // Van den Bergh Catalog number (Catalogue of Reflection Nebulae (Van den Bergh, 1966))
    unsigned int RCW_nb;            // RCW Catalog number (H-α emission regions in Southern Milky Way (Rodgers+, 1960))
    unsigned int LDN_nb;            // LDN Catalog number (Lynds' Catalogue of Dark Nebulae (Lynds, 1962))
    unsigned int LBN_nb;            // LBN Catalog number (Lynds' Catalogue of Bright Nebulae (Lynds, 1965))
    unsigned int Cr_nb;             // Collinder Catalog number
    unsigned int Mel_nb;            // Melotte Catalog number
    QString englishName;            // English name
    QString nameI18;                // Nebula name
    float mag;                      // Apparent magnitude. For Dark Nebulae, opacity is stored here.
    float angularSize;              // Angular size in degree
    Vec3d XYZ;                      // Cartesian equatorial position (J2000.0)
    Vec3d XY;                       // Store temporary 2D position
    NebulaType nType;

    HIIFormType formType;
    HIIStructureType structureType;
    HIIBrightnessType brightnessType;
    HaBrightnessType rcwBrightnessType;

    int brightnessClass;

    SphericalRegionP pointRegion;

    static StelTextureSP texCircle;   // The symbolic circle texture
    static StelTextureSP texGalaxy;                    // Type 0
    static StelTextureSP texOpenCluster;               // Type 1
    static StelTextureSP texGlobularCluster;           // Type 2
    static StelTextureSP texPlanetaryNebula;           // Type 3
    static StelTextureSP texDiffuseNebula;             // Type 4
    static StelTextureSP texDarkNebula;                // Type 5
    static StelTextureSP texOpenClusterWithNebulosity; // Type 7
    static float hintsBrightness;

    static Vec3f labelColor, circleColor;
    static float circleScale;       // Define the scaling of the hints circle
    static bool drawHintProportional; // scale hint with nebula size?
};

#endif // _NEBULA_HPP_