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) * win_ratio
  66     double win_ratio;
  67
  68     // the current view offset angle from forward (rotated about the
  69     // view_up vector)
  70     double view_offset;
  71
  72     // the goal view offset angle  (used for smooth view changes)
  73     double goal_view_offset;
  74
  75     // geodetic view position
  76     sgdVec3 geod_view_pos;
  77
  78     // absolute view position in earth coordinates
  79     sgdVec3 abs_view_pos;
  80
  81     // view position in opengl world coordinates (this is the
  82     // abs_view_pos translated to scenery.center)
  83     sgVec3 view_pos;
  84
  85     // radius to sea level from center of the earth (m)
  86     double sea_level_radius;
  87
  88     // cartesion coordinates of current lon/lat if at sea level
  89     // translated to scenery.center
  90     sgVec3 zero_elev;
  91
  92     // height ASL of the terrain for our current view position
  93     // (future?) double ground_elev;
  94
  95     // pilot offset from center of gravity.  The X axis is positive
  96     // out the tail, Y is out the right wing, and Z is positive up.
  97     // Distances in meters of course.
  98     sgVec3 pilot_offset;
  99
 100     // surface vector heading south
 101     sgVec3 surface_south;
 102
 103     // surface vector heading east (used to unambiguously align sky
 104     // with sun)
 105     sgVec3 surface_east;
 106
 107     // world up vector (normal to the plane tangent to the earth's
 108     // surface at the spot we are directly above
 109     sgVec3 world_up;
 110
 111     // sg versions of our friendly matrices
 112     sgMat4 VIEW, VIEW_ROT, UP;
 113
 114     inline void set_dirty() { dirty = true; }
 115     inline void set_clean() { dirty = false; }
 116
 117     // Update the view volume, position, and orientation
 118     virtual void update();
 119
 120 public:
 121
 122     // Constructor
 123     FGViewer( void );
 124
 125     // Destructor
 126     virtual ~FGViewer( void );
 127
 128     //////////////////////////////////////////////////////////////////////
 129     // setter functions
 130     //////////////////////////////////////////////////////////////////////
 131     inline void set_fov( double amount ) { fov = amount; }
 132     inline void set_win_ratio( double r ) { win_ratio = r; }
 133     inline void set_view_offset( double a ) {
 134         set_dirty();
 135         view_offset = a;
 136     }
 137     inline void inc_view_offset( double amt ) {
 138         set_dirty();
 139         view_offset += amt;
 140     }
 141     inline void set_goal_view_offset( double a) {
 142         set_dirty();
 143         goal_view_offset = a;
 144     }
 145     inline void set_geod_view_pos( double lon, double lat, double alt ) {
 146         // data should be in radians and meters asl
 147         set_dirty();
 148         // cout << "set_geod_view_pos = " << lon << ", " << lat << ", " << alt
 149         //      << endl;
 150         sgdSetVec3( geod_view_pos, lon, lat, alt );
 151     }
 152     inline void set_pilot_offset( float x, float y, float z ) {
 153         set_dirty();
 154         sgSetVec3( pilot_offset, x, y, z );
 155     }
 156     inline void set_sea_level_radius( double r ) {
 157         // data should be in meters from the center of the earth
 158         set_dirty();
 159         sea_level_radius = r;
 160     }
 161
 162     //////////////////////////////////////////////////////////////////////
 163     // accessor functions
 164     //////////////////////////////////////////////////////////////////////
 165     inline int get_type() const { return _type ; }
 166     inline int is_a( int t ) const { return get_type() == t ; }
 167     inline bool is_dirty() const { return dirty; }
 168     inline double get_fov() const { return fov; }
 169     inline double get_win_ratio() const { return win_ratio; }
 170     inline double get_view_offset() const { return view_offset; }
 171     inline double get_goal_view_offset() const { return goal_view_offset; }
 172     inline double *get_geod_view_pos() { return geod_view_pos; }
 173     inline float *get_pilot_offset() { return pilot_offset; }
 174     inline double get_sea_level_radius() const { return sea_level_radius; }
 175
 176     //////////////////////////////////////////////////////////////////////
 177     // derived values accessor functions
 178     //////////////////////////////////////////////////////////////////////
 179     inline double *get_abs_view_pos() {
 180         if ( dirty ) { update(); }
 181         return abs_view_pos;
 182     }
 183     inline float *get_view_pos() {
 184         if ( dirty ) { update(); }
 185         return view_pos;
 186     }
 187     inline float *get_zero_elev() {
 188         if ( dirty ) { update(); }
 189         return zero_elev;
 190     }
 191     // (future?)
 192     // inline double get_ground_elev() {
 193     //  if ( dirty ) { update(); }
 194     //  return ground_elev;
 195     // }
 196     inline float *get_surface_south() {
 197         if ( dirty ) { update(); }
 198         return surface_south;
 199     }
 200     inline float *get_surface_east() {
 201         if ( dirty ) { update(); }
 202         return surface_east;
 203     }
 204     inline float *get_world_up() {
 205         if ( dirty ) { update(); }
 206         return world_up;
 207     }
 208     inline const sgVec4 *get_VIEW() {
 209         if ( dirty ) { update(); }
 210         return VIEW;
 211     }
 212     inline const sgVec4 *get_VIEW_ROT() {
 213         if ( dirty ) { update(); }
 214         return VIEW_ROT;
 215     }
 216     inline const sgVec4 *get_UP() {
 217         if ( dirty ) { update(); }
 218         return UP;
 219     }
 220 };
 221
 222
 223 #endif // _VIEWER_HXX
 224
 225