NebulaMgr.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 _NEBULAMGR_HPP_
#define _NEBULAMGR_HPP_

#include "StelObjectType.hpp"
#include "StelFader.hpp"
#include "StelSphericalIndex.hpp"
#include "StelObjectModule.hpp"
#include "StelTextureTypes.hpp"
#include "Nebula.hpp"

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

class StelTranslator;
class StelToneReproducer;
class QSettings;
class StelPainter;

typedef QSharedPointer<Nebula> NebulaP;

// GZ: This doc seems outdated/misleading - photo textures are not mamaged here but in StelSkyImageTile

class NebulaMgr : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool flagHintDisplayed
           READ getFlagHints
           WRITE setFlagHints)

public:
    NebulaMgr();
    virtual ~NebulaMgr();

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

    virtual void draw(StelCore* core);

    virtual void update(double deltaTime) {hintsFader.update((int)(deltaTime*1000)); flagShow.update((int)(deltaTime*1000));}

    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;

    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;
    virtual QString getName() const { return "Deep-sky objects"; }

    float computeMaxMagHint(const class StelSkyDrawer* skyDrawer) const;
    
    void setCatalogFilters(const Nebula::CatalogGroup& cflags);
    const Nebula::CatalogGroup& getCatalogFilters() const { return Nebula::catalogFilters; }

    void setTypeFilters(const Nebula::TypeGroup& tflags) { Nebula::typeFilters=tflags; }
    const Nebula::TypeGroup& getTypeFilters() const { return Nebula::typeFilters; }

    bool objectInDisplayedCatalog(NebulaP n);

    // Properties setters and getters
public slots:
    void setCirclesColor(const Vec3f& c);
    const Vec3f& getCirclesColor(void) const;

    void setGalaxyColor(const Vec3f& c);
    const Vec3f& getGalaxyColor(void) const;

    void setActiveGalaxyColor(const Vec3f& c);
    const Vec3f& getActiveGalaxyColor(void) const;

    void setInteractingGalaxyColor(const Vec3f& c);
    const Vec3f& getInteractingGalaxyColor(void) const;

    void setRadioGalaxyColor(const Vec3f& c);
    const Vec3f& getRadioGalaxyColor(void) const;

    void setQuasarColor(const Vec3f& c);
    const Vec3f& getQuasarColor(void) const;

    void setBrightNebulaColor(const Vec3f& c);
    const Vec3f& getBrightNebulaColor(void) const;

    void setNebulaColor(const Vec3f& c);
    const Vec3f& getNebulaColor(void) const;

    void setPlanetaryNebulaColor(const Vec3f& c);
    const Vec3f& getPlanetaryNebulaColor(void) const;

    void setReflectionNebulaColor(const Vec3f& c);
    const Vec3f& getReflectionNebulaColor(void) const;

    void setBipolarNebulaColor(const Vec3f& c);
    const Vec3f& getBipolarNebulaColor(void) const;

    void setEmissionNebulaColor(const Vec3f& c);
    const Vec3f& getEmissionNebulaColor(void) const;

    void setHydrogenRegionColor(const Vec3f& c);
    const Vec3f& getHydrogenRegionColor(void) const;

    void setSupernovaRemnantColor(const Vec3f& c);
    const Vec3f& getSupernovaRemnantColor(void) const;

    void setInterstellarMatterColor(const Vec3f& c);
    const Vec3f& getInterstellarMatterColor(void) const;

    void setDarkNebulaColor(const Vec3f& c);
    const Vec3f& getDarkNebulaColor(void) const;

    void setClusterWithNebulosityColor(const Vec3f& c);
    const Vec3f& getClusterWithNebulosityColor(void) const;

    void setClusterColor(const Vec3f& c);
    const Vec3f& getClusterColor(void) const;

    void setOpenClusterColor(const Vec3f& c);
    const Vec3f& getOpenClusterColor(void) const;

    void setGlobularClusterColor(const Vec3f& c);
    const Vec3f& getGlobularClusterColor(void) const;

    void setStellarAssociationColor(const Vec3f& c);
    const Vec3f& getStellarAssociationColor(void) const;

    void setStarCloudColor(const Vec3f& c);
    const Vec3f& getStarCloudColor(void) const;

    void setEmissionObjectColor(const Vec3f& c);
    const Vec3f& getEmissionObjectColor(void) const;

    void setBlLacObjectColor(const Vec3f& c);
    const Vec3f& getBlLacObjectColor(void) const;

    void setBlazarColor(const Vec3f& c);
    const Vec3f& getBlazarColor(void) const;

    void setMolecularCloudColor(const Vec3f& c);
    const Vec3f& getMolecularCloudColor(void) const;

    void setYoungStellarObjectColor(const Vec3f& c);
    const Vec3f& getYoungStellarObjectColor(void) const;

    void setPossibleQuasarColor(const Vec3f& c);
    const Vec3f& getPossibleQuasarColor(void) const;

    void setPossiblePlanetaryNebulaColor(const Vec3f& c);
    const Vec3f& getPossiblePlanetaryNebulaColor(void) const;

    void setProtoplanetaryNebulaColor(const Vec3f& c);
    const Vec3f& getProtoplanetaryNebulaColor(void) const;

    void setStarColor(const Vec3f& c);
    const Vec3f& getStarColor(void) const;

    void setCircleScale(float scale);
    float getCircleScale(void) const;

    void setHintsFadeDuration(float duration) {hintsFader.setDuration((int) (duration * 1000.f));}

    void setFlagHints(bool b) {hintsFader=b;}
    bool getFlagHints(void) const {return hintsFader;}

    void setHintsProportional(const bool proportional);
    bool getHintsProportional(void) const;

    void setFlagSurfaceBrightnessUsage(const bool usage) { Nebula::surfaceBrightnessUsage=usage; }
    bool getFlagSurfaceBrightnessUsage(void) const { return Nebula::surfaceBrightnessUsage; }

    void setFlagShow(bool b) { flagShow = b; }
    bool getFlagShow(void) const { return flagShow; }

    void setFlagTypeFiltersUsage(bool b) { Nebula::flagUsageTypeFilter=b; }
    bool getFlagTypeFiltersUsage(void) const { return Nebula::flagUsageTypeFilter; }

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

    void setLabelsAmount(float a) {labelsAmount=a;}
    float getLabelsAmount(void) const {return labelsAmount;}

    void setHintsAmount(float f) {hintsAmount = f;}
    float getHintsAmount(void) const {return hintsAmount;}

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

    void updateI18n();
    

