Planet.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 _PLANET_HPP_
#define _PLANET_HPP_

#include <QString>

#include "StelObject.hpp"
#include "StelProjector.hpp"
#include "VecMath.hpp"
#include "StelFader.hpp"
#include "renderer/GenericVertexTypes.hpp"
#include "renderer/StelIndexBuffer.hpp"
#include "renderer/StelVertexBuffer.hpp"
#include "StelProjectorType.hpp"

// The callback type for the external position computation function
// The last variable is the userData pointer.
typedef void (*posFuncType)(double, double*, void*);

typedef void (OsculatingFunctType)(double jd0,double jd,double xyz[3]);

// epoch J2000: 12 UT on 1 Jan 2000
#define J2000 2451545.0
#define ORBIT_SEGMENTS 360

class StelFont;
class StelTranslator;

struct TrailPoint
{
    Vec3d point;
    double date;
};


struct ShadowPlanetShaderInfo
{
    int info;
    int current;
    int infoCount;
    float infoSize;
};

// Class used to store orbital elements
class RotationElements
{
public:
    RotationElements(void) : period(1.), offset(0.), epoch(J2000), obliquity(0.), ascendingNode(0.), precessionRate(0.) {}
    float period;          // rotation period
    float offset;          // rotation at epoch
    double epoch;
    float obliquity;       // tilt of rotation axis w.r.t. ecliptic
    float ascendingNode;   // long. of ascending node of equator on the ecliptic
    float precessionRate;  // rate of precession of rotation axis in rads/day
    double siderealPeriod; // sidereal period (Planet year in earth days)
};

// Class to manage rings for planets like saturn
class Ring
{
    friend class Planet;
public:
    Ring(double radiusMin,double radiusMax,const QString &texname);
    ~Ring(void);

    void draw(StelProjectorP projector, class StelRenderer* renderer, StelProjector::ModelViewTranformP transform, class StelGLSLShader *shader, double screenSz, ShadowPlanetShaderInfo *info);

    double getSize(void) const {return radiusMax;}
private:
    const double radiusMin;
    const double radiusMax;

    const QString texName;
    class StelTextureNew* texture;

    class StelGeometryRing* ring;
};

class Planet : public StelObject
{
protected:
    struct SharedPlanetGraphics
    {
        class StelTextureNew* texEarthShadow;
        class StelTextureNew* texHintCircle;
        class StelGLSLShader* simplePlanetShader;
        class StelGLSLShader* shadowPlanetShader;

        class StelGLSLShader* planetShader;

        bool initialized;

        ShadowPlanetShaderInfo info;

        SharedPlanetGraphics(): initialized(false){}
        ~SharedPlanetGraphics();
        void lazyInit(class StelRenderer* renderer);
        bool loadPlanetShaders(StelRenderer *renderer);
    };

public:
    friend class SolarSystem;
    Planet(const QString& englishName,
           int flagLighting,
           double radius,
           double oblateness,
           Vec3f color,
           float albedo,
           const QString& texMapName,
           posFuncType _coordFunc,
           void* userDataPtr,
           OsculatingFunctType *osculatingFunc,
           bool closeOrbit,
           bool hidden,
           bool hasAtmosphere,
           const QString &pType);

    ~Planet();

    // Methods inherited from StelObject
    virtual QString getInfoString(const StelCore *core, const InfoStringGroup& flags) const;
    virtual double getCloseViewFov(const StelCore* core) const;
    virtual double getSatellitesFov(const StelCore* core) const;
    virtual double getParentSatellitesFov(const StelCore* core) const;
    virtual float getVMagnitude(const StelCore* core, bool withExtinction=false) const;
    virtual float getSelectPriority(const StelCore* core) const;
    virtual Vec3f getInfoColor(void) const;
    virtual QString getType(void) const {return "Planet";}
    virtual Vec3d getJ2000EquatorialPos(const StelCore *core) const;
    virtual QString getEnglishName(void) const {return englishName;}
    virtual QString getNameI18n(void) const {return nameI18;}
    virtual double getAngularSize(const StelCore* core) const;
    virtual bool hasAtmosphere(void) {return atmosphere;}

