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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 namespace flightgear
  36 {
  37 class CameraGroup;
  38 }
  39
  40 #include <osg/ref_ptr>
  41
  42 #include <simgear/compiler.h>
  43 #include <simgear/constants.h>
  44 #include <simgear/structure/subsystem_mgr.hxx>
  45 #include <simgear/math/SGMath.hxx>
  46
  47 #define FG_FOV_MIN 0.1
  48 #define FG_FOV_MAX 179.9
  49
  50 enum fgViewType {
  51  FG_LOOKFROM = 0,
  52  FG_LOOKAT = 1
  53 };
  54
  55 // Define a structure containing view information
  56 class FGViewer : public SGSubsystem {
  57
  58 public:
  59
  60     enum fgScalingType {  // nominal Field Of View actually applies to ...
  61         FG_SCALING_WIDTH,       // window width
  62         FG_SCALING_MAX          // max(width, height)
  63         // FG_SCALING_G_MEAN,      // geometric_mean(width, height)
  64         // FG_SCALING_INDEPENDENT  // whole screen
  65     };
  66
  67     // Constructor
  68     FGViewer( fgViewType Type, bool from_model, int from_model_index,
  69               bool at_model, int at_model_index,
  70               double damp_roll, double damp_pitch, double damp_heading,
  71               double x_offset_m, double y_offset_m, double z_offset_m,
  72               double heading_offset_deg, double pitch_offset_deg,
  73               double roll_offset_deg,
  74               double fov_deg, double aspect_ratio_multiplier,
  75               double target_x_offset_m, double target_y_offset_m,
  76               double target_z_offset_m, double near_m, bool internal );
  77
  78     // Destructor
  79     virtual ~FGViewer( void );
  80
  81     //////////////////////////////////////////////////////////////////////
  82     // Part 1: standard SGSubsystem implementation.
  83     //////////////////////////////////////////////////////////////////////
  84
  85     virtual void init ();
  86     virtual void bind ();
  87     virtual void unbind ();
  88     void update (double dt);
  89
  90
  91     //////////////////////////////////////////////////////////////////////
  92     // Part 2: user settings.
  93     //////////////////////////////////////////////////////////////////////
  94
  95     virtual fgViewType getType() const { return _type; }
  96     virtual void setType( int type );
  97
  98     virtual bool getInternal() const { return _internal; }
  99     virtual void setInternal( bool internal );
 100
 101     // Reference geodetic position of view from position...
 102     //   These are the actual aircraft position (pilot in
 103     //   pilot view, model in model view).
 104     //   FIXME: the model view position (ie target positions)
 105     //   should be in the model class.
 106     virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
 107     const SGGeod& getPosition() const { return _position; }
 108
 109     // Reference geodetic target position...
 110     virtual void setTargetPosition (double lon_deg, double lat_deg, double alt_ft);
 111     const SGGeod& getTargetPosition() const { return _target; }
 112
 113
 114
 115     // Position offsets from reference
 116     //   These offsets position they "eye" in the scene according to a given
 117     //   location.  For example in pilot view they are used to position the
 118     //   head inside the aircraft.
 119     //   Note that in pilot view these are applied "before" the orientation
 120     //   rotations (see below) so that the orientation rotations have the
 121     //   effect of the pilot staying in his seat and "looking out" in
 122     //   different directions.
 123     //   In chase view these are applied "after" the application of the
 124     //   orientation rotations listed below.  This has the effect of the
 125     //   eye moving around and "looking at" the object (model) from
 126     //   different angles.
 127     virtual double getXOffset_m () const { return _offset_m.x(); }
 128     virtual double getYOffset_m () const { return _offset_m.y(); }
 129     virtual double getZOffset_m () const { return _offset_m.z(); }
 130     virtual double getTargetXOffset_m () const { return _target_offset_m.x(); }
 131     virtual double getTargetYOffset_m () const { return _target_offset_m.y(); }
 132     virtual double getTargetZOffset_m () const { return _target_offset_m.z(); }
 133     virtual void setXOffset_m (double x_offset_m);
 134     virtual void setYOffset_m (double y_offset_m);
 135     virtual void setZOffset_m (double z_offset_m);
 136     virtual void setTargetXOffset_m (double x_offset_m);
 137     virtual void setTargetYOffset_m (double y_offset_m);
 138     virtual void setTargetZOffset_m (double z_offset_m);
 139     virtual void setPositionOffsets (double x_offset_m,
 140                                      double y_offset_m,
 141                                      double z_offset_m);
 142
 143
 144
 145
 146     // Reference orientation rotations...
 147     //   These are rotations that represent the plane attitude effect on
 148     //   the view (in Pilot view).  IE The view frustrum rotates as the plane
 149     //   turns, pitches, and rolls.
 150     //   In model view (lookat/chaseview) these end up changing the angle that
 151     //   the eye is looking at the ojbect (ie the model).
 152     //   FIXME: the FGModel class should have its own version of these so that
 153     //   it can generate it's own model rotations.
 154     virtual double getRoll_deg () const { return _roll_deg; }
 155     virtual double getPitch_deg () const {return _pitch_deg; }
 156     virtual double getHeading_deg () const {return _heading_deg; }
 157     virtual void setRoll_deg (double roll_deg);
 158     virtual void setPitch_deg (double pitch_deg);
 159     virtual void setHeading_deg (double heading_deg);
 160     virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
 161     virtual double getTargetRoll_deg () const { return _target_roll_deg; }
 162     virtual double getTargetPitch_deg () const {return _target_pitch_deg; }
 163     virtual double getTargetHeading_deg () const {return _target_heading_deg; }
 164     virtual void setTargetRoll_deg (double roll_deg);
 165     virtual void setTargetPitch_deg (double pitch_deg);
 166     virtual void setTargetHeading_deg (double heading_deg);
 167     virtual void setTargetOrientation (double roll_deg, double pitch_deg, double heading_deg);
 168
 169
 170
 171
 172     // Orientation offsets rotations from reference orientation.
 173     // Goal settings are for smooth transition from prior
 174     // offset when changing view direction.
 175     //   These offsets are in ADDITION to the orientation rotations listed
 176     //   above.
 177     //   In pilot view they are applied after the position offsets in order to
 178     //   give the effect of the pilot looking around.
 179     //   In lookat view they are applied before the position offsets so that
 180     //   the effect is the eye moving around looking at the object (ie the model)
 181     //   from different angles.
 182     virtual double getRollOffset_deg () const { return _roll_offset_deg; }
 183     virtual double getPitchOffset_deg () const { return _pitch_offset_deg; }
 184     virtual double getHeadingOffset_deg () const { return _heading_offset_deg; }
 185     virtual double getGoalRollOffset_deg () const { return _goal_roll_offset_deg; }
 186     virtual double getGoalPitchOffset_deg () const { return _goal_pitch_offset_deg; }
 187     virtual double getGoalHeadingOffset_deg () const {return _goal_heading_offset_deg; }
 188     virtual void setRollOffset_deg (double roll_offset_deg);
 189     virtual void setPitchOffset_deg (double pitch_offset_deg);
 190     virtual void setHeadingOffset_deg (double heading_offset_deg);
 191     virtual void setGoalRollOffset_deg (double goal_roll_offset_deg);
 192     virtual void setGoalPitchOffset_deg (double goal_pitch_offset_deg);
 193     virtual void setGoalHeadingOffset_deg (double goal_heading_offset_deg);
 194     virtual void setOrientationOffsets (double roll_offset_deg,
 195                                      double heading_offset_deg,
 196                                      double pitch_offset_deg);
 197
 198
 199
 200     //////////////////////////////////////////////////////////////////////
 201     // Part 3: output vectors and matrices in FlightGear coordinates.
 202     //////////////////////////////////////////////////////////////////////
 203
 204     // Vectors and positions...
 205
 206     const SGVec3d& get_view_pos() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
 207     const SGVec3d& getViewPosition() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
 208     const SGQuatd& getViewOrientation() { if ( _dirty ) { recalc(); } return mViewOrientation; }
 209
 210     //////////////////////////////////////////////////////////////////////
 211     // Part 4: View and frustrum data setters and getters
 212     //////////////////////////////////////////////////////////////////////
 213
 214     virtual void set_fov( double fov_deg ) {
 215         _fov_deg = fov_deg;
 216     }
 217     virtual double get_fov() const { return _fov_deg; }
 218     virtual double get_h_fov();    // Get horizontal fov, in degrees.
 219     virtual double get_v_fov();    // Get vertical fov, in degrees.
 220
 221     virtual void set_aspect_ratio( double r ) {
 222         _aspect_ratio = r;
 223     }
 224     virtual double get_aspect_ratio() const { return _aspect_ratio; }
 225
 226     virtual void set_aspect_ratio_multiplier( double m ) {
 227         _aspect_ratio_multiplier = m;
 228     }
 229     virtual double get_aspect_ratio_multiplier() const {
 230         return _aspect_ratio_multiplier;
 231     }
 232
 233     virtual double getNear_m () const { return _ground_level_nearplane_m; }
 234     inline void setNear_m (double near_m) {
 235         _ground_level_nearplane_m = near_m;
 236     }
 237
 238     //////////////////////////////////////////////////////////////////////
 239     // Part 5: misc setters and getters
 240     //////////////////////////////////////////////////////////////////////
 241
 242     inline void set_dirty() { _dirty = true; }
 243     inline void set_clean() { _dirty = false; }
 244
 245 private:
 246
 247     //////////////////////////////////////////////////////////////////
 248     // private data                                                 //
 249     //////////////////////////////////////////////////////////////////
 250
 251     // flag forcing a recalc of derived view parameters
 252     bool _dirty;
 253
 254     SGQuatd mViewOrientation;
 255     SGVec3d _absolute_view_pos;
 256
 257     SGGeod _position;
 258     SGGeod _target;
 259
 260     double _roll_deg;
 261     double _pitch_deg;
 262     double _heading_deg;
 263     double _target_roll_deg;
 264     double _target_pitch_deg;
 265     double _target_heading_deg;
 266
 267     double _damp_sync;
 268     double _damp_roll;
 269     double _damp_pitch;
 270     double _damp_heading;
 271
 272     double _damped_roll_deg;
 273     double _damped_pitch_deg;
 274     double _damped_heading_deg;
 275
 276     // Position offsets from FDM origin.  The X axis is positive
 277     // out the tail, Y is out the right wing, and Z is positive up.
 278     // distance in meters
 279     SGVec3d _offset_m;
 280
 281     // Target offsets from FDM origin (for "lookat" targets) The X
 282     // axis is positive out the tail, Y is out the right wing, and Z
 283     // is positive up.  distance in meters
 284     SGVec3d _target_offset_m;
 285
 286
 287     // orientation offsets from reference (_goal* are for smoothed transitions)
 288     double _roll_offset_deg;
 289     double _pitch_offset_deg;
 290     double _heading_offset_deg;
 291     double _goal_roll_offset_deg;
 292     double _goal_pitch_offset_deg;
 293     double _goal_heading_offset_deg;
 294
 295     // used to set nearplane when at ground level for this view
 296     double _ground_level_nearplane_m;
 297
 298     fgViewType _type;
 299     fgScalingType _scaling_type;
 300
 301     // internal view (e.g. cockpit) flag
 302     bool _internal;
 303
 304     // view is looking from a model
 305     bool _from_model;
 306     int _from_model_index;  // number of model (for multi model)
 307
 308     // view is looking at a model
 309     bool _at_model;
 310     int _at_model_index;  // number of model (for multi model)
 311
 312     // the nominal field of view (angle, in degrees)
 313     double _fov_deg;
 314
 315     // Ratio of window width and height; height = width *
 316     // aspect_ratio.  This value is automatically calculated based on
 317     // window dimentions.
 318     double _aspect_ratio;
 319
 320     // default = 1.0, this value is user configurable and is
 321     // multiplied into the aspect_ratio to get the actual vertical fov
 322     double _aspect_ratio_multiplier;
 323
 324     // camera group controled by this view
 325     osg::ref_ptr<flightgear::CameraGroup> _cameraGroup;
 326     //////////////////////////////////////////////////////////////////
 327     // private functions                                            //
 328     //////////////////////////////////////////////////////////////////
 329
 330     void recalc ();
 331     void recalcLookFrom();
 332     void recalcLookAt();
 333     void dampEyeData(double &roll_deg, double &pitch_deg, double &heading_deg);
 334
 335     // add to _heading_offset_deg
 336     inline void incHeadingOffset_deg( double amt ) {
 337         set_dirty();
 338         _heading_offset_deg += amt;
 339     }
 340
 341     // add to _pitch_offset_deg
 342     inline void incPitchOffset_deg( double amt ) {
 343         set_dirty();
 344         _pitch_offset_deg += amt;
 345     }
 346
 347     // add to _roll_offset_deg
 348     inline void incRollOffset_deg( double amt ) {
 349         set_dirty();
 350         _roll_offset_deg += amt;
 351     }
 352
 353 };
 354
 355
 356 #endif // _VIEWER_HXX