private:

    NebulaP search(const QString& name);

    NebulaP search(const Vec3d& pos);

    void loadNebulaSet(const QString& setName);

    void drawPointer(const StelCore* core, StelPainter& sPainter);

    NebulaP searchDSO(unsigned int DSO);
    NebulaP searchM(unsigned int M);
    NebulaP searchNGC(unsigned int NGC);
    NebulaP searchIC(unsigned int IC);
    NebulaP searchC(unsigned int C);
    NebulaP searchB(unsigned int B);
    NebulaP searchSh2(unsigned int Sh2);
    NebulaP searchVdB(unsigned int VdB);
    NebulaP searchRCW(unsigned int RCW);
    NebulaP searchLDN(unsigned int LDN);
    NebulaP searchLBN(unsigned int LBN);
    NebulaP searchCr(unsigned int Cr);
    NebulaP searchMel(unsigned int Mel);
    NebulaP searchPGC(unsigned int PGC);
    NebulaP searchUGC(unsigned int UGC);
    NebulaP searchCed(QString Ced); 

    // Load catalog of DSO
    bool loadDSOCatalog(const QString& filename);
    void convertDSOCatalog(const QString& in, const QString& out, bool decimal);
    // Load proper names for DSO
    bool loadDSONames(const QString& filename);

    QVector<NebulaP> dsoArray;      // The DSO list
    QHash<unsigned int, NebulaP> dsoIndex;

    LinearFader hintsFader;
    LinearFader flagShow;

    StelSphericalIndex nebGrid;

    float hintsAmount;
    float labelsAmount;

    StelTextureSP texPointer;
    
    QFont nebulaFont;      // Font used for names printing

    // For DSO convertor
    bool flagConverter;
    bool flagDecimalCoordinates;
};

#endif // _NEBULAMGR_HPP_