skyobject.h

Go to the documentation of this file.

/***************************************************************************
                          skyobject.h  -  K Desktop Planetarium
                             -------------------
    begin                : Sun Feb 11 2001
    copyright            : (C) 2001 by Jason Harris
    email                : jharris@30doradus.org
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SKYOBJECT_H_
#define SKYOBJECT_H_

#include <QString>
#include <QStringList>
#include <QSharedDataPointer>

#include <klocale.h>

#include "skypoint.h"
#include "kstars/dms.h"
#include "auxinfo.h"

class QPoint;
class QPainter;
class GeoLocation;
class KStarsDateTime;
class KSPopupMenu;

class SkyObject : public SkyPoint {
public:
    typedef qint64 UID;

    static const UID UID_STAR;
    static const UID UID_GALAXY;
    static const UID UID_DEEPSKY;
    static const UID UID_SOLARSYS;
    
    static const UID invalidUID;
    
    explicit SkyObject( int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0),
                        float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString() );
    SkyObject( int t, double r, double d, float m=0.0,
               const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString() );

    virtual ~SkyObject();

    virtual SkyObject* clone() const;

    enum TYPE { STAR=0, CATALOG_STAR=1, PLANET=2, OPEN_CLUSTER=3, GLOBULAR_CLUSTER=4,
                GASEOUS_NEBULA=5, PLANETARY_NEBULA=6, SUPERNOVA_REMNANT=7, GALAXY=8,
                COMET=9, ASTEROID=10, CONSTELLATION=11, MOON=12, ASTERISM=13, 
                GALAXY_CLUSTER=14, DARK_NEBULA=15, QUASAR=16, MULT_STAR=17, RADIO_SOURCE=18,
                SATELLITE=19, SUPERNOVA=20, TYPE_UNKNOWN };

    static QString typeName( const int t );

    inline virtual QString name( void ) const { return hasName() ? Name : unnamedString;}

    inline QString translatedName() const { return i18n( name().toUtf8() );}

    inline QString name2( void ) const { return ( hasName2() ? Name2 : emptyString ); }

    inline QString translatedName2() const { return ( hasName2() ? i18n( Name2.toUtf8() ): emptyString );}

    virtual QString longname( void ) const { return hasLongName() ? LongName : unnamedObjectString; }

    QString translatedLongName() const { return i18n( longname().toUtf8() );}

    void setLongName( const QString &longname=QString() );

    virtual QString labelString() const;

    inline int type( void ) const { return (int)Type; }

    inline void setType( int t ) { Type = (unsigned char)t; }

    QString typeName() const;

    inline float mag( void ) const { return sortMagnitude; }

    inline float mag( const QString &band ) const { return m_Magnitudes.value( band, NaN::f ); }

    inline virtual double pa() const { return 0.0; }

    inline bool isSolarSystem() const { return ( type() == 2 || type() == 9 || type() == 10 || type() == 12 ); }

    void showPopupMenu( KSPopupMenu *pmenu, const QPoint &pos );

    QTime riseSetTime( const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true );

    QTime riseSetTimeUT( const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true );

    dms riseSetTimeAz( const KStarsDateTime &dt, const GeoLocation *geo, bool rst);

    QTime transitTime( const KStarsDateTime &dt, const GeoLocation *geo );

    QTime transitTimeUT( const KStarsDateTime &dt, const GeoLocation *geo );

    dms transitAltitude( const KStarsDateTime &dt, const GeoLocation *geo );

    SkyPoint recomputeCoords( const KStarsDateTime &dt, const GeoLocation *geo=0 );

    inline bool hasName() const { return ! Name.isEmpty(); }

    inline bool hasName2() const { return ! Name2.isEmpty(); }

    inline bool hasLongName() const { return ! LongName.isEmpty(); }

    QString messageFromTitle( const QString &imageTitle );

    void saveUserLog( const QString &newLog );

    virtual double labelOffset() const;

    inline bool hasAuxInfo() { return ! (!info); }

    inline QStringList &ImageList() { return getAuxInfo()->ImageList; }

    inline QStringList &ImageTitle() { return getAuxInfo()->ImageTitle; }

    inline QStringList &InfoList() { return getAuxInfo()->InfoList; }

    inline QStringList &InfoTitle() { return getAuxInfo()->InfoTitle; }

    inline QString &userLog() { return getAuxInfo()->userLog; }

    inline QString &notes() { return getAuxInfo()->notes; }

    void setNotes( QString _notes) { getAuxInfo()->notes = _notes; }

    virtual UID getUID() const;

private:
    virtual void initPopupMenu(KSPopupMenu* pmenu);

    QTime auxRiseSetTimeUT( const KStarsDateTime &dt, const GeoLocation *geo,
                            const dms *righta, const dms *decl, bool riseT);

    dms auxRiseSetTimeLST( const dms *gLt, const dms *rga, const dms *decl, bool rst );

    double approxHourAngle( const dms *h, const dms *gLat, const dms *d );

    dms elevationCorrection(void);

    AuxInfo *getAuxInfo();

    unsigned char Type;
    float sortMagnitude; // This magnitude is used for sorting / making decisions about the visibility of an object. Should not be NaN.
    QHash<QString, float> m_Magnitudes; // Magnitudes vs. band

protected:
    inline void setMag( float m ) { sortMagnitude = m < 36.0 ? m : NaN::f; } // Updating faintest sane magnitude to 36.0 (faintest visual magnitude visible with E-ELT, acc. to Wikipedia on Apparent Magnitude.)

    void setMag( const QString &band, const double mag );

    inline void setName( const QString &name ) { Name = name; }

    inline void setName2( const QString &name2=QString() ) { Name2 = name2; }

    QString Name, Name2, LongName;

    // Pointer to an auxiliary info structure that stores Image URLs, Info URLs etc.
    QSharedDataPointer<AuxInfo> info;

    // store often used name strings in static variables
    static QString emptyString;
    static QString unnamedString;
    static QString unnamedObjectString;
    static QString starString;
};

#endif