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