src/Main/viewer.hxx

   1 // viewer.hxx -- class for managing a viewer in the flightgear world.
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //                          overhaul started October 2000.
   5 //
   6 // Copyright (C) 1997 - 2000  Curtis L. Olson  - curt@flightgear.org
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 //
  22 // $Id$
  23
  24
  25 #ifndef _VIEWER_HXX
  26 #define _VIEWER_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33 #include <simgear/compiler.h>
  34
  35 #include <plib/sg.h>            // plib include
  36
  37
  38 #define FG_FOV_MIN 0.1
  39 #define FG_FOV_MAX 179.9
  40
  41
  42 // Define a structure containing view information
  43 class FGViewer {
  44
  45 public:
  46
  47     enum fgViewType {
  48         FG_RPH = 0,
  49         FG_LOOKAT = 1,
  50         FG_HPR = 2
  51     };
  52
  53 private:
  54
  55     // flag forcing a recalc of derived view parameters
  56     bool dirty;
  57
  58 protected:
  59
  60     fgViewType _type;
  61
  62     // the field of view in the x (width) direction
  63     double fov;
  64
  65     // ratio of x and y fov's; fov(y) = fov(x) * fov_ratio
  66     double fov_ratio;
  67
  68     // ratio of window width and height; height = width * aspect_ratio
  69     double aspect_ratio;
  70
  71     // the current view offset angle from forward (rotated about the
  72     // view_up vector)
  73     double view_offset;
  74     bool reverse_view_offset;
  75
  76     // the goal view offset angle  (used for smooth view changes)
  77     double goal_view_offset;
  78
  79     // geodetic view position
  80     sgdVec3 geod_view_pos;
  81
  82     // absolute view position in earth coordinates
  83     sgdVec3 abs_view_pos;
  84
  85     // view position in opengl world coordinates (this is the
  86     // abs_view_pos translated to scenery.center)
  87     sgVec3 view_pos;
  88
  89     // radius to sea level from center of the earth (m)
  90     double sea_level_radius;
  91
  92     // cartesion coordinates of current lon/lat if at sea level
  93     // translated to scenery.center
  94     sgVec3 zero_elev;
  95
  96     // height ASL of the terrain for our current view position
  97     // (future?) double ground_elev;
  98
  99     // pilot offset from center of gravity.  The X axis is positive
 100     // out the tail, Y is out the right wing, and Z is positive up.
 101     // Distances in meters of course.
 102     sgVec3 pilot_offset;
 103
 104     // surface vector heading south
 105     sgVec3 surface_south;
 106
 107     // surface vector heading east (used to unambiguously align sky
 108     // with sun)
 109     sgVec3 surface_east;
 110
 111     // world up vector (normal to the plane tangent to the earth's
 112     // surface at the spot we are directly above
 113     sgVec3 world_up;
 114
 115     // sg versions of our friendly matrices
 116     sgMat4 VIEW, VIEW_ROT, UP;
 117
 118     inline void set_dirty() { dirty = true; }
 119     inline void set_clean() { dirty = false; }
 120
 121     // Update the view volume, position, and orientation
 122     virtual void update() = 0;
 123
 124 public:
 125
 126     // Constructor
 127     FGViewer( void );
 128
 129     // Destructor
 130     virtual ~FGViewer( void );
 131
 132     //////////////////////////////////////////////////////////////////////
 133     // setter functions
 134     //////////////////////////////////////////////////////////////////////
 135     inline void set_fov( double amount ) { fov = amount; }
 136     // Don't provide set_fov_ratio explicitely. Use set_aspect_ratio
 137     // instead.
 138     inline void set_aspect_ratio( double r ) {
 139         aspect_ratio = r;
 140         fov_ratio = atan(tan(fov/2 * SG_DEGREES_TO_RADIANS) * aspect_ratio) *
 141             SG_RADIANS_TO_DEGREES / (fov/2);
 142     }
 143     inline void set_view_offset( double a ) {
 144         set_dirty();
 145         view_offset = a;
 146     }
 147     inline void inc_view_offset( double amt ) {
 148         set_dirty();
 149         view_offset += amt;
 150     }
 151     inline void set_goal_view_offset( double a) {
 152         set_dirty();
 153         goal_view_offset = a;
 154         while ( goal_view_offset < 0 ) {
 155             goal_view_offset += 360.0;
 156         }
 157         while ( goal_view_offset > 360.0 ) {
 158             goal_view_offset -= 360.0;
 159         }
 160     }
 161     inline void set_reverse_view_offset( bool val ) {
 162         reverse_view_offset = val;
 163     }
 164     inline void set_geod_view_pos( double lon, double lat, double alt ) {
 165         // data should be in radians and meters asl
 166         set_dirty();
 167         // cout << "set_geod_view_pos = " << lon << ", " << lat << ", " << alt
 168         //      << endl;
 169         sgdSetVec3( geod_view_pos, lon, lat, alt );
 170     }
 171     inline void set_pilot_offset( float x, float y, float z ) {
 172         set_dirty();
 173         sgSetVec3( pilot_offset, x, y, z );
 174     }
 175     inline void set_sea_level_radius( double r ) {
 176         // data should be in meters from the center of the earth
 177         set_dirty();
 178         sea_level_radius = r;
 179     }
 180
 181     //////////////////////////////////////////////////////////////////////
 182     // accessor functions
 183     //////////////////////////////////////////////////////////////////////
 184     inline int get_type() const { return _type ; }
 185     inline int is_a( int t ) const { return get_type() == t ; }
 186     inline bool is_dirty() const { return dirty; }
 187     inline double get_fov() const { return fov; }
 188     inline double get_aspect_ratio() const { return aspect_ratio; }
 189     inline double get_fov_ratio() const { return fov_ratio; }
 190     inline double get_view_offset() const { return view_offset; }
 191     inline bool get_reverse_view_offset() const { return reverse_view_offset; }
 192     inline double get_goal_view_offset() const { return goal_view_offset; }
 193     inline double *get_geod_view_pos() { return geod_view_pos; }
 194     inline float *get_pilot_offset() { return pilot_offset; }
 195     inline double get_sea_level_radius() const { return sea_level_radius; }
 196
 197     //////////////////////////////////////////////////////////////////////
 198     // derived values accessor functions
 199     //////////////////////////////////////////////////////////////////////
 200     inline double *get_abs_view_pos() {
 201         if ( dirty ) { update(); }
 202         return abs_view_pos;
 203     }
 204     inline float *get_view_pos() {
 205         if ( dirty ) { update(); }
 206         return view_pos;
 207     }
 208     inline float *get_zero_elev() {
 209         if ( dirty ) { update(); }
 210         return zero_elev;
 211     }
 212     // (future?)
 213     // inline double get_ground_elev() {
 214     //  if ( dirty ) { update(); }
 215     //  return ground_elev;
 216     // }
 217     inline float *get_surface_south() {
 218         if ( dirty ) { update(); }
 219         return surface_south;
 220     }
 221     inline float *get_surface_east() {
 222         if ( dirty ) { update(); }
 223         return surface_east;
 224     }
 225     inline float *get_world_up() {
 226         if ( dirty ) { update(); }
 227         return world_up;
 228     }
 229     inline const sgVec4 *get_VIEW() {
 230         if ( dirty ) { update(); }
 231         return VIEW;
 232     }
 233     inline const sgVec4 *get_VIEW_ROT() {
 234         if ( dirty ) { update(); }
 235         return VIEW_ROT;
 236     }
 237     inline const sgVec4 *get_UP() {
 238         if ( dirty ) { update(); }
 239         return UP;
 240     }
 241 };
 242
 243
 244 #endif // _VIEWER_HXX
 245
 246