    // Methods of SolarSystem object
    virtual void translateName(StelTranslator& trans);

    void draw(StelCore* core, class StelRenderer* renderer, float maxMagLabels,
              const QFont& planetNameFont, SharedPlanetGraphics& planetGraphics);

    // Methods specific to Planet
    double getRadius(void) const {return radius;}
    double getSiderealDay(void) const {return re.period;}
    double getSiderealPeriod(void) const { return re.siderealPeriod; }
    double getMeanSolarDay(void) const;

    const QString& getTextMapName() const {return texMapName;}  

    // Compute the z rotation to use from equatorial to geographic coordinates
    double getSiderealTime(double jd) const;
    Mat4d getRotEquatorialToVsop87(void) const;
    void setRotEquatorialToVsop87(const Mat4d &m);

    const RotationElements &getRotationElements(void) const {return re;}

    // Compute the position in the parent Planet coordinate system
    void computePositionWithoutOrbits(const double date);
    void computePosition(const double date);

    // Compute the transformation matrix from the local Planet coordinate to the parent Planet coordinate
    void computeTransMatrix(double date);

    // Compute the transformation matrix from model to world coordinates
    void computeModelMatrix(Mat4d& result) const;

    // Get the phase angle (rad) for an observer at pos obsPos in heliocentric coordinates (in AU)
    double getPhaseAngle(const Vec3d& obsPos) const;
    // Get the elongation angle (rad) for an observer at pos obsPos in heliocentric coordinates (in AU)
    double getElongation(const Vec3d& obsPos) const;
    // Get the angular size of the spheroid of the planet (i.e. without the rings)
    double getSpheroidAngularSize(const StelCore* core) const;
    // Get the planet phase for an observer at pos obsPos in heliocentric coordinates (in AU)
    float getPhase(const Vec3d& obsPos) const;

    // Set the orbital elements
    void setRotationElements(float _period, float _offset, double _epoch,
                 float _obliquity, float _ascendingNode,
                 float _precessionRate, double _siderealPeriod);
    double getRotAscendingnode(void) const {return re.ascendingNode;}
    double getRotObliquity(void) const {return re.obliquity;}

    Vec3d getEclipticPos() const;

    // Return the heliocentric ecliptical position
    Vec3d getHeliocentricEclipticPos() const;

    // Return the heliocentric transformation for local coordinate
    Vec3d getHeliocentricPos(Vec3d) const;
    void setHeliocentricEclipticPos(const Vec3d &pos);

    // Compute the distance to the given position in heliocentric coordinate (in AU)
    double computeDistance(const Vec3d& obsHelioPos);
    double getDistance(void) const {return distance;}

    void setRings(Ring* r) {rings = r;}

    void setSphereScale(float s);

    float getSphereScale(void) const {return sphereScale;}

    const QSharedPointer<Planet> getParent(void) const {return parent;}

    static void setLabelColor(const Vec3f& lc) {labelColor = lc;}
    static const Vec3f& getLabelColor(void) {return labelColor;}

    void update(int deltaTime);

    void setFlagHints(bool b){hintFader = b;}
    bool getFlagHints(void) const {return hintFader;}

    void setFlagLabels(bool b){flagLabels = b;}
    bool getFlagLabels(void) const {return flagLabels;}

    // DEPRECATED
    // Should move to an OrbitPath class which works on a SolarSystemObject, not a Planet
    void setFlagOrbits(bool b){orbitFader = b;}
    bool getFlagOrbits(void) const {return orbitFader;}

    struct Vertex2D
    {
        Vec2f position;
        Vertex2D(const float x, const float y) : position(x, y){}
        VERTEX_ATTRIBUTES(Vec2f Position);
    };

    StelVertexBuffer<Vertex2D>* orbitVertices;

