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 //   partially rewritten by Jim Wilson jim@kelcomaine.com using interface
   6 //                          by David Megginson March 2002
   7 //
   8 // Copyright (C) 1997 - 2000  Curtis L. Olson  - curt@flightgear.org
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 //
  24 // $Id$
  25
  26
  27 #ifndef _VIEWER_HXX
  28 #define _VIEWER_HXX
  29
  30
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35 #include <simgear/compiler.h>
  36 #include <simgear/constants.h>
  37
  38 #include <plib/sg.h>            // plib include
  39
  40 #include "fgfs.hxx"
  41
  42
  43 #define FG_FOV_MIN 0.1
  44 #define FG_FOV_MAX 179.9
  45
  46
  47 // Define a structure containing view information
  48 class FGViewer : public FGSubsystem {
  49
  50 public:
  51
  52     enum fgViewType {
  53         FG_RPH = 0,
  54         FG_LOOKAT = 1,
  55         FG_HPR = 2
  56     };
  57
  58     enum fgScalingType {  // nominal Field Of View actually applies to ...
  59         FG_SCALING_WIDTH,       // window width
  60         FG_SCALING_MAX,         // max(width, height)
  61         // FG_SCALING_G_MEAN,      // geometric_mean(width, height)
  62         // FG_SCALING_INDEPENDENT  // whole screen
  63     };
  64
  65     // Constructor
  66     FGViewer( void );
  67
  68     // Destructor
  69     virtual ~FGViewer( void );
  70
  71     //////////////////////////////////////////////////////////////////////
  72     // Part 1: standard FGSubsystem implementation.
  73     //////////////////////////////////////////////////////////////////////
  74
  75     virtual void init ();
  76     virtual void bind ();
  77     virtual void unbind ();
  78     void update (int dt);
  79
  80
  81     //////////////////////////////////////////////////////////////////////
  82     // Part 2: user settings.
  83     //////////////////////////////////////////////////////////////////////
  84
  85     virtual fgViewType getType() const { return _type; }
  86     virtual void setType( int type );
  87
  88     // Reference geodetic position of view from position...
  89     //   These are the actual aircraft position (pilot in
  90     //   pilot view, model in model view).
  91     //   FIXME: the model view position (ie target positions)
  92     //   should be in the model class.
  93     virtual double getLongitude_deg () const { return _lon_deg; }
  94     virtual double getLatitude_deg () const { return _lat_deg; }
  95     virtual double getAltitudeASL_ft () const { return _alt_ft; }
  96     virtual void setLongitude_deg (double lon_deg);
  97     virtual void setLatitude_deg (double lat_deg);
  98     virtual void setAltitude_ft (double alt_ft);
  99     virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
 100
 101     // Reference geodetic target position...
 102     virtual double getTargetLongitude_deg () const { return _target_lon_deg; }
 103     virtual double getTargetLatitude_deg () const { return _target_lat_deg; }
 104     virtual double getTargetAltitudeASL_ft () const { return _target_alt_ft; }
 105     virtual void setTargetLongitude_deg (double lon_deg);
 106     virtual void setTargetLatitude_deg (double lat_deg);
 107     virtual void setTargetAltitude_ft (double alt_ft);
 108     virtual void setTargetPosition (double lon_deg, double lat_deg, double alt_ft);
 109
 110
 111
 112
 113     // Position offsets from reference
 114     //   These offsets position they "eye" in the scene according to a given
 115     //   location.  For example in pilot view they are used to position the
 116     //   head inside the aircraft.
 117     //   Note that in pilot view these are applied "before" the orientation
 118     //   rotations (see below) so that the orientation rotations have the
 119     //   effect of the pilot staying in his seat and "looking out" in
 120     //   different directions.
 121     //   In chase view these are applied "after" the application of the
 122     //   orientation rotations listed below.  This has the effect of the
 123     //   eye moving around and "looking at" the object (model) from
 124     //   different angles.
 125     virtual double getXOffset_m () const { return _x_offset_m; }
 126     virtual double getYOffset_m () const { return _y_offset_m; }
 127     virtual double getZOffset_m () const { return _z_offset_m; }
 128     virtual void setXOffset_m (double x_offset_m);
 129     virtual void setYOffset_m (double y_offset_m);
 130     virtual void setZOffset_m (double z_offset_m);
 131     virtual void setPositionOffsets (double x_offset_m,
 132                                      double y_offset_m,
 133                                      double z_offset_m);
 134
 135
 136
 137
 138     // Reference orientation rotations...
 139     //   These are rotations that represent the plane attitude effect on
 140     //   the view (in Pilot view).  IE The view frustrum rotates as the plane
 141     //   turns, pitches, and rolls.
 142     //   In model view (lookat/chaseview) these end up changing the angle that
 143     //   the eye is looking at the ojbect (ie the model).
 144     //   FIXME: the FGModel class should have its own version of these so that
 145     //   it can generate it's own model rotations.
 146     virtual double getRoll_deg () const { return _roll_deg; }
 147     virtual double getPitch_deg () const {return _pitch_deg; }
 148     virtual double getHeading_deg () const {return _heading_deg; }
 149     virtual void setRoll_deg (double roll_deg);
 150     virtual void setPitch_deg (double pitch_deg);
 151     virtual void setHeading_deg (double heading_deg);
 152     virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
 153
 154
 155
 156
 157     // Orientation offsets rotations from reference orientation.
 158     // Goal settings are for smooth transition from prior
 159     // offset when changing view direction.
 160     //   These offsets are in ADDITION to the orientation rotations listed
 161     //   above.
 162     //   In pilot view they are applied after the position offsets in order to
 163     //   give the effect of the pilot looking around.
 164     //   In lookat view they are applied before the position offsets so that
 165     //   the effect is the eye moving around looking at the object (ie the model)
 166     //   from different angles.
 167     virtual double getRollOffset_deg () const { return _roll_offset_deg; }
 168     virtual double getPitchOffset_deg () const { return _pitch_offset_deg; }
 169     virtual double getHeadingOffset_deg () const { return _heading_offset_deg; }
 170     virtual double getGoalRollOffset_deg () const { return _goal_roll_offset_deg; }
 171     virtual double getGoalPitchOffset_deg () const { return _goal_pitch_offset_deg; }
 172     virtual double getGoalHeadingOffset_deg () const {return _goal_heading_offset_deg; }
 173     virtual void setRollOffset_deg (double roll_offset_deg);
 174     virtual void setPitchOffset_deg (double pitch_offset_deg);
 175     virtual void setHeadingOffset_deg (double heading_offset_deg);
 176     virtual void setGoalRollOffset_deg (double goal_roll_offset_deg);
 177     virtual void setGoalPitchOffset_deg (double goal_pitch_offset_deg);
 178     virtual void setGoalHeadingOffset_deg (double goal_heading_offset_deg);
 179     virtual void setOrientationOffsets (double roll_offset_deg,
 180                                      double heading_offset_deg,
 181                                      double pitch_offset_deg);
 182
 183
 184
 185     //////////////////////////////////////////////////////////////////////
 186     // Part 3: output vectors and matrices in FlightGear coordinates.
 187     //////////////////////////////////////////////////////////////////////
 188
 189     // Vectors and positions...
 190
 191     // Get zero view_pos
 192     virtual float * get_view_pos() {if ( _dirty ) { recalc(); } return _view_pos; }
 193     // Get the absolute view position in fgfs coordinates.
 194     virtual double * get_absolute_view_pos ();
 195     // Get zero elev
 196     virtual float * get_zero_elev() {if ( _dirty ) { recalc(); } return _zero_elev; }
 197     // Get world up vector
 198     virtual float *get_world_up() {if ( _dirty ) { recalc(); } return _world_up; }
 199     // Get the relative (to scenery center) view position in fgfs coordinates.
 200     virtual float * getRelativeViewPos ();
 201     // Get the absolute zero-elevation view position in fgfs coordinates.
 202     virtual float * getZeroElevViewPos ();
 203     // Get surface east vector
 204     virtual float *get_surface_east() { if ( _dirty ) { recalc(); } return _surface_east; }
 205     // Get surface south vector
 206     virtual float *get_surface_south() {if ( _dirty ) { recalc(); } return _surface_south; }
 207
 208     // Matrices...
 209     virtual const sgVec4 *get_VIEW() { if ( _dirty ) { recalc(); } return VIEW; }
 210     virtual const sgVec4 *get_VIEW_ROT() { if ( _dirty ) { recalc(); }  return VIEW_ROT; }
 211     virtual const sgVec4 *get_LOCAL_ROT() { if ( _dirty ) { recalc(); } return LOCAL_ROT; }
 212     virtual const sgVec4 *get_UP() { if ( _dirty ) { recalc(); } return UP; }
 213
 214     //////////////////////////////////////////////////////////////////////
 215     // Part 4: frustrum data setters and getters
 216     //////////////////////////////////////////////////////////////////////
 217
 218     virtual void set_fov( double fov_deg ) {
 219         _fov_deg = fov_deg;
 220     }
 221     virtual double get_fov() const { return _fov_deg; }
 222     virtual double get_h_fov();    // Get horizontal fov, in degrees.
 223     virtual double get_v_fov();    // Get vertical fov, in degrees.
 224
 225     virtual void set_aspect_ratio( double r ) {
 226         _aspect_ratio = r;
 227     }
 228     virtual double get_aspect_ratio() const { return _aspect_ratio; }
 229
 230 private:
 231
 232     //////////////////////////////////////////////////////////////////
 233     // private data                                                 //
 234     //////////////////////////////////////////////////////////////////
 235
 236     // flag forcing a recalc of derived view parameters
 237     bool _dirty;
 238
 239     mutable sgdVec3 _absolute_view_pos;
 240     mutable sgVec3 _relative_view_pos;
 241     mutable sgVec3 _zero_elev_view_pos;
 242
 243     double _lon_deg;
 244     double _lat_deg;
 245     double _alt_ft;
 246     double _target_lon_deg;
 247     double _target_lat_deg;
 248     double _target_alt_ft;
 249
 250     double _roll_deg;
 251     double _pitch_deg;
 252     double _heading_deg;
 253
 254     // Position offsets from center of gravity.  The X axis is positive
 255     // out the tail, Y is out the right wing, and Z is positive up.
 256     // distance in meters
 257     double _x_offset_m;
 258     double _y_offset_m;
 259     double _z_offset_m;
 260
 261     // orientation offsets from reference (_goal* are for smoothed transitions)
 262     double _roll_offset_deg;
 263     double _pitch_offset_deg;
 264     double _heading_offset_deg;
 265     double _goal_roll_offset_deg;
 266     double _goal_pitch_offset_deg;
 267     double _goal_heading_offset_deg;
 268
 269     fgViewType _type;
 270     fgScalingType _scaling_type;
 271
 272     // the nominal field of view (angle, in degrees)
 273     double _fov_deg;
 274
 275     // ratio of window width and height; height = width * aspect_ratio
 276     double _aspect_ratio;
 277
 278     bool _reverse_view_offset;
 279
 280     // view position in opengl world coordinates (this is the
 281     // abs_view_pos translated to scenery.center)
 282     sgVec3 _view_pos;
 283
 284     // cartesion coordinates of current lon/lat if at sea level
 285     // translated to scenery.center
 286     sgVec3 _zero_elev;
 287
 288     // surface vector heading south
 289     sgVec3 _surface_south;
 290
 291     // surface vector heading east (used to unambiguously align sky
 292     // with sun)
 293     sgVec3 _surface_east;
 294
 295     // world up vector (normal to the plane tangent to the earth's
 296     // surface at the spot we are directly above
 297     sgVec3 _world_up;
 298
 299     // up vector for the view (usually point straight up through the
 300     // top of the aircraft
 301     sgVec3 _view_up;
 302
 303 //    // the vector pointing straight out the nose of the aircraft
 304 //    sgVec3 _view_forward;
 305
 306     // sg versions of our friendly matrices
 307     sgMat4 VIEW, VIEW_ROT, UP, LOCAL_ROT;
 308     sgMat4 LOCAL, TRANS, LARC_TO_SSG;
 309
 310     // Transformation matrix for the view direction offset relative to
 311     // the AIRCRAFT matrix
 312     sgMat4 VIEW_OFFSET;
 313
 314     //////////////////////////////////////////////////////////////////
 315     // private functions                                            //
 316     //////////////////////////////////////////////////////////////////
 317
 318     void recalc ();
 319     void recalcPositionVectors (double lon_deg, double lat_deg, double alt_ft) const;
 320
 321     inline void set_dirty() { _dirty = true; }
 322     inline void set_clean() { _dirty = false; }
 323
 324     // add to _heading_offset_deg
 325     inline void incHeadingOffset_deg( double amt ) {
 326         set_dirty();
 327         _heading_offset_deg += amt;
 328     }
 329
 330     // add to _pitch_offset_deg
 331     inline void incPitchOffset_deg( double amt ) {
 332         set_dirty();
 333         _pitch_offset_deg += amt;
 334     }
 335
 336     inline void set_reverse_view_offset( bool val ) {
 337         _reverse_view_offset = val;
 338     }
 339
 340 };
 341
 342
 343 #endif // _VIEWER_HXX
 344
 345
 346
 347
 348
 349
 350
 351
 352