src/Main/viewer.cxx

   1 // viewer.cxx -- 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 #ifdef HAVE_CONFIG_H
  27 #  include "config.h"
  28 #endif
  29
  30 #include <simgear/compiler.h>
  31
  32 #include "fg_props.hxx"
  33
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/constants.h>
  36 #include <simgear/scene/model/placement.hxx>
  37 #include <simgear/math/vector.hxx>
  38
  39 #include <Main/globals.hxx>
  40 #include <Scenery/scenery.hxx>
  41 #include <Model/acmodel.hxx>
  42
  43 #include "viewer.hxx"
  44
  45 #include "CameraGroup.hxx"
  46
  47 using namespace flightgear;
  48 \f
  49 ////////////////////////////////////////////////////////////////////////
  50 // Implementation of FGViewer.
  51 ////////////////////////////////////////////////////////////////////////
  52
  53 // Constructor...
  54 FGViewer::FGViewer( fgViewType Type, bool from_model, int from_model_index,
  55                     bool at_model, int at_model_index,
  56                     double damp_roll, double damp_pitch, double damp_heading,
  57                     double x_offset_m, double y_offset_m, double z_offset_m,
  58                     double heading_offset_deg, double pitch_offset_deg,
  59                     double roll_offset_deg,
  60                     double fov_deg, double aspect_ratio_multiplier,
  61                     double target_x_offset_m, double target_y_offset_m,
  62                     double target_z_offset_m, double near_m, bool internal ):
  63     _dirty(true),
  64     _roll_deg(0),
  65     _pitch_deg(0),
  66     _heading_deg(0),
  67     _scaling_type(FG_SCALING_MAX),
  68     _aspect_ratio(0),
  69     _cameraGroup(CameraGroup::getDefault())
  70 {
  71     _absolute_view_pos = SGVec3d(0, 0, 0);
  72     _type = Type;
  73     _from_model = from_model;
  74     _from_model_index = from_model_index;
  75     _at_model = at_model;
  76     _at_model_index = at_model_index;
  77
  78     _internal = internal;
  79
  80     _dampFactor = SGVec3d::zeros();
  81     _dampOutput = SGVec3d::zeros();
  82     _dampTarget = SGVec3d::zeros();
  83
  84     if (damp_roll > 0.0)
  85       _dampFactor[0] = 1.0 / pow(10.0, fabs(damp_roll));
  86     if (damp_pitch > 0.0)
  87       _dampFactor[1] = 1.0 / pow(10.0, fabs(damp_pitch));
  88     if (damp_heading > 0.0)
  89       _dampFactor[2] = 1.0 / pow(10.0, fabs(damp_heading));
  90
  91     _offset_m.x() = x_offset_m;
  92     _offset_m.y() = y_offset_m;
  93     _offset_m.z() = z_offset_m;
  94     _heading_offset_deg = heading_offset_deg;
  95     _pitch_offset_deg = pitch_offset_deg;
  96     _roll_offset_deg = roll_offset_deg;
  97     _goal_heading_offset_deg = heading_offset_deg;
  98     _goal_pitch_offset_deg = pitch_offset_deg;
  99     _goal_roll_offset_deg = roll_offset_deg;
 100     if (fov_deg > 0) {
 101       _fov_deg = fov_deg;
 102     } else {
 103       _fov_deg = 55;
 104     }
 105     _aspect_ratio = 1;
 106     _aspect_ratio_multiplier = aspect_ratio_multiplier;
 107     _target_offset_m.x() = target_x_offset_m;
 108     _target_offset_m.y() = target_y_offset_m;
 109     _target_offset_m.z() = target_z_offset_m;
 110     _ground_level_nearplane_m = near_m;
 111     // a reasonable guess for init, so that the math doesn't blow up
 112 }
 113
 114
 115 // Destructor
 116 FGViewer::~FGViewer( void ) {
 117 }
 118
 119 void
 120 FGViewer::init ()
 121 {
 122 }
 123
 124 void
 125 FGViewer::bind ()
 126 {
 127 }
 128
 129 void
 130 FGViewer::unbind ()
 131 {
 132 }
 133
 134 void
 135 FGViewer::setType ( int type )
 136 {
 137   if (type == 0)
 138     _type = FG_LOOKFROM;
 139   if (type == 1)
 140     _type = FG_LOOKAT;
 141 }
 142
 143 void
 144 FGViewer::setInternal ( bool internal )
 145 {
 146   _internal = internal;
 147 }
 148
 149 void
 150 FGViewer::setPosition (double lon_deg, double lat_deg, double alt_ft)
 151 {
 152   _dirty = true;
 153   _position = SGGeod::fromDegFt(lon_deg, lat_deg, alt_ft);
 154 }
 155
 156 void
 157 FGViewer::setTargetPosition (double lon_deg, double lat_deg, double alt_ft)
 158 {
 159   _dirty = true;
 160   _target = SGGeod::fromDegFt(lon_deg, lat_deg, alt_ft);
 161 }
 162
 163 void
 164 FGViewer::setRoll_deg (double roll_deg)
 165 {
 166   _dirty = true;
 167   _roll_deg = roll_deg;
 168 }
 169
 170 void
 171 FGViewer::setPitch_deg (double pitch_deg)
 172 {
 173   _dirty = true;
 174   _pitch_deg = pitch_deg;
 175 }
 176
 177 void
 178 FGViewer::setHeading_deg (double heading_deg)
 179 {
 180   _dirty = true;
 181   _heading_deg = heading_deg;
 182 }
 183
 184 void
 185 FGViewer::setOrientation (double roll_deg, double pitch_deg, double heading_deg)
 186 {
 187   _dirty = true;
 188   _roll_deg = roll_deg;
 189   _pitch_deg = pitch_deg;
 190   _heading_deg = heading_deg;
 191 }
 192
 193 void
 194 FGViewer::setTargetRoll_deg (double target_roll_deg)
 195 {
 196   _dirty = true;
 197   _target_roll_deg = target_roll_deg;
 198 }
 199
 200 void
 201 FGViewer::setTargetPitch_deg (double target_pitch_deg)
 202 {
 203   _dirty = true;
 204   _target_pitch_deg = target_pitch_deg;
 205 }
 206
 207 void
 208 FGViewer::setTargetHeading_deg (double target_heading_deg)
 209 {
 210   _dirty = true;
 211   _target_heading_deg = target_heading_deg;
 212 }
 213
 214 void
 215 FGViewer::setTargetOrientation (double target_roll_deg, double target_pitch_deg, double target_heading_deg)
 216 {
 217   _dirty = true;
 218   _target_roll_deg = target_roll_deg;
 219   _target_pitch_deg = target_pitch_deg;
 220   _target_heading_deg = target_heading_deg;
 221 }
 222
 223 void
 224 FGViewer::setXOffset_m (double x_offset_m)
 225 {
 226   _dirty = true;
 227   _offset_m.x() = x_offset_m;
 228 }
 229
 230 void
 231 FGViewer::setYOffset_m (double y_offset_m)
 232 {
 233   _dirty = true;
 234   _offset_m.y() = y_offset_m;
 235 }
 236
 237 void
 238 FGViewer::setZOffset_m (double z_offset_m)
 239 {
 240   _dirty = true;
 241   _offset_m.z() = z_offset_m;
 242 }
 243
 244 void
 245 FGViewer::setTargetXOffset_m (double target_x_offset_m)
 246 {
 247   _dirty = true;
 248   _target_offset_m.x() = target_x_offset_m;
 249 }
 250
 251 void
 252 FGViewer::setTargetYOffset_m (double target_y_offset_m)
 253 {
 254   _dirty = true;
 255   _target_offset_m.y() = target_y_offset_m;
 256 }
 257
 258 void
 259 FGViewer::setTargetZOffset_m (double target_z_offset_m)
 260 {
 261   _dirty = true;
 262   _target_offset_m.z() = target_z_offset_m;
 263 }
 264
 265 void
 266 FGViewer::setPositionOffsets (double x_offset_m, double y_offset_m, double z_offset_m)
 267 {
 268   _dirty = true;
 269   _offset_m.x() = x_offset_m;
 270   _offset_m.y() = y_offset_m;
 271   _offset_m.z() = z_offset_m;
 272 }
 273
 274 void
 275 FGViewer::setRollOffset_deg (double roll_offset_deg)
 276 {
 277   _dirty = true;
 278   _roll_offset_deg = roll_offset_deg;
 279 }
 280
 281 void
 282 FGViewer::setPitchOffset_deg (double pitch_offset_deg)
 283 {
 284   _dirty = true;
 285   _pitch_offset_deg = pitch_offset_deg;
 286 }
 287
 288 void
 289 FGViewer::setHeadingOffset_deg (double heading_offset_deg)
 290 {
 291   _dirty = true;
 292   _heading_offset_deg = heading_offset_deg;
 293 }
 294
 295 void
 296 FGViewer::setGoalRollOffset_deg (double goal_roll_offset_deg)
 297 {
 298   _dirty = true;
 299   _goal_roll_offset_deg = goal_roll_offset_deg;
 300 }
 301
 302 void
 303 FGViewer::setGoalPitchOffset_deg (double goal_pitch_offset_deg)
 304 {
 305   _dirty = true;
 306   _goal_pitch_offset_deg = goal_pitch_offset_deg;
 307   if ( _goal_pitch_offset_deg < -90 ) {
 308     _goal_pitch_offset_deg = -90.0;
 309   }
 310   if ( _goal_pitch_offset_deg > 90.0 ) {
 311     _goal_pitch_offset_deg = 90.0;
 312   }
 313
 314 }
 315
 316 void
 317 FGViewer::setGoalHeadingOffset_deg (double goal_heading_offset_deg)
 318 {
 319   _dirty = true;
 320   _goal_heading_offset_deg = goal_heading_offset_deg;
 321   while ( _goal_heading_offset_deg < 0.0 ) {
 322     _goal_heading_offset_deg += 360;
 323   }
 324   while ( _goal_heading_offset_deg > 360 ) {
 325     _goal_heading_offset_deg -= 360;
 326   }
 327 }
 328
 329 void
 330 FGViewer::setOrientationOffsets (double roll_offset_deg, double pitch_offset_deg, double heading_offset_deg)
 331 {
 332   _dirty = true;
 333   _roll_offset_deg = roll_offset_deg;
 334   _pitch_offset_deg = pitch_offset_deg;
 335   _heading_offset_deg = heading_offset_deg;
 336 }
 337
 338 // recalc() is done every time one of the setters is called (making the
 339 // cached data "dirty") on the next "get".  It calculates all the outputs
 340 // for viewer.
 341 void
 342 FGViewer::recalc ()
 343 {
 344   if (_type == FG_LOOKFROM) {
 345     recalcLookFrom();
 346   } else {
 347     recalcLookAt();
 348   }
 349
 350   set_clean();
 351 }
 352
 353 // recalculate for LookFrom view type...
 354 void
 355 FGViewer::recalcLookFrom ()
 356 {
 357   // Update location data ...
 358   if ( _from_model ) {
 359     SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
 360     _position = placement->getPosition();
 361
 362     _heading_deg = placement->getHeadingDeg();
 363     _pitch_deg = placement->getPitchDeg();
 364     _roll_deg = placement->getRollDeg();
 365   }
 366
 367   double head = _heading_deg;
 368   double pitch = _pitch_deg;
 369   double roll = _roll_deg;
 370   if ( !_from_model ) {
 371     // update from our own data...
 372     setDampTarget(roll, pitch, head);
 373     getDampOutput(roll, pitch, head);
 374   }
 375
 376   // The rotation rotating from the earth centerd frame to
 377   // the horizontal local frame
 378   SGQuatd hlOr = SGQuatd::fromLonLat(_position);
 379
 380   // The rotation from the horizontal local frame to the basic view orientation
 381   SGQuatd hlToBody = SGQuatd::fromYawPitchRollDeg(head, pitch, roll);
 382
 383   // The rotation offset, don't know why heading is negative here ...
 384   mViewOffsetOr
 385       = SGQuatd::fromYawPitchRollDeg(-_heading_offset_deg, _pitch_offset_deg,
 386                                      _roll_offset_deg);
 387
 388   // Compute the eyepoints orientation and position
 389   // wrt the earth centered frame - that is global coorinates
 390   SGQuatd ec2body = hlOr*hlToBody;
 391
 392   // The cartesian position of the basic view coordinate
 393   SGVec3d position = SGVec3d::fromGeod(_position);
 394
 395   // This is rotates the x-forward, y-right, z-down coordinate system the where
 396   // simulation runs into the OpenGL camera system with x-right, y-up, z-back.
 397   SGQuatd q(-0.5, -0.5, 0.5, 0.5);
 398
 399   _absolute_view_pos = position + (ec2body*q).backTransform(_offset_m);
 400   mViewOrientation = ec2body*mViewOffsetOr*q;
 401 }
 402
 403 void
 404 FGViewer::recalcLookAt ()
 405 {
 406   // The geodetic position of our target to look at
 407   if ( _at_model ) {
 408     SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
 409     _target = placement->getPosition();
 410     _target_heading_deg = placement->getHeadingDeg();
 411     _target_pitch_deg = placement->getPitchDeg();
 412     _target_roll_deg = placement->getRollDeg();
 413   } else {
 414     // if not model then calculate our own target position...
 415     setDampTarget(_target_roll_deg, _target_pitch_deg, _target_heading_deg);
 416     getDampOutput(_target_roll_deg, _target_pitch_deg, _target_heading_deg);
 417   }
 418
 419   SGQuatd geodTargetOr = SGQuatd::fromYawPitchRollDeg(_target_heading_deg,
 420                                                    _target_pitch_deg,
 421                                                    _target_roll_deg);
 422   SGQuatd geodTargetHlOr = SGQuatd::fromLonLat(_target);
 423
 424
 425   if ( _from_model ) {
 426     SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
 427     _position = placement->getPosition();
 428     _heading_deg = placement->getHeadingDeg();
 429     _pitch_deg = placement->getPitchDeg();
 430     _roll_deg = placement->getRollDeg();
 431   } else {
 432     // update from our own data, just the rotation here...
 433     setDampTarget(_roll_deg, _pitch_deg, _heading_deg);
 434     getDampOutput(_roll_deg, _pitch_deg, _heading_deg);
 435   }
 436   SGQuatd geodEyeOr = SGQuatd::fromYawPitchRollDeg(_heading_deg, _pitch_deg, _roll_deg);
 437   SGQuatd geodEyeHlOr = SGQuatd::fromLonLat(_position);
 438
 439   // the rotation offset, don't know why heading is negative here ...
 440   mViewOffsetOr =
 441     SGQuatd::fromYawPitchRollDeg(-_heading_offset_deg + 180, _pitch_offset_deg,
 442                                  _roll_offset_deg);
 443
 444   // Offsets to the eye position
 445   SGVec3d eyeOff(-_offset_m.z(), _offset_m.x(), -_offset_m.y());
 446   SGQuatd ec2eye = geodEyeHlOr*geodEyeOr;
 447   SGVec3d eyeCart = SGVec3d::fromGeod(_position);
 448   eyeCart += (ec2eye*mViewOffsetOr).backTransform(eyeOff);
 449
 450   SGVec3d atCart = SGVec3d::fromGeod(_target);
 451
 452   // add target offsets to at_position...
 453   SGVec3d target_pos_off(-_target_offset_m.z(), _target_offset_m.x(),
 454                          -_target_offset_m.y());
 455   target_pos_off = (geodTargetHlOr*geodTargetOr).backTransform(target_pos_off);
 456   atCart += target_pos_off;
 457   eyeCart += target_pos_off;
 458
 459   // Compute the eyepoints orientation and position
 460   // wrt the earth centered frame - that is global coorinates
 461   _absolute_view_pos = eyeCart;
 462
 463   // the view direction
 464   SGVec3d dir = normalize(atCart - eyeCart);
 465   // the up directon
 466   SGVec3d up = ec2eye.backTransform(SGVec3d(0, 0, -1));
 467   // rotate -dir to the 2-th unit vector
 468   // rotate up to 1-th unit vector
 469   // Note that this matches the OpenGL camera coordinate system
 470   // with x-right, y-up, z-back.
 471   mViewOrientation = SGQuatd::fromRotateTo(-dir, 2, up, 1);
 472 }
 473
 474 void
 475 FGViewer::setDampTarget(double roll, double pitch, double heading)
 476 {
 477   _dampTarget = SGVec3d(roll, pitch, heading);
 478 }
 479
 480 void
 481 FGViewer::getDampOutput(double& roll, double& pitch, double& heading)
 482 {
 483   roll = _dampOutput[0];
 484   pitch = _dampOutput[1];
 485   heading = _dampOutput[2];
 486 }
 487
 488
 489 void
 490 FGViewer::updateDampOutput(double dt)
 491 {
 492   static FGViewer *last_view = 0;
 493   if ((last_view != this) || (dt > 1.0)) {
 494     _dampOutput = _dampTarget;
 495     last_view = this;
 496     return;
 497   }
 498
 499   const double interval = 0.01;
 500   while (dt > interval) {
 501
 502     for (unsigned int i=0; i<3; ++i) {
 503       if (_dampFactor[i] <= 0.0) {
 504         continue;
 505       }
 506
 507       double d = _dampOutput[i] - _dampTarget[i];
 508       if (d > 180.0) {
 509         _dampOutput[i] -= 360.0;
 510       } else if (d < -180.0) {
 511         _dampOutput[i] += 360.0;
 512       }
 513
 514       _dampOutput[i] = (_dampTarget[i] * _dampFactor[i]) +
 515         (_dampOutput[i] * (1.0 - _dampFactor[i]));
 516     } // of axis iteration
 517
 518     dt -= interval;
 519   } // of dt subdivision by interval
 520 }
 521
 522 double
 523 FGViewer::get_h_fov()
 524 {
 525     switch (_scaling_type) {
 526     case FG_SCALING_WIDTH:  // h_fov == fov
 527         return _fov_deg;
 528     case FG_SCALING_MAX:
 529         if (_aspect_ratio < 1.0) {
 530             // h_fov == fov
 531             return _fov_deg;
 532         } else {
 533             // v_fov == fov
 534             return
 535                 atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
 536                      / (_aspect_ratio*_aspect_ratio_multiplier))
 537                 * SG_RADIANS_TO_DEGREES * 2;
 538         }
 539     default:
 540         assert(false);
 541     }
 542     return 0.0;
 543 }
 544
 545
 546
 547 double
 548 FGViewer::get_v_fov()
 549 {
 550     switch (_scaling_type) {
 551     case FG_SCALING_WIDTH:  // h_fov == fov
 552         return
 553             atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
 554                  * (_aspect_ratio*_aspect_ratio_multiplier))
 555             * SG_RADIANS_TO_DEGREES * 2;
 556     case FG_SCALING_MAX:
 557         if (_aspect_ratio < 1.0) {
 558             // h_fov == fov
 559             return
 560                 atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
 561                      * (_aspect_ratio*_aspect_ratio_multiplier))
 562                 * SG_RADIANS_TO_DEGREES * 2;
 563         } else {
 564             // v_fov == fov
 565             return _fov_deg;
 566         }
 567     default:
 568         assert(false);
 569     }
 570     return 0.0;
 571 }
 572
 573 void
 574 FGViewer::update (double dt)
 575 {
 576   updateDampOutput(dt);
 577
 578   int i;
 579   int dt_ms = int(dt * 1000);
 580   for ( i = 0; i < dt_ms; i++ ) {
 581     if ( fabs( _goal_heading_offset_deg - _heading_offset_deg) < 1 ) {
 582       setHeadingOffset_deg( _goal_heading_offset_deg );
 583       break;
 584     } else {
 585       // move current_view.headingoffset towards
 586       // current_view.goal_view_offset
 587       if ( _goal_heading_offset_deg > _heading_offset_deg )
 588         {
 589           if ( _goal_heading_offset_deg - _heading_offset_deg < 180 ){
 590             incHeadingOffset_deg( 0.5 );
 591           } else {
 592             incHeadingOffset_deg( -0.5 );
 593           }
 594         } else {
 595           if ( _heading_offset_deg - _goal_heading_offset_deg < 180 ){
 596             incHeadingOffset_deg( -0.5 );
 597           } else {
 598             incHeadingOffset_deg( 0.5 );
 599           }
 600         }
 601       if ( _heading_offset_deg > 360 ) {
 602         incHeadingOffset_deg( -360 );
 603       } else if ( _heading_offset_deg < 0 ) {
 604         incHeadingOffset_deg( 360 );
 605       }
 606     }
 607   }
 608
 609   for ( i = 0; i < dt_ms; i++ ) {
 610     if ( fabs( _goal_pitch_offset_deg - _pitch_offset_deg ) < 1 ) {
 611       setPitchOffset_deg( _goal_pitch_offset_deg );
 612       break;
 613     } else {
 614       // move current_view.pitch_offset_deg towards
 615       // current_view.goal_pitch_offset
 616       if ( _goal_pitch_offset_deg > _pitch_offset_deg )
 617         {
 618           incPitchOffset_deg( 1.0 );
 619         } else {
 620             incPitchOffset_deg( -1.0 );
 621         }
 622       if ( _pitch_offset_deg > 90 ) {
 623         setPitchOffset_deg(90);
 624       } else if ( _pitch_offset_deg < -90 ) {
 625         setPitchOffset_deg( -90 );
 626       }
 627     }
 628   }
 629
 630
 631   for ( i = 0; i < dt_ms; i++ ) {
 632     if ( fabs( _goal_roll_offset_deg - _roll_offset_deg ) < 1 ) {
 633       setRollOffset_deg( _goal_roll_offset_deg );
 634       break;
 635     } else {
 636       // move current_view.roll_offset_deg towards
 637       // current_view.goal_roll_offset
 638       if ( _goal_roll_offset_deg > _roll_offset_deg )
 639         {
 640           incRollOffset_deg( 1.0 );
 641         } else {
 642             incRollOffset_deg( -1.0 );
 643         }
 644       if ( _roll_offset_deg > 90 ) {
 645         setRollOffset_deg(90);
 646       } else if ( _roll_offset_deg < -90 ) {
 647         setRollOffset_deg( -90 );
 648       }
 649     }
 650   }
 651   recalc();
 652   _cameraGroup->update(toOsg(_absolute_view_pos), toOsg(mViewOrientation));
 653   _cameraGroup->setCameraParameters(get_v_fov(), get_aspect_ratio());
 654 }