ksplanetbase.h

Go to the documentation of this file.

/***************************************************************************
                          ksplanetbase.h  -  K Desktop Planetarium
                             -------------------
    begin                : Sun Jan 29 2002
    copyright            : (C) 2002 by Mark Hollomon
    email                : mhh@mindspring.com
 ***************************************************************************/

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


#include <QList>
#include <QImage>
#include <QColor>

#include <kdebug.h>

#include "trailobject.h"

class KSNumbers;
class KSPopupMenu;

class EclipticPosition {
public:
    dms longitude;
    dms latitude;
    double radius;

    explicit EclipticPosition(dms plong = dms(), dms plat = dms(), double prad = 0.0) :
        longitude(plong), latitude(plat), radius(prad)
    {}
};

class KSPlanetBase : public TrailObject {
public:
    explicit KSPlanetBase( const QString &s = i18n("unnamed"),
                           const QString &image_file=QString(),
                           const QColor &c=Qt::white, double pSize=0 );

    virtual ~KSPlanetBase() {}

    void init(const QString &s, const QString &image_file, const QColor &c, double pSize );

    enum Planets { MERCURY=0, VENUS=1, MARS=2, JUPITER=3, SATURN=4, URANUS=5, NEPTUNE=6, PLUTO=7, SUN=8, MOON=9, UNKNOWN_PLANET };

    static KSPlanetBase* createPlanet( int n );

    static QVector<QColor> planetColor;

    virtual bool loadData() = 0;

    const dms& ecLong() const { return ep.longitude; }

    const dms& ecLat() const { return ep.latitude; }

    void setEcLong( dms elong ) { ep.longitude = elong; }

    void setEcLat( dms elat ) { ep.latitude = elat; }

    const dms& helEcLong() const { return helEcPos.longitude; }

    const dms& helEcLat() const { return helEcPos.latitude; }

    void EclipticToEquatorial( const dms *Obliquity );

    void EquatorialToEcliptic( const dms *Obliquity );

    const QImage& image() { return m_image; }

    double rsun() const { return ep.radius; }

    void setRsun( double r ) { ep.radius = r; }

    double rearth() const { return Rearth; }

    void setRearth( double r ) { Rearth = r; }

    void setRearth( const KSPlanetBase *Earth );

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

    void findPosition( const KSNumbers *num, const dms *lat=0, const dms *LST=0, const KSPlanetBase *Earth = 0 );

    virtual double pa() const { return PositionAngle; }

    void setPA( double p ) { PositionAngle = p; }

    double angSize() const { return AngularSize; }

    void setAngularSize( double size ) { AngularSize = size; }

    double physicalSize() const { return PhysicalSize; }

    void setPhysicalSize( double size ) { PhysicalSize = size; }

    inline dms phase() { return dms( Phase ); }

    QColor& color() { return m_Color; }

    void setColor( const QColor &c ) { m_Color = c; }

    bool isMajorPlanet() const;

    virtual double labelOffset() const;

protected:
    static const UID UID_SOL_BIGOBJ;
    static const UID UID_SOL_ASTEROID;
    static const UID UID_SOL_COMET;

    inline UID solarsysUID(UID type) const { return (SkyObject::UID_SOLARSYS << 60) | (type << 56); }
   
    virtual bool findGeocentricPosition( const KSNumbers *num, const KSPlanetBase *Earth=NULL ) = 0;

    virtual void findMagnitude(const KSNumbers *num) = 0;

    void findPA( const KSNumbers *num );

    virtual void findPhase();

    // Geocentric ecliptic position, but distance to the Sun
    EclipticPosition ep;

    // Heliocentric ecliptic position referred to the equinox of the epoch
    // as obtained from VSOP.
    EclipticPosition helEcPos;
    double  Rearth;
    double Phase;
    QImage m_image;

private:
    void localizeCoords( const KSNumbers *num, const dms *lat, const dms *LST );

    double PositionAngle, AngularSize, PhysicalSize;
    QColor m_Color;
};

#endif