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