core/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 <QString>
#include "VecMath.hpp"
#include "StelObjectType.hpp"
#include "StelRegionObject.hpp"

class StelCore;

class StelObject : public StelRegionObject
{
public:
    enum InfoStringGroup
    {
        Name          = 0x00000001, 
        CatalogNumber = 0x00000002, 
        Magnitude     = 0x00000004, 
        RaDecJ2000    = 0x00000008, 
        RaDecOfDate   = 0x00000010, 
        AltAzi        = 0x00000020, 
        Distance      = 0x00000040, 
        Size          = 0x00000080, 
        Extra1        = 0x00000100, 
        Extra2        = 0x00000200, 
        Extra3        = 0x00000400, 
        PlainText     = 0x00000800, 
        HourAngle     = 0x00001000,  
        AbsoluteMagnitude = 0x00002000  
    };

    static const InfoStringGroup AllInfo = (InfoStringGroup)(Name|CatalogNumber|Magnitude|RaDecJ2000|RaDecOfDate|AltAzi|Distance|Size|Extra1|Extra2|Extra3|HourAngle|AbsoluteMagnitude);
    static const InfoStringGroup ShortInfo = (InfoStringGroup)(Name|CatalogNumber|Magnitude|RaDecJ2000);

    virtual ~StelObject() {}

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

    virtual QString getInfoString(const StelCore *core, const InfoStringGroup& flags=StelObject::AllInfo) const = 0;

    virtual QString getType() 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 getSideralPosGeometric(const StelCore* core) const;

    Vec3d getSideralPosApparent(const StelCore* core) const;

    Vec3d getAltAzPosGeometric(const StelCore* core) const;

    Vec3d getAltAzPosApparent(const StelCore* core) const;

    Vec3d getAltAzPosAuto(const StelCore* core) const;

    virtual float getVMagnitude(const StelCore* core, bool withExtinction=false) const;

    virtual float getSelectPriority(const StelCore*) const {return 99;}

    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 getPositionInfoString(const StelCore *core, const InfoStringGroup& flags) const;

    void postProcessInfoString(QString& str, const InfoStringGroup& flags) const;
};

#endif // _STELOBJECT_HPP_