simgear/scene/model/location.hxx

   1 // location.hxx -- class for determining model location in the flightgear world.
   2 //
   3 // Written by Jim Wilson, David Megginson, started April 2002.
   4 //
   5 // Copyright (C) 2002  Jim Wilson, David Megginson
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _SG_LOCATION_HXX
  25 #define _SG_LOCATION_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include <simgear/compiler.h>
  33 #include <simgear/constants.h>
  34 #include <simgear/math/point3d.hxx>
  35
  36 #include <plib/sg.h>            // plib include
  37
  38
  39 // Define a structure containing view information
  40 class SGLocation
  41 {
  42
  43 public:
  44     // Constructor
  45     SGLocation( void );
  46
  47     // Destructor
  48     virtual ~SGLocation( void );
  49
  50     //////////////////////////////////////////////////////////////////////
  51     // Part 2: user settings.
  52     //////////////////////////////////////////////////////////////////////
  53
  54     // Geodetic position of model...
  55     virtual double getLongitude_deg () const { return _lon_deg; }
  56     virtual double getLatitude_deg () const { return _lat_deg; }
  57     virtual double getAltitudeASL_ft () const { return _alt_ft; }
  58     virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
  59
  60
  61     // Reference orientation rotations...
  62     //   These are rotations that represent the plane attitude effect on
  63     //   the view (in Pilot view).  IE The view frustrum rotates as the plane
  64     //   turns, pitches, and rolls.
  65     //   In model view (lookat/chaseview) these end up changing the angle that
  66     //   the eye is looking at the ojbect (ie the model).
  67     //   FIXME: the FGModel class should have its own version of these so that
  68     //   it can generate it's own model rotations.
  69     virtual double getRoll_deg () const { return _roll_deg; }
  70     virtual double getPitch_deg () const {return _pitch_deg; }
  71     virtual double getHeading_deg () const {return _heading_deg; }
  72     virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
  73
  74
  75     //////////////////////////////////////////////////////////////////////
  76     // Part 3: output vectors and matrices in FlightGear coordinates.
  77     //////////////////////////////////////////////////////////////////////
  78
  79     // Vectors and positions...
  80
  81     //! Get the absolute view position in fgfs coordinates.
  82     virtual double * get_absolute_view_pos( );
  83
  84     //! Return the position relative to the given scenery center.
  85     virtual float * get_view_pos( const Point3D& scenery_center );
  86
  87     // Get world up vector
  88     virtual float *get_world_up()
  89     { recalcAbsolutePosition(); return _world_up; }
  90
  91     // Get surface east vector
  92     virtual float *get_surface_east()
  93     { recalcAbsolutePosition(); return _surface_east; }
  94
  95     // Get surface south vector
  96     virtual float *get_surface_south()
  97     { recalcAbsolutePosition(); return _surface_south; }
  98
  99     // Elevation of ground under location (based on scenery output)...
 100     void set_cur_elev_m ( double elev )      { _cur_elev_m = elev; }
 101     inline double get_cur_elev_m ()          { return _cur_elev_m; }
 102
 103     // Matrices...
 104     virtual const sgVec4 *getTransformMatrix() {
 105         recalcOrientation();
 106         return TRANS;
 107     }
 108     virtual const sgVec4 *getCachedTransformMatrix() { return TRANS; }
 109
 110     virtual const sgVec4 *getUpMatrix(const Point3D& scenery_center)  {
 111         recalcAbsolutePosition();
 112         return UP;
 113     }
 114     virtual const sgVec4 *getCachedUpMatrix() { return UP; }
 115
 116 private:
 117
 118     //////////////////////////////////////////////////////////////////
 119     // private data                                                 //
 120     //////////////////////////////////////////////////////////////////
 121
 122     // flag forcing a recalc of derived view parameters
 123     mutable bool _orientation_dirty, _position_dirty;
 124
 125     mutable sgdVec3 _absolute_view_pos;
 126     mutable sgVec3 _relative_view_pos;
 127
 128     double _lon_deg;
 129     double _lat_deg;
 130     double _alt_ft;
 131
 132     double _roll_deg;
 133     double _pitch_deg;
 134     double _heading_deg;
 135
 136     // elevation of ground under this location...
 137     double _cur_elev_m;
 138
 139     // surface vector heading south
 140     mutable sgVec3 _surface_south;
 141
 142     // surface vector heading east (used to unambiguously align sky
 143     // with sun)
 144     mutable sgVec3 _surface_east;
 145
 146     // world up vector (normal to the plane tangent to the earth's
 147     // surface at the spot we are directly above)
 148     mutable sgVec3 _world_up;
 149
 150     // sg versions of our friendly matrices
 151     mutable sgMat4 TRANS, UP;
 152
 153     //////////////////////////////////////////////////////////////////
 154     // private functions                                            //
 155     //////////////////////////////////////////////////////////////////
 156
 157     void recalcOrientation() const;
 158     void recalcAbsolutePosition() const;
 159 };
 160
 161
 162 #endif // _SG_LOCATION_HXX