StelObject.hpp

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

#include "VecMath.hpp"
#include "StelObjectType.hpp"
#include "StelRegionObject.hpp"

#include <QFlags>
#include <QString>

class StelCore;

class StelObject : public StelRegionObject
{
    //Required for Q_FLAGS macro, this requires this header to be MOC'ed
    Q_GADGET
    Q_FLAGS(InfoStringGroupFlags InfoStringGroup)
public:
    enum InfoStringGroupFlags
    {
        Name            = 0x00000001, 
        CatalogNumber       = 0x00000002, 
        Magnitude       = 0x00000004, 
        RaDecJ2000      = 0x00000008, 
        RaDecOfDate     = 0x00000010, 
        AltAzi          = 0x00000020, 
        Distance        = 0x00000040, 
        Size            = 0x00000080, 
        Extra           = 0x00000100, 
        HourAngle       = 0x00000200, 
        AbsoluteMagnitude   = 0x00000400, 
        GalacticCoord       = 0x00000800, 
        SupergalacticCoord  = 0x00001000, 
        ObjectType      = 0x00002000, 
        EclipticCoordJ2000  = 0x00004000, 
        EclipticCoordOfDate = 0x00008000, 
        IAUConstellation        = 0x00010000, 
        SiderealTime        = 0x00020000, 
        NoFont          = 0x00040000,
        PlainText       = 0x00080000,  
// TODO GZ
//      RaDecJ2000Planetocentric  = 0x00020000, //!< The planetocentric equatorial position (J2000 ref) [Mostly to compare with almanacs]
//      RaDecOfDatePlanetocentric = 0x00040000  //!< The planetocentric equatorial position (of date)


    };
    Q_DECLARE_FLAGS(InfoStringGroup, InfoStringGroupFlags)

    
    static const InfoStringGroupFlags AllInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000|RaDecOfDate|AltAzi|Distance|Size|Extra|HourAngle|
                                       AbsoluteMagnitude|GalacticCoord|SupergalacticCoord|ObjectType|EclipticCoordJ2000|
                                       EclipticCoordOfDate|IAUConstellation|SiderealTime);
    static const InfoStringGroupFlags ShortInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000);

    virtual ~StelObject() {}

    virtual SphericalRegionP getRegion() const {return SphericalRegionP(new SphericalPoint(getJ2000EquatorialPos(Q_NULLPTR)));}

    virtual Vec3d getPointInRegion() const {return getJ2000EquatorialPos(Q_NULLPTR);}
    
    virtual QString getInfoString(const StelCore *core, const InfoStringGroup& flags=StelObject::AllInfo) const = 0;

    virtual QVariantMap getInfoMap(const StelCore *core) const;

    virtual QString getType() const = 0;

    virtual QString getID() const = 0;

    virtual QString getEnglishName() const = 0;

    virtual QString getNameI18n() const = 0;

    virtual Vec3d getJ2000EquatorialPos(const StelCore* core) const = 0;

    Vec3d getEquinoxEquatorialPos(const StelCore* core) const;
    Vec3d getEquinoxEquatorialPosApparent(const StelCore* core) const;
    Vec3d getEquinoxEquatorialPosAuto(const StelCore* core) const;

    Vec3d getGalacticPos(const StelCore* core) const;

    Vec3d getSupergalacticPos(const StelCore* core) const;

    Vec3d getSiderealPosGeometric(const StelCore* core) const;

    Vec3d getSiderealPosApparent(const StelCore* core) const;

    Vec3d getAltAzPosGeometric(const StelCore* core) const;

    Vec3d getAltAzPosApparent(const StelCore* core) const;

    Vec3d getAltAzPosAuto(const StelCore* core) const;

    bool isAboveHorizon(const StelCore* core) const;

    bool isAboveRealHorizon(const StelCore* core) const;

    virtual float getVMagnitude(const StelCore* core) const;
    
    float getVMagnitudeWithExtinction(const StelCore* core) const;

    virtual float getSelectPriority(const StelCore*) const;

    virtual Vec3f getInfoColor() const {return Vec3f(1,1,1);}

    virtual double getCloseViewFov(const StelCore*) const {return 10.;}

    virtual double getSatellitesFov(const StelCore*) const {return -1.;}
    virtual double getParentSatellitesFov(const StelCore*) const {return -1.;}

    virtual double getAngularSize(const StelCore* core) const = 0;

protected:

    QString getCommonInfoString(const StelCore *core, const InfoStringGroup& flags) const;

    void postProcessInfoString(QString& str, const InfoStringGroup& flags) const;
private:
    static int stelObjectPMetaTypeID;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(StelObject::InfoStringGroup)

#endif // _STELOBJECT_HPP_