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  - http://www.flightgear.org/~curt
   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 #include <simgear/structure/subsystem_mgr.hxx>
  38 #include <simgear/scene/model/location.hxx>
  39
  40 #include <plib/sg.h>            // plib include
  41
  42 #define FG_FOV_MIN 0.1
  43 #define FG_FOV_MAX 179.9
  44
  45 enum fgViewType {
  46  FG_LOOKFROM = 0,
  47  FG_LOOKAT = 1
  48 };
  49
  50 // Define a structure containing view information
  51 class FGViewer : public SGSubsystem {
  52
  53 public:
  54
  55     enum fgScalingType {  // nominal Field Of View actually applies to ...
  56         FG_SCALING_WIDTH,       // window width
  57         FG_SCALING_MAX          // max(width, height)
  58         // FG_SCALING_G_MEAN,      // geometric_mean(width, height)
  59         // FG_SCALING_INDEPENDENT  // whole screen
  60     };
  61
  62     // Constructor
  63     FGViewer( fgViewType Type, bool from_model, int from_model_index,
  64               bool at_model, int at_model_index,
  65               double damp_roll, double damp_pitch, double damp_heading,
  66               double x_offset_m, double y_offset_m, double z_offset_m,
  67               double heading_offset_deg, double pitch_offset_deg,
  68               double roll_offset_deg, double fov_deg,
  69               double target_x_offset_m, double target_y_offset_m,
  70               double target_z_offset_m, double near_m, bool internal );
  71
  72     // Destructor
  73     virtual ~FGViewer( void );
  74
  75     //////////////////////////////////////////////////////////////////////
  76     // Part 1: standard SGSubsystem implementation.
  77     //////////////////////////////////////////////////////////////////////
  78
  79     virtual void init ();
  80     virtual void bind ();
  81     virtual void unbind ();
  82     void update (double dt);
  83
  84
  85     //////////////////////////////////////////////////////////////////////
  86     // Part 2: user settings.
  87     //////////////////////////////////////////////////////////////////////
  88
  89     virtual fgViewType getType() const { return _type; }
  90     virtual void setType( int type );
  91
  92     virtual bool getInternal() const { return _internal; }
  93     virtual void setInternal( bool internal );
  94
  95     // Reference geodetic position of view from position...
  96     //   These are the actual aircraft position (pilot in
  97     //   pilot view, model in model view).
  98     //   FIXME: the model view position (ie target positions)
  99     //   should be in the model class.
 100     virtual double getLongitude_deg () const { return _lon_deg; }
 101     virtual double getLatitude_deg () const { return _lat_deg; }
 102     virtual double getAltitudeASL_ft () const { return _alt_ft; }
 103     virtual void setLongitude_deg (double lon_deg);
 104     virtual void setLatitude_deg (double lat_deg);
 105     virtual void setAltitude_ft (double alt_ft);
 106     virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
 107
 108     // Reference geodetic target position...
 109     virtual double getTargetLongitude_deg () const { return _target_lon_deg; }
 110     virtual double getTargetLatitude_deg () const { return _target_lat_deg; }
 111     virtual double getTargetAltitudeASL_ft () const { return _target_alt_ft; }
 112     virtual void setTargetLongitude_deg (double lon_deg);
 113     virtual void setTargetLatitude_deg (double lat_deg);
 114     virtual void setTargetAltitude_ft (double alt_ft);
 115     virtual void setTargetPosition (double lon_deg, double lat_deg, double alt_ft);
 116
 117
 118
 119
 120     // Position offsets from reference
 121     //   These offsets position they "eye" in the scene according to a given
 122     //   location.  For example in pilot view they are used to position the
 123     //   head inside the aircraft.
 124     //   Note that in pilot view these are applied "before" the orientation
 125     //   rotations (see below) so that the orientation rotations have the
 126     //   effect of the pilot staying in his seat and "looking out" in
 127     //   different directions.
 128     //   In chase view these are applied "after" the application of the
 129     //   orientation rotations listed below.  This has the effect of the
 130     //   eye moving around and "looking at" the object (model) from
 131     //   different angles.
 132     virtual double getXOffset_m () const { return _x_offset_m; }
 133     virtual double getYOffset_m () const { return _y_offset_m; }
 134     virtual double getZOffset_m () const { return _z_offset_m; }
 135     virtual double getTargetXOffset_m () const { return _target_x_offset_m; }
 136     virtual double getTargetYOffset_m () const { return _target_y_offset_m; }
 137     virtual double getTargetZOffset_m () const { return _target_z_offset_m; }
 138     virtual void setXOffset_m (double x_offset_m);
 139     virtual void setYOffset_m (double y_offset_m);
 140     virtual void setZOffset_m (double z_offset_m);
 141     virtual void setTargetXOffset_m (double x_offset_m);
 142     virtual void setTargetYOffset_m (double y_offset_m);
 143     virtual void setTargetZOffset_m (double z_offset_m);
 144     virtual void setPositionOffsets (double x_offset_m,
 145                                      double y_offset_m,
 146                                      double z_offset_m);
 147
 148
 149
 150
 151     // Reference orientation rotations...
 152     //   These are rotations that represent the plane attitude effect on
 153     //   the view (in Pilot view).  IE The view frustrum rotates as the plane
 154     //   turns, pitches, and rolls.
 155     //   In model view (lookat/chaseview) these end up changing the angle that
 156     //   the eye is looking at the ojbect (ie the model).
 157     //   FIXME: the FGModel class should have its own version of these so that
 158     //   it can generate it's own model rotations.
 159     virtual double getRoll_deg () const { return _roll_deg; }
 160     virtual double getPitch_deg () const {return _pitch_deg; }
 161     virtual double getHeading_deg () const {return _heading_deg; }
 162     virtual void setRoll_deg (double roll_deg);
 163     virtual void setPitch_deg (double pitch_deg);
 164     virtual void setHeading_deg (double heading_deg);
 165     virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
 166     virtual double getTargetRoll_deg () const { return _target_roll_deg; }
 167     virtual double getTargetPitch_deg () const {return _target_pitch_deg; }
 168     virtual double getTargetHeading_deg () const {return _target_heading_deg; }
 169     virtual void setTargetRoll_deg (double roll_deg);
 170     virtual void setTargetPitch_deg (double pitch_deg);
 171     virtual void setTargetHeading_deg (double heading_deg);
 172     virtual void setTargetOrientation (double roll_deg, double pitch_deg, double heading_deg);
 173
 174
 175
 176
 177     // Orientation offsets rotations from reference orientation.
 178     // Goal settings are for smooth transition from prior
 179     // offset when changing view direction.
 180     //   These offsets are in ADDITION to the orientation rotations listed
 181     //   above.
 182     //   In pilot view they are applied after the position offsets in order to
 183     //   give the effect of the pilot looking around.
 184     //   In lookat view they are applied before the position offsets so that
 185     //   the effect is the eye moving around looking at the object (ie the model)
 186     //   from different angles.
 187     virtual double getRollOffset_deg () const { return _roll_offset_deg; }
 188     virtual double getPitchOffset_deg () const { return _pitch_offset_deg; }
 189     virtual double getHeadingOffset_deg () const { return _heading_offset_deg; }
 190     virtual double getGoalRollOffset_deg () const { return _goal_roll_offset_deg; }
 191     virtual double getGoalPitchOffset_deg () const { return _goal_pitch_offset_deg; }
 192     virtual double getGoalHeadingOffset_deg () const {return _goal_heading_offset_deg; }
 193     virtual void setRollOffset_deg (double roll_offset_deg);
 194     virtual void setPitchOffset_deg (double pitch_offset_deg);
 195     virtual void setHeadingOffset_deg (double heading_offset_deg);
 196     virtual void setGoalRollOffset_deg (double goal_roll_offset_deg);
 197     virtual void setGoalPitchOffset_deg (double goal_pitch_offset_deg);
 198     virtual void setGoalHeadingOffset_deg (double goal_heading_offset_deg);
 199     virtual void setOrientationOffsets (double roll_offset_deg,
 200                                      double heading_offset_deg,
 201                                      double pitch_offset_deg);
 202
 203
 204
 205     //////////////////////////////////////////////////////////////////////
 206     // Part 3: output vectors and matrices in FlightGear coordinates.
 207     //////////////////////////////////////////////////////////////////////
 208
 209     // Vectors and positions...
 210
 211     // Get zero view_pos
 212     virtual float * get_view_pos() {if ( _dirty ) { recalc(); } return _view_pos; }
 213     // Get the absolute view position in fgfs coordinates.
 214     virtual double * get_absolute_view_pos ();
 215     // Get zero elev
 216     virtual float * get_zero_elev() {if ( _dirty ) { recalc(); } return _zero_elev; }
 217     // Get world up vector
 218     virtual float *get_world_up() {if ( _dirty ) { recalc(); } return _world_up; }
 219     // Get the relative (to scenery center) view position in fgfs coordinates.
 220     virtual float * getRelativeViewPos ();
 221     // Get the absolute zero-elevation view position in fgfs coordinates.
 222     virtual float * getZeroElevViewPos ();
 223     // Get surface east vector
 224     virtual float *get_surface_east() { if ( _dirty ) { recalc(); } return _surface_east; }
 225     // Get surface south vector
 226     virtual float *get_surface_south() {if ( _dirty ) { recalc(); } return _surface_south; }
 227
 228     // Matrices...
 229     virtual const sgVec4 *get_VIEW() { if ( _dirty ) { recalc(); } return VIEW; }
 230     virtual const sgVec4 *get_UP() { if ( _dirty ) { recalc(); } return UP; }
 231
 232     //////////////////////////////////////////////////////////////////////
 233     // Part 4: View and frustrum data setters and getters
 234     //////////////////////////////////////////////////////////////////////
 235
 236     virtual void set_fov( double fov_deg ) {
 237         _fov_deg = fov_deg;
 238     }
 239     virtual double get_fov() const { return _fov_deg; }
 240     virtual double get_h_fov();    // Get horizontal fov, in degrees.
 241     virtual double get_v_fov();    // Get vertical fov, in degrees.
 242
 243     virtual void set_aspect_ratio( double r ) {
 244         _aspect_ratio = r;
 245     }
 246     virtual double get_aspect_ratio() const { return _aspect_ratio; }
 247
 248     virtual double getNear_m () const { return _ground_level_nearplane_m; }
 249     inline void setNear_m (double near_m) {
 250         _ground_level_nearplane_m = near_m;
 251     }
 252
 253     //////////////////////////////////////////////////////////////////////
 254     // Part 5: misc setters and getters
 255     //////////////////////////////////////////////////////////////////////
 256
 257     inline void set_dirty() { _dirty = true; }
 258     inline void set_clean() { _dirty = false; }
 259
 260     // return eye location...
 261     virtual SGLocation * getSGLocation () const { return _location; }
 262
 263
 264 private:
 265
 266     //////////////////////////////////////////////////////////////////
 267     // private data                                                 //
 268     //////////////////////////////////////////////////////////////////
 269
 270     // flag forcing a recalc of derived view parameters
 271     bool _dirty;
 272
 273     mutable sgdVec3 _absolute_view_pos;
 274     mutable sgVec3 _relative_view_pos;
 275     mutable sgVec3 _zero_elev_view_pos;
 276
 277     double _lon_deg;
 278     double _lat_deg;
 279     double _alt_ft;
 280     double _target_lon_deg;
 281     double _target_lat_deg;
 282     double _target_alt_ft;
 283
 284     double _roll_deg;
 285     double _pitch_deg;
 286     double _heading_deg;
 287     double _target_roll_deg;
 288     double _target_pitch_deg;
 289     double _target_heading_deg;
 290
 291     double _damp_sync;
 292     double _damp_roll;
 293     double _damp_pitch;
 294     double _damp_heading;
 295
 296     double _damped_roll_deg;
 297     double _damped_pitch_deg;
 298     double _damped_heading_deg;
 299
 300     // Position offsets from FDM origin.  The X axis is positive
 301     // out the tail, Y is out the right wing, and Z is positive up.
 302     // distance in meters
 303     double _x_offset_m;
 304     double _y_offset_m;
 305     double _z_offset_m;
 306
 307     // Target offsets from FDM origin (for "lookat" targets) The X
 308     // axis is positive out the tail, Y is out the right wing, and Z
 309     // is positive up.  distance in meters
 310     double _target_x_offset_m;
 311     double _target_y_offset_m;
 312     double _target_z_offset_m;
 313
 314
 315     // orientation offsets from reference (_goal* are for smoothed transitions)
 316     double _roll_offset_deg;
 317     double _pitch_offset_deg;
 318     double _heading_offset_deg;
 319     double _goal_roll_offset_deg;
 320     double _goal_pitch_offset_deg;
 321     double _goal_heading_offset_deg;
 322
 323     // used to set nearplane when at ground level for this view
 324     double _ground_level_nearplane_m;
 325
 326     fgViewType _type;
 327     fgScalingType _scaling_type;
 328
 329     // internal view (e.g. cockpit) flag
 330     bool _internal;
 331
 332     // view is looking from a model
 333     bool _from_model;
 334     int _from_model_index;  // number of model (for multi model)
 335
 336     // view is looking at a model
 337     bool _at_model;
 338     int _at_model_index;  // number of model (for multi model)
 339
 340     SGLocation * _location;
 341     SGLocation * _target_location;
 342
 343     // the nominal field of view (angle, in degrees)
 344     double _fov_deg;
 345
 346     // ratio of window width and height; height = width * aspect_ratio
 347     double _aspect_ratio;
 348
 349     bool _reverse_view_offset;
 350
 351     // view position in opengl world coordinates (this is the
 352     // abs_view_pos translated to scenery.center)
 353     sgVec3 _view_pos;
 354
 355     // cartesion coordinates of current lon/lat if at sea level
 356     // translated to scenery.center
 357     sgVec3 _zero_elev;
 358
 359     // surface vector heading south
 360     sgVec3 _surface_south;
 361
 362     // surface vector heading east (used to unambiguously align sky
 363     // with sun)
 364     sgVec3 _surface_east;
 365
 366     // world up vector (normal to the plane tangent to the earth's
 367     // surface at the spot we are directly above
 368     sgVec3 _world_up;
 369
 370     // up vector for the view (usually point straight up through the
 371     // top of the aircraft
 372     sgVec3 _view_up;
 373
 374     // sg versions of our friendly matrices
 375     sgMat4 VIEW, UP;
 376     sgMat4 LOCAL, ATLOCAL, TRANS, LARC_TO_SSG;
 377
 378     // Transformation matrix for the view direction offset relative to
 379     // the AIRCRAFT matrix
 380     sgMat4 VIEW_OFFSET;
 381
 382     //////////////////////////////////////////////////////////////////
 383     // private functions                                            //
 384     //////////////////////////////////////////////////////////////////
 385
 386     void recalc ();
 387     void recalcLookFrom();
 388     void recalcLookAt();
 389     void copyLocationData();
 390     void updateFromModelLocation (SGLocation * location);
 391     void updateAtModelLocation (SGLocation * location);
 392     void recalcOurOwnLocation (SGLocation * location, double lon_deg, double lat_deg, double alt_ft,
 393                  double roll_deg, double pitch_deg, double heading_deg);
 394     void dampEyeData (double &roll_deg, double &pitch_deg, double &heading_deg);
 395
 396     // add to _heading_offset_deg
 397     inline void incHeadingOffset_deg( double amt ) {
 398         set_dirty();
 399         _heading_offset_deg += amt;
 400     }
 401
 402     // add to _pitch_offset_deg
 403     inline void incPitchOffset_deg( double amt ) {
 404         set_dirty();
 405         _pitch_offset_deg += amt;
 406     }
 407
 408     // add to _roll_offset_deg
 409     inline void incRollOffset_deg( double amt ) {
 410         set_dirty();
 411         _roll_offset_deg += amt;
 412     }
 413
 414     inline void set_reverse_view_offset( bool val ) {
 415         _reverse_view_offset = val;
 416     }
 417
 418 };
 419
 420
 421 #endif // _VIEWER_HXX