simgear/ephemeris/ephemeris.hxx

   1 /** \file ephemeris.hxx
   2  * Top level class for calculating current positions of astronomical objects.
   3  */
   4
   5 // Top level interface written by Curtis Olson, started March 2000.
   6 //
   7 // All the core code underneath this is written by Durk Talsma.  See
   8 // the headers of all the other individual files for details.
   9 //
  10 // Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
  11 //
  12 // This library is free software; you can redistribute it and/or
  13 // modify it under the terms of the GNU Library General Public
  14 // License as published by the Free Software Foundation; either
  15 // version 2 of the License, or (at your option) any later version.
  16 //
  17 // This library is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 // Library General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU Library General Public
  23 // License along with this library; if not, write to the
  24 // Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 // Boston, MA  02111-1307, USA.
  26 //
  27 // $Id$
  28
  29
  30 #ifndef _EPHEMERIS_HXX
  31 #define _EPHEMERIS_HXX
  32
  33
  34 #include <plib/sg.h>
  35
  36 #include <simgear/ephemeris/star.hxx>
  37 #include <simgear/ephemeris/moonpos.hxx>
  38 #include <simgear/ephemeris/mercury.hxx>
  39 #include <simgear/ephemeris/venus.hxx>
  40 #include <simgear/ephemeris/mars.hxx>
  41 #include <simgear/ephemeris/jupiter.hxx>
  42 #include <simgear/ephemeris/saturn.hxx>
  43 #include <simgear/ephemeris/uranus.hxx>
  44 #include <simgear/ephemeris/neptune.hxx>
  45 #include <simgear/ephemeris/stardata.hxx>
  46
  47
  48 /** Ephemeris class
  49  *
  50  * Written by Durk Talsma <d.talsma@direct.a2000.nl> and Curtis Olson
  51  * <curt@flightgear.org>
  52  *
  53  * Introduction
  54  *
  55  * The SGEphemeris class computes and stores the positions of the Sun,
  56  * the Moon, the planets, and the brightest stars.  These positions
  57  * can then be used to accurately render the dominant visible items in
  58  * the Earth's sky. Note, this class isn't intended for use in an
  59  * interplanetary/interstellar/intergalactic type application. It is
  60  * calculates everything relative to the Earth and is therefore best
  61  * suited for Earth centric applications.
  62  *
  63  * The positions of the various astronomical objects are time
  64  * dependent, so to maintain accuracy, you will need to periodically
  65  * call the update() method. The SGTime class conveniently provides
  66  * the two time related values you need to pass to the update()
  67  * method.
  68  */
  69
  70 class SGEphemeris {
  71
  72     Star *our_sun;
  73     MoonPos *moon;
  74     Mercury *mercury;
  75     Venus *venus;
  76     Mars *mars;
  77     Jupiter *jupiter;
  78     Saturn *saturn;
  79     Uranus *uranus;
  80     Neptune *neptune;
  81
  82     // 9 planets, minus earth, minus pluto which we don't draw = 7
  83     // planets[i][0] = Right Ascension
  84     // planets[i][1] = Declination
  85     // planets[i][2] = Magnitude
  86     int nplanets;
  87     sgdVec3 planets[7];
  88
  89     SGStarData *stars;
  90
  91 public:
  92
  93     /**
  94      * Constructor.
  95      * This creates an instance of the SGEphemeris object. When
  96      * calling the constructor you need to provide a path pointing to
  97      * your star database file.
  98      * @param path path to your star database */
  99     SGEphemeris( const string &path );
 100
 101     /** Destructor */
 102     ~SGEphemeris( void );
 103
 104     /**
 105      * Update (recalculate) the positions of all objects for the
 106      * specified time.  The update() method requires you to pass in
 107      * the current modified Julian date, the current local sidereal
 108      * time, and the current latitude. The update() method is designed
 109      * to be called by the host application before every frame.
 110      * @param mjd modified julian date
 111      * @param lst current local sidereal time
 112      * @param lat current latitude
 113      */
 114     void update(double mjd, double lst, double lat);
 115
 116     /**
 117      * @return a pointer to a Star class containing all the positional
 118      * information for Earth's Sun.
 119      */
 120     inline Star *get_sun() const { return our_sun; }
 121
 122     /** @return the right ascension of the Sun. */
 123     inline double getSunRightAscension() const {
 124         return our_sun->getRightAscension();
 125     }
 126
 127     /** @return the declination of the Sun. */
 128     inline double getSunDeclination() const {
 129         return our_sun->getDeclination();
 130     }
 131
 132     /**
 133      * @return a pointer to a Moon class containing all the positional
 134      * information for Earth's Moon.
 135      */
 136     inline MoonPos *get_moon() const { return moon; }
 137
 138     /** @return the right ascension of the Moon. */
 139     inline double getMoonRightAscension() const {
 140         return moon->getRightAscension();
 141     }
 142
 143     /** @return the declination of the Moon. */
 144     inline double getMoonDeclination() const {
 145         return moon->getDeclination();
 146     }
 147
 148     /** @return the numbers of defined planets. */
 149     inline int getNumPlanets() const { return nplanets; }
 150
 151     /**
 152      * Returns a pointer to an array of planet data in sgdVec3
 153      * format. (See plib.sourceforge.net for information on plib and
 154      * the ``sg'' package.) An sgdVec3 is a 3 element double
 155      * array. The first element is the right ascension of the planet,
 156      * the second is the declination, and the third is the magnitude.
 157      * @return planets array
 158      */
 159     inline sgdVec3 *getPlanets() { return planets; }
 160
 161     /** @return the numbers of defined stars. */
 162     inline int getNumStars() const { return stars->getNumStars(); }
 163
 164     /**
 165      * Returns a pointer to an array of star data in sgdVec3
 166      * format. An The first element of the sgdVec3 is the right
 167      * ascension of the planet, the second is the declination, and the
 168      * third is the magnitude.
 169      * @returns star array
 170      */
 171     inline sgdVec3 *getStars() { return stars->getStars(); }
 172 };
 173
 174
 175 #endif // _EPHEMERIS_HXX
 176
 177