starobject.h

Go to the documentation of this file.

/***************************************************************************
                          starobject.h  -  K Desktop Planetarium
                             -------------------
    begin                : Tue Sep 18 2001
    copyright            : (C) 2001 by Thomas Kabelmann
    email                : tk78@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 STAROBJECT_H_
#define STAROBJECT_H_

#include <QMap>
#include <QPixmap>

#include "skyobject.h"
#include "stardata.h"
#include "deepstardata.h"

class KSPopupMenu;
class KStarsData;

class StarObject : public SkyObject
{
public:

    static double reindexInterval( double pm );

    explicit StarObject( dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString(),
                         const QString &n2=QString(), const QString &sptype="--", double pmra=0.0, double pmdec=0.0,
                         double par=0.0, bool mult=false, bool var=false, int hd=0 );
    StarObject( double r, double d, float m=0.0, const QString &n=QString(),
                const QString &n2=QString(), const QString &sptype="--", double pmra=0.0, double pmdec=0.0,
                double par=0.0, bool mult=false, bool var=false, int hd=0 );

    virtual StarObject* clone() const;
    virtual UID getUID() const;
   
    StarObject(const StarObject& o);

    ~StarObject() { }

    void init( const starData *stardata );
    
    void init( const deepStarData *stardata );

    void setNames( QString name, QString name2 );

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

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

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

    QString sptype( void ) const;

    char spchar() const;

    QString gname( bool useGreekChars=true ) const;

    QString greekLetter( bool useGreekChars=true ) const;

    QString constell( void ) const;

    virtual void updateCoords( KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute = false );

    /* @short fills ra and dec with the coordinates of the star with the proper
     * motion correction but without precesion and its friends.  It is used
     * in StarComponent to re-index all the stars.
     *
     * NOTE: ra and dec both in degrees.
     */
    void getIndexCoords( KSNumbers *num, double *ra, double *dec );

    void JITupdate();

    inline double pmMagnitude()
    {
        double cosDec = dec0().cos();
        return sqrt( cosDec * cosDec * pmRA() * pmRA() + pmDec() * pmDec() );
    }

    inline double pmMagnitudeSquared()
    {
        double metric_weighted_pmRA = dec0().cos() * pmRA();
        return (metric_weighted_pmRA * metric_weighted_pmRA + pmDec() * pmDec());
    }

    inline void setProperMotion( double pmra, double pmdec ) { PM_RA = pmra; PM_Dec = pmdec; }

    inline double pmRA() const { return PM_RA; }

    inline double pmDec() const { return PM_Dec; }

    inline void setParallax( double plx ) { Parallax = plx; }

    inline double parallax() const { return Parallax; }

    inline double distance() const { return 1000./parallax(); }

    inline void setMultiple( bool m ) { Multiplicity = m; }

    inline bool isMultiple() const { return Multiplicity; }

    inline int getHDIndex() const { return HD; }

    inline void setVariable( bool v ) { Variability = v; }

    inline bool isVariable() const { return Variability; }

    /* @short returns the name, the magnitude or both.
     */
    QString nameLabel( bool drawName, bool drawMag ) const;

    virtual QString labelString() const;

    virtual double labelOffset() const;

    inline float getVMag() const { return V; }

    inline float getBMag() const { return B; }

    inline float getBVIndex() const { return ( ( B < 30.0 && V < 30.0 ) ? B - V : 99.9 ); }

    quint64 updateID;
    quint64 updateNumID;

protected:
    // DEBUG EDIT. For testing proper motion, uncomment this, and related blocks
    // See starobject.cpp for further info.
    //    static QVector<SkyPoint *> Trail;
    //    bool testStar;
    // END DEBUG

private:
    virtual void initPopupMenu( KSPopupMenu *pmenu);

    char SpType[2];

    double PM_RA, PM_Dec, Parallax;  //, VRange, VPeriod;
    bool Multiplicity, Variability;
    int HD;
    float B, V; // B and V magnitudes, separately. NOTE 1) This is kept separate from mag for a reason. See init( const deepStarData *); 2) This applies only to deep stars at the moment
};

#endif