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 a structure containing view information
  39 class FGViewer {
  40
  41 public:
  42
  43     enum fgViewType {
  44         FG_RPH = 0,
  45         FG_LOOKAT = 1,
  46         FG_HPR = 2
  47     };
  48
  49 private:
  50
  51     // flag forcing a recalc of derived view parameters
  52     bool dirty;
  53
  54 protected:
  55
  56     fgViewType _type;
  57
  58     // the current view offset angle from forward (rotated about the
  59     // view_up vector)
  60     double view_offset;
  61
  62     // the goal view offset angle  (used for smooth view changes)
  63     double goal_view_offset;
  64
  65     // geodetic view position
  66     sgdVec3 geod_view_pos;
  67
  68     // absolute view position in earth coordinates
  69     sgdVec3 abs_view_pos;
  70
  71     // view position in opengl world coordinates (this is the
  72     // abs_view_pos translated to scenery.center)
  73     sgVec3 view_pos;
  74
  75     // radius to sea level from center of the earth (m)
  76     double sea_level_radius;
  77
  78     // cartesion coordinates of current lon/lat if at sea level
  79     // translated to scenery.center
  80     sgVec3 zero_elev;
  81
  82     // pilot offset from center of gravity.  The X axis is positive
  83     // out the tail, Y is out the right wing, and Z is positive up.
  84     // Distances in meters of course.
  85     sgVec3 pilot_offset;
  86
  87     // vector in cartesian coordinates from current position to the
  88     // postion on the earth's surface the sun is directly over
  89     sgVec3 to_sun;
  90
  91     // surface direction to go to head towards sun
  92     sgVec3 surface_to_sun;
  93
  94     // vector in cartesian coordinates from current position to the
  95     // postion on the earth's surface the moon is directly over
  96     sgVec3 to_moon;
  97
  98     // surface direction to go to head towards moon
  99     sgVec3 surface_to_moon;
 100
 101     // surface vector heading south
 102     sgVec3 surface_south;
 103
 104     // surface vector heading east (used to unambiguously align sky
 105     // with sun)
 106     sgVec3 surface_east;
 107
 108     // world up vector (normal to the plane tangent to the earth's
 109     // surface at the spot we are directly above
 110     sgVec3 world_up;
 111
 112     // sg versions of our friendly matrices
 113     sgMat4 VIEW, VIEW_ROT, UP;
 114
 115     inline void set_dirty() { dirty = true; }
 116     inline void set_clean() { dirty = false; }
 117
 118     // Update the view volume, position, and orientation
 119     virtual void update();
 120
 121 public:
 122
 123     // Constructor
 124     FGViewer( void );
 125
 126     // Destructor
 127     virtual ~FGViewer( void );
 128
 129     //////////////////////////////////////////////////////////////////////
 130     // setter functions
 131     //////////////////////////////////////////////////////////////////////
 132     inline void set_view_offset( double a ) {
 133         set_dirty();
 134         view_offset = a;
 135     }
 136     inline void inc_view_offset( double amt ) {
 137         set_dirty();
 138         view_offset += amt;
 139     }
 140     inline void set_goal_view_offset( double a) {
 141         set_dirty();
 142         goal_view_offset = a;
 143     }
 144     inline void set_geod_view_pos( double lon, double lat, double alt ) {
 145         // data should be in radians and meters asl
 146         set_dirty();
 147         // cout << "set_geod_view_pos = " << lon << ", " << lat << ", " << alt
 148         //      << endl;
 149         sgdSetVec3( geod_view_pos, lon, lat, alt );
 150     }
 151     inline void set_pilot_offset( float x, float y, float z ) {
 152         set_dirty();
 153         sgSetVec3( pilot_offset, x, y, z );
 154     }
 155     inline void set_sea_level_radius( double r ) {
 156         // data should be in meters from the center of the earth
 157         set_dirty();
 158         sea_level_radius = r;
 159     }
 160
 161     //////////////////////////////////////////////////////////////////////
 162     // accessor functions
 163     //////////////////////////////////////////////////////////////////////
 164     inline int get_type() const { return _type ; }
 165     inline int is_a( int t ) const { return get_type() == t ; }
 166     inline bool is_dirty() const { return dirty; }
 167     inline double get_view_offset() const { return view_offset; }
 168     inline double get_goal_view_offset() const { return goal_view_offset; }
 169     inline double *get_geod_view_pos() { return geod_view_pos; }
 170     inline float *get_pilot_offset() { return pilot_offset; }
 171     inline double get_sea_level_radius() const { return sea_level_radius; }
 172
 173     //////////////////////////////////////////////////////////////////////
 174     // derived values accessor functions
 175     //////////////////////////////////////////////////////////////////////
 176     inline double *get_abs_view_pos() {
 177         if ( dirty ) { update(); }
 178         return abs_view_pos;
 179     }
 180     inline float *get_view_pos() {
 181         if ( dirty ) { update(); }
 182         return view_pos;
 183     }
 184     inline float *get_zero_elev() {
 185         if ( dirty ) { update(); }
 186         return zero_elev;
 187     }
 188     inline float *get_surface_south() {
 189         if ( dirty ) { update(); }
 190         return surface_south;
 191     }
 192     inline float *get_surface_east() {
 193         if ( dirty ) { update(); }
 194         return surface_east;
 195     }
 196     inline float *get_world_up() {
 197         if ( dirty ) { update(); }
 198         return world_up;
 199     }
 200     inline const sgVec4 *get_VIEW() {
 201         if ( dirty ) { update(); }
 202         return VIEW;
 203     }
 204     inline const sgVec4 *get_VIEW_ROT() {
 205         if ( dirty ) { update(); }
 206         return VIEW_ROT;
 207     }
 208     inline const sgVec4 *get_UP() {
 209         if ( dirty ) { update(); }
 210         return UP;
 211     }
 212
 213     //////////////////////////////////////////////////////////////////////
 214     // need to fix these
 215     //////////////////////////////////////////////////////////////////////
 216     inline float *get_to_sun() { return to_sun; }
 217     inline void set_to_sun( float x, float y, float z ) {
 218         sgSetVec3( to_sun, x, y, z );
 219     }
 220     inline float *get_surface_to_sun() { return surface_to_sun; }
 221     inline void set_surface_to_sun( float x, float y, float z) {
 222         sgSetVec3( surface_to_sun, x, y, z );
 223     }
 224     inline float *get_to_moon() { return to_moon; }
 225     inline void set_to_moon( float x, float y, float z) {
 226         sgSetVec3( to_moon, x, y, z );
 227     }
 228     inline float *get_surface_to_moon() { return surface_to_moon; }
 229     inline void set_surface_to_moon( float x, float y, float z) {
 230         sgSetVec3( surface_to_moon, x, y, z );
 231     }
 232 };
 233
 234
 235 #endif // _VIEWER_HXX
 236
 237