1 // viewer.cxx -- class for managing a viewer in the flightgear world.
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
8 // Copyright (C) 1997 - 2000 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
30 #include <simgear/compiler.h>
33 #include "fg_props.hxx"
35 #include <simgear/debug/logstream.hxx>
36 #include <simgear/constants.h>
37 #include <simgear/scene/model/placement.hxx>
39 #include <Main/globals.hxx>
40 #include <Scenery/scenery.hxx>
41 #include <Model/acmodel.hxx>
45 #include "CameraGroup.hxx"
47 using namespace flightgear;
49 ////////////////////////////////////////////////////////////////////////
50 // Implementation of FGViewer.
51 ////////////////////////////////////////////////////////////////////////
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 ):
67 _scaling_type(FG_SCALING_MAX),
68 _cameraGroup(CameraGroup::getDefault())
70 _absolute_view_pos = SGVec3d(0, 0, 0);
72 _from_model = from_model;
73 _from_model_index = from_model_index;
75 _at_model_index = at_model_index;
79 _dampFactor = SGVec3d::zeros();
80 _dampOutput = SGVec3d::zeros();
81 _dampTarget = SGVec3d::zeros();
84 _dampFactor[0] = 1.0 / pow(10.0, fabs(damp_roll));
86 _dampFactor[1] = 1.0 / pow(10.0, fabs(damp_pitch));
87 if (damp_heading > 0.0)
88 _dampFactor[2] = 1.0 / pow(10.0, fabs(damp_heading));
90 _offset_m.x() = x_offset_m;
91 _offset_m.y() = y_offset_m;
92 _offset_m.z() = z_offset_m;
93 _heading_offset_deg = heading_offset_deg;
94 _pitch_offset_deg = pitch_offset_deg;
95 _roll_offset_deg = roll_offset_deg;
96 _goal_heading_offset_deg = heading_offset_deg;
97 _goal_pitch_offset_deg = pitch_offset_deg;
98 _goal_roll_offset_deg = roll_offset_deg;
105 _aspect_ratio_multiplier = aspect_ratio_multiplier;
106 _target_offset_m.x() = target_x_offset_m;
107 _target_offset_m.y() = target_y_offset_m;
108 _target_offset_m.z() = target_z_offset_m;
109 _ground_level_nearplane_m = near_m;
110 // a reasonable guess for init, so that the math doesn't blow up
115 FGViewer::~FGViewer( void ) {
134 FGViewer::setType ( int type )
143 FGViewer::setInternal ( bool internal )
145 _internal = internal;
149 FGViewer::setPosition (double lon_deg, double lat_deg, double alt_ft)
152 _position = SGGeod::fromDegFt(lon_deg, lat_deg, alt_ft);
156 FGViewer::setTargetPosition (double lon_deg, double lat_deg, double alt_ft)
159 _target = SGGeod::fromDegFt(lon_deg, lat_deg, alt_ft);
163 FGViewer::setRoll_deg (double roll_deg)
166 _roll_deg = roll_deg;
170 FGViewer::setPitch_deg (double pitch_deg)
173 _pitch_deg = pitch_deg;
177 FGViewer::setHeading_deg (double heading_deg)
180 _heading_deg = heading_deg;
184 FGViewer::setOrientation (double roll_deg, double pitch_deg, double heading_deg)
187 _roll_deg = roll_deg;
188 _pitch_deg = pitch_deg;
189 _heading_deg = heading_deg;
193 FGViewer::setTargetRoll_deg (double target_roll_deg)
196 _target_roll_deg = target_roll_deg;
200 FGViewer::setTargetPitch_deg (double target_pitch_deg)
203 _target_pitch_deg = target_pitch_deg;
207 FGViewer::setTargetHeading_deg (double target_heading_deg)
210 _target_heading_deg = target_heading_deg;
214 FGViewer::setTargetOrientation (double target_roll_deg, double target_pitch_deg, double target_heading_deg)
217 _target_roll_deg = target_roll_deg;
218 _target_pitch_deg = target_pitch_deg;
219 _target_heading_deg = target_heading_deg;
223 FGViewer::setXOffset_m (double x_offset_m)
226 _offset_m.x() = x_offset_m;
230 FGViewer::setYOffset_m (double y_offset_m)
233 _offset_m.y() = y_offset_m;
237 FGViewer::setZOffset_m (double z_offset_m)
240 _offset_m.z() = z_offset_m;
244 FGViewer::setTargetXOffset_m (double target_x_offset_m)
247 _target_offset_m.x() = target_x_offset_m;
251 FGViewer::setTargetYOffset_m (double target_y_offset_m)
254 _target_offset_m.y() = target_y_offset_m;
258 FGViewer::setTargetZOffset_m (double target_z_offset_m)
261 _target_offset_m.z() = target_z_offset_m;
265 FGViewer::setPositionOffsets (double x_offset_m, double y_offset_m, double z_offset_m)
268 _offset_m.x() = x_offset_m;
269 _offset_m.y() = y_offset_m;
270 _offset_m.z() = z_offset_m;
274 FGViewer::setRollOffset_deg (double roll_offset_deg)
277 _roll_offset_deg = roll_offset_deg;
281 FGViewer::setPitchOffset_deg (double pitch_offset_deg)
284 _pitch_offset_deg = pitch_offset_deg;
288 FGViewer::setHeadingOffset_deg (double heading_offset_deg)
291 if (_at_model && (_offset_m.x() == 0.0)&&(_offset_m.z() == 0.0))
293 /* avoid optical effects (e.g. rotating sky) when "looking at" with
294 * heading offsets x==z==0 (view heading cannot change). */
295 _heading_offset_deg = 0.0;
298 _heading_offset_deg = heading_offset_deg;
302 FGViewer::setGoalRollOffset_deg (double goal_roll_offset_deg)
305 _goal_roll_offset_deg = goal_roll_offset_deg;
309 FGViewer::setGoalPitchOffset_deg (double goal_pitch_offset_deg)
312 _goal_pitch_offset_deg = goal_pitch_offset_deg;
313 if ( _goal_pitch_offset_deg < -90 ) {
314 _goal_pitch_offset_deg = -90.0;
316 if ( _goal_pitch_offset_deg > 90.0 ) {
317 _goal_pitch_offset_deg = 90.0;
323 FGViewer::setGoalHeadingOffset_deg (double goal_heading_offset_deg)
326 if (_at_model && (_offset_m.x() == 0.0)&&(_offset_m.z() == 0.0))
328 /* avoid optical effects (e.g. rotating sky) when "looking at" with
329 * heading offsets x==z==0 (view heading cannot change). */
330 _goal_heading_offset_deg = 0.0;
334 _goal_heading_offset_deg = goal_heading_offset_deg;
335 while ( _goal_heading_offset_deg < 0.0 ) {
336 _goal_heading_offset_deg += 360;
338 while ( _goal_heading_offset_deg > 360 ) {
339 _goal_heading_offset_deg -= 360;
344 FGViewer::setOrientationOffsets (double roll_offset_deg, double pitch_offset_deg, double heading_offset_deg)
347 _roll_offset_deg = roll_offset_deg;
348 _pitch_offset_deg = pitch_offset_deg;
349 _heading_offset_deg = heading_offset_deg;
352 // recalc() is done every time one of the setters is called (making the
353 // cached data "dirty") on the next "get". It calculates all the outputs
358 if (_type == FG_LOOKFROM) {
367 // recalculate for LookFrom view type...
369 FGViewer::recalcLookFrom ()
371 // Update location data ...
373 SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
374 _position = placement->getPosition();
376 _heading_deg = placement->getHeadingDeg();
377 _pitch_deg = placement->getPitchDeg();
378 _roll_deg = placement->getRollDeg();
381 double head = _heading_deg;
382 double pitch = _pitch_deg;
383 double roll = _roll_deg;
384 if ( !_from_model ) {
385 // update from our own data...
386 setDampTarget(roll, pitch, head);
387 getDampOutput(roll, pitch, head);
390 // The rotation rotating from the earth centerd frame to
391 // the horizontal local frame
392 SGQuatd hlOr = SGQuatd::fromLonLat(_position);
394 // The rotation from the horizontal local frame to the basic view orientation
395 SGQuatd hlToBody = SGQuatd::fromYawPitchRollDeg(head, pitch, roll);
397 // The rotation offset, don't know why heading is negative here ...
399 = SGQuatd::fromYawPitchRollDeg(-_heading_offset_deg, _pitch_offset_deg,
402 // Compute the eyepoints orientation and position
403 // wrt the earth centered frame - that is global coorinates
404 SGQuatd ec2body = hlOr*hlToBody;
406 // The cartesian position of the basic view coordinate
407 SGVec3d position = SGVec3d::fromGeod(_position);
409 // This is rotates the x-forward, y-right, z-down coordinate system the where
410 // simulation runs into the OpenGL camera system with x-right, y-up, z-back.
411 SGQuatd q(-0.5, -0.5, 0.5, 0.5);
413 _absolute_view_pos = position + (ec2body*q).backTransform(_offset_m);
414 mViewOrientation = ec2body*mViewOffsetOr*q;
418 FGViewer::recalcLookAt ()
420 // The geodetic position of our target to look at
422 SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
423 _target = placement->getPosition();
424 _target_heading_deg = placement->getHeadingDeg();
425 _target_pitch_deg = placement->getPitchDeg();
426 _target_roll_deg = placement->getRollDeg();
428 // if not model then calculate our own target position...
429 setDampTarget(_target_roll_deg, _target_pitch_deg, _target_heading_deg);
430 getDampOutput(_target_roll_deg, _target_pitch_deg, _target_heading_deg);
433 SGQuatd geodTargetOr = SGQuatd::fromYawPitchRollDeg(_target_heading_deg,
436 SGQuatd geodTargetHlOr = SGQuatd::fromLonLat(_target);
440 SGModelPlacement* placement = globals->get_aircraft_model()->get3DModel();
441 _position = placement->getPosition();
442 _heading_deg = placement->getHeadingDeg();
443 _pitch_deg = placement->getPitchDeg();
444 _roll_deg = placement->getRollDeg();
446 // update from our own data, just the rotation here...
447 setDampTarget(_roll_deg, _pitch_deg, _heading_deg);
448 getDampOutput(_roll_deg, _pitch_deg, _heading_deg);
450 SGQuatd geodEyeOr = SGQuatd::fromYawPitchRollDeg(_heading_deg, _pitch_deg, _roll_deg);
451 SGQuatd geodEyeHlOr = SGQuatd::fromLonLat(_position);
453 // the rotation offset, don't know why heading is negative here ...
455 SGQuatd::fromYawPitchRollDeg(-_heading_offset_deg + 180, _pitch_offset_deg,
458 // Offsets to the eye position
459 SGVec3d eyeOff(-_offset_m.z(), _offset_m.x(), -_offset_m.y());
460 SGQuatd ec2eye = geodEyeHlOr*geodEyeOr;
461 SGVec3d eyeCart = SGVec3d::fromGeod(_position);
462 eyeCart += (ec2eye*mViewOffsetOr).backTransform(eyeOff);
464 SGVec3d atCart = SGVec3d::fromGeod(_target);
466 // add target offsets to at_position...
467 SGVec3d target_pos_off(-_target_offset_m.z(), _target_offset_m.x(),
468 -_target_offset_m.y());
469 target_pos_off = (geodTargetHlOr*geodTargetOr).backTransform(target_pos_off);
470 atCart += target_pos_off;
471 eyeCart += target_pos_off;
473 // Compute the eyepoints orientation and position
474 // wrt the earth centered frame - that is global coorinates
475 _absolute_view_pos = eyeCart;
477 // the view direction
478 SGVec3d dir = normalize(atCart - eyeCart);
480 SGVec3d up = ec2eye.backTransform(SGVec3d(0, 0, -1));
481 // rotate -dir to the 2-th unit vector
482 // rotate up to 1-th unit vector
483 // Note that this matches the OpenGL camera coordinate system
484 // with x-right, y-up, z-back.
485 mViewOrientation = SGQuatd::fromRotateTo(-dir, 2, up, 1);
489 FGViewer::setDampTarget(double roll, double pitch, double heading)
491 _dampTarget = SGVec3d(roll, pitch, heading);
495 FGViewer::getDampOutput(double& roll, double& pitch, double& heading)
497 roll = _dampOutput[0];
498 pitch = _dampOutput[1];
499 heading = _dampOutput[2];
504 FGViewer::updateDampOutput(double dt)
506 static FGViewer *last_view = 0;
507 if ((last_view != this) || (dt > 1.0)) {
508 _dampOutput = _dampTarget;
513 const double interval = 0.01;
514 while (dt > interval) {
516 for (unsigned int i=0; i<3; ++i) {
517 if (_dampFactor[i] <= 0.0) {
518 // axis is un-damped, set output to target directly
519 _dampOutput[i] = _dampTarget[i];
523 double d = _dampOutput[i] - _dampTarget[i];
525 _dampOutput[i] -= 360.0;
526 } else if (d < -180.0) {
527 _dampOutput[i] += 360.0;
530 _dampOutput[i] = (_dampTarget[i] * _dampFactor[i]) +
531 (_dampOutput[i] * (1.0 - _dampFactor[i]));
532 } // of axis iteration
535 } // of dt subdivision by interval
539 FGViewer::get_h_fov()
541 double aspectRatio = _cameraGroup->getMasterAspectRatio();
542 switch (_scaling_type) {
543 case FG_SCALING_WIDTH: // h_fov == fov
546 if (aspectRatio < 1.0) {
552 atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
553 / (aspectRatio*_aspect_ratio_multiplier))
554 * SG_RADIANS_TO_DEGREES * 2;
565 FGViewer::get_v_fov()
567 double aspectRatio = _cameraGroup->getMasterAspectRatio();
568 switch (_scaling_type) {
569 case FG_SCALING_WIDTH: // h_fov == fov
571 atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
572 * (aspectRatio*_aspect_ratio_multiplier))
573 * SG_RADIANS_TO_DEGREES * 2;
575 if (aspectRatio < 1.0) {
578 atan(tan(_fov_deg/2 * SG_DEGREES_TO_RADIANS)
579 * (aspectRatio*_aspect_ratio_multiplier))
580 * SG_RADIANS_TO_DEGREES * 2;
592 FGViewer::update (double dt)
594 updateDampOutput(dt);
597 int dt_ms = int(dt * 1000);
598 for ( i = 0; i < dt_ms; i++ ) {
599 if ( fabs( _goal_heading_offset_deg - _heading_offset_deg) < 1 ) {
600 setHeadingOffset_deg( _goal_heading_offset_deg );
603 // move current_view.headingoffset towards
604 // current_view.goal_view_offset
605 if ( _goal_heading_offset_deg > _heading_offset_deg )
607 if ( _goal_heading_offset_deg - _heading_offset_deg < 180 ){
608 incHeadingOffset_deg( 0.5 );
610 incHeadingOffset_deg( -0.5 );
613 if ( _heading_offset_deg - _goal_heading_offset_deg < 180 ){
614 incHeadingOffset_deg( -0.5 );
616 incHeadingOffset_deg( 0.5 );
619 if ( _heading_offset_deg > 360 ) {
620 incHeadingOffset_deg( -360 );
621 } else if ( _heading_offset_deg < 0 ) {
622 incHeadingOffset_deg( 360 );
627 for ( i = 0; i < dt_ms; i++ ) {
628 if ( fabs( _goal_pitch_offset_deg - _pitch_offset_deg ) < 1 ) {
629 setPitchOffset_deg( _goal_pitch_offset_deg );
632 // move current_view.pitch_offset_deg towards
633 // current_view.goal_pitch_offset
634 if ( _goal_pitch_offset_deg > _pitch_offset_deg )
636 incPitchOffset_deg( 1.0 );
638 incPitchOffset_deg( -1.0 );
640 if ( _pitch_offset_deg > 90 ) {
641 setPitchOffset_deg(90);
642 } else if ( _pitch_offset_deg < -90 ) {
643 setPitchOffset_deg( -90 );
649 for ( i = 0; i < dt_ms; i++ ) {
650 if ( fabs( _goal_roll_offset_deg - _roll_offset_deg ) < 1 ) {
651 setRollOffset_deg( _goal_roll_offset_deg );
654 // move current_view.roll_offset_deg towards
655 // current_view.goal_roll_offset
656 if ( _goal_roll_offset_deg > _roll_offset_deg )
658 incRollOffset_deg( 1.0 );
660 incRollOffset_deg( -1.0 );
662 if ( _roll_offset_deg > 90 ) {
663 setRollOffset_deg(90);
664 } else if ( _roll_offset_deg < -90 ) {
665 setRollOffset_deg( -90 );
670 if( fgGetBool( "/sim/rendering/draw-otw", true ) ) {
671 _cameraGroup->update(toOsg(_absolute_view_pos), toOsg(mViewOrientation));
672 _cameraGroup->setCameraParameters(get_v_fov(), get_aspect_ratio());
676 double FGViewer::get_aspect_ratio() const
678 return _cameraGroup->getMasterAspectRatio();