    LinearFader orbitFader;
    // draw orbital path of Planet
    void drawOrbit(const StelCore* core, class StelRenderer* renderer);
    Vec3d orbit[ORBIT_SEGMENTS+1];   // store heliocentric coordinates for drawing the orbit
    Vec3d orbitP[ORBIT_SEGMENTS+1];  // store local coordinate for orbit
    double lastOrbitJD;
    double deltaJD;
    double deltaOrbitJD;
    bool orbitCached;                // whether orbit calculations are cached for drawing orbit yet
    bool closeOrbit;                 // whether to connect the beginning of the orbit line to
                                     // the end: good for elliptical orbits, bad for parabolic
                                     // and hyperbolic orbits

    static Vec3f orbitColor;
    static void setOrbitColor(const Vec3f& oc) {orbitColor = oc;}
    static const Vec3f& getOrbitColor() {return orbitColor;}

protected:
    // draw earth shadow on moon for lunar eclipses
    void drawEarthShadow(StelCore* core, class StelRenderer* renderer, 
                         SharedPlanetGraphics& planetGraphics);

    // Return the information string "ready to print" :)
    QString getSkyLabel(const StelCore* core) const;

    void draw3dModel(StelCore* core, class StelRenderer* renderer, 
                     SharedPlanetGraphics& planetGraphics,
                     StelProjector::ModelViewTranformP transfo, float screenSz);

    void drawUnlitSphere(class StelRenderer* renderer, StelProjectorP projector);

    void drawSphere(class StelRenderer* renderer, StelProjectorP projector,
                   const struct StelLight* light, SharedPlanetGraphics &planetGraphics, float screenSz);

    // Draw the circle and name of the Planet
    void drawHints(const StelCore* core, class StelRenderer* renderer, 
                   const QFont& planetNameFont, SharedPlanetGraphics& planetGraphics);

    QString englishName;             // english planet name
    QString nameI18;                 // International translated name
    QString texMapName;              // Texture file path   
    RotationElements re;             // Rotation param

    // Note: vertex/index buffer generation depends on the fact that 
    // flagLighting, radius and oneMinusOblateness don't change.
    // If they change, buffers will have to be regenerated to reflect the change.
    const int flagLighting;          // Set whether light computation has to be proceed
    const double radius;             // Planet radius in AU
    const double oneMinusOblateness; // (polar radius)/(equatorial radius)
    Vec3d eclipticPos;               // Position in AU in the rectangular ecliptic coordinate system
                                     // centered on the parent Planet
    Vec3d screenPos;                 // Used to store temporarily the 2D position on screen
    Vec3d previousScreenPos;         // The position of this planet in the previous frame.
    Vec3f color;

    float albedo;                    // Planet albedo
    Mat4d rotLocalToParent;
    float axisRotation;              // Rotation angle of the Planet on it's axis 

    class StelTextureNew* texture;   // Planet map texture

    Ring* rings;                     // Planet rings
    double distance;                 // Temporary variable used to store the distance to a given point
                                     // it is used for sorting while drawing
    float sphereScale;               // Artificial scaling for better viewing
    double lastJD;
    // The callback for the calculation of the equatorial rect heliocentric position at time JD.
    posFuncType coordFunc;
    void* userDataPtr;

    OsculatingFunctType *const osculatingFunc;
    QSharedPointer<Planet> parent;           // Planet parent i.e. sun for earth
    QList<QSharedPointer<Planet> > satellites;      // satellites of the Planet
    LinearFader hintFader;
    LinearFader labelsFader;         // Store the current state of the label for this planet
    bool flagLabels;                 // Define whether labels should be displayed
    bool hidden;                     // useful for fake planets used as observation positions - not drawn or labeled
    bool atmosphere;                 // Does the planet have an atmosphere?
    QString pType;           // Type of body

    class StelGeometrySphere* unlitSphere;
    class StelGeometrySphere* litSphere;

    static Vec3f labelColor;
};

#endif // _PLANET_HPP_