1 // viewmgr.cxx -- class for managing all the views in the flightgear world.
3 // Written by Curtis Olson, started October 2000.
4 // partially rewritten by Jim Wilson March 2002
6 // Copyright (C) 2000 Curtis L. Olson - http://www.flightgear.org/~curt
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 #include "viewmgr.hxx"
30 #include <string.h> // strcmp
32 #include <simgear/compiler.h>
33 #include <simgear/sound/soundmgr_openal.hxx>
34 #include <Model/acmodel.hxx>
35 #include <Main/viewer.hxx>
36 #include <Main/fg_props.hxx>
39 FGViewMgr::FGViewMgr( void ) :
42 view_number(fgGetNode("/sim/current-view/view-number", true)),
43 config_list(fgGetNode("/sim", true)->getChildren("view")),
46 smgr = (SGSoundMgr *)globals->get_subsystem("soundmgr");
50 FGViewMgr::~FGViewMgr( void ) {
56 double aspect_ratio_multiplier
57 = fgGetDouble("/sim/current-view/aspect-ratio-multiplier");
59 for (unsigned int i = 0; i < config_list.size(); i++) {
60 SGPropertyNode *n = config_list[i];
62 // find out if this is an internal view (e.g. in cockpit, low near plane)
63 bool internal = n->getBoolValue("internal", false);
66 // this is assumed to be an aircraft model...we will need to read
67 // model-from-type as well.
69 // find out if this is a model we are looking from...
70 bool from_model = n->getBoolValue("config/from-model");
71 int from_model_index = n->getIntValue("config/from-model-idx");
73 double x_offset_m = n->getDoubleValue("config/x-offset-m");
74 double y_offset_m = n->getDoubleValue("config/y-offset-m");
75 double z_offset_m = n->getDoubleValue("config/z-offset-m");
77 double heading_offset_deg = n->getDoubleValue("config/heading-offset-deg");
78 n->setDoubleValue("config/heading-offset-deg", heading_offset_deg);
79 double pitch_offset_deg = n->getDoubleValue("config/pitch-offset-deg");
80 n->setDoubleValue("config/pitch-offset-deg", pitch_offset_deg);
81 double roll_offset_deg = n->getDoubleValue("config/roll-offset-deg");
82 n->setDoubleValue("config/roll-offset-deg", roll_offset_deg);
84 double fov_deg = n->getDoubleValue("config/default-field-of-view-deg");
85 double near_m = n->getDoubleValue("config/ground-level-nearplane-m");
87 // supporting two types "lookat" = 1 and "lookfrom" = 0
88 const char *type = n->getStringValue("type");
89 if (!strcmp(type, "lookat")) {
91 bool at_model = n->getBoolValue("config/at-model");
92 int at_model_index = n->getIntValue("config/at-model-idx");
94 double damp_roll = n->getDoubleValue("config/at-model-roll-damping");
95 double damp_pitch = n->getDoubleValue("config/at-model-pitch-damping");
96 double damp_heading = n->getDoubleValue("config/at-model-heading-damping");
98 double target_x_offset_m = n->getDoubleValue("config/target-x-offset-m");
99 double target_y_offset_m = n->getDoubleValue("config/target-y-offset-m");
100 double target_z_offset_m = n->getDoubleValue("config/target-z-offset-m");
102 add_view(new FGViewer ( FG_LOOKAT, from_model, from_model_index,
103 at_model, at_model_index,
104 damp_roll, damp_pitch, damp_heading,
105 x_offset_m, y_offset_m,z_offset_m,
106 heading_offset_deg, pitch_offset_deg,
107 roll_offset_deg, fov_deg, aspect_ratio_multiplier,
108 target_x_offset_m, target_y_offset_m,
109 target_z_offset_m, near_m, internal ));
111 add_view(new FGViewer ( FG_LOOKFROM, from_model, from_model_index,
112 false, 0, 0.0, 0.0, 0.0,
113 x_offset_m, y_offset_m, z_offset_m,
114 heading_offset_deg, pitch_offset_deg,
115 roll_offset_deg, fov_deg, aspect_ratio_multiplier,
116 0, 0, 0, near_m, internal ));
126 // reset offsets and fov to configuration defaults
127 for (unsigned int i = 0; i < config_list.size(); i++) {
128 SGPropertyNode *n = config_list[i];
131 fgSetDouble("/sim/current-view/x-offset-m",
132 n->getDoubleValue("config/x-offset-m"));
133 fgSetDouble("/sim/current-view/y-offset-m",
134 n->getDoubleValue("config/y-offset-m"));
135 fgSetDouble("/sim/current-view/z-offset-m",
136 n->getDoubleValue("config/z-offset-m"));
137 fgSetDouble("/sim/current-view/pitch-offset-deg",
138 n->getDoubleValue("config/pitch-offset-deg"));
139 fgSetDouble("/sim/current-view/heading-offset-deg",
140 n->getDoubleValue("config/heading-offset-deg"));
141 fgSetDouble("/sim/current-view/roll-offset-deg",
142 n->getDoubleValue("config/roll-offset-deg"));
144 double fov_deg = n->getDoubleValue("config/default-field-of-view-deg");
147 fgSetDouble("/sim/current-view/field-of-view", fov_deg);
149 // target offsets for lookat mode only...
150 fgSetDouble("/sim/current-view/target-x-offset-m",
151 n->getDoubleValue("config/target-x-offset-m"));
152 fgSetDouble("/sim/current-view/target-y-offset-m",
153 n->getDoubleValue("config/target-y-offset-m"));
154 fgSetDouble("/sim/current-view/target-z-offset-m",
155 n->getDoubleValue("config/target-z-offset-m"));
160 typedef double (FGViewMgr::*double_getter)() const;
165 // these are bound to the current view properties
166 fgTie("/sim/current-view/heading-offset-deg", this,
167 &FGViewMgr::getViewHeadingOffset_deg,
168 &FGViewMgr::setViewHeadingOffset_deg);
169 fgSetArchivable("/sim/current-view/heading-offset-deg");
170 fgTie("/sim/current-view/goal-heading-offset-deg", this,
171 &FGViewMgr::getViewGoalHeadingOffset_deg,
172 &FGViewMgr::setViewGoalHeadingOffset_deg);
173 fgSetArchivable("/sim/current-view/goal-heading-offset-deg");
174 fgTie("/sim/current-view/pitch-offset-deg", this,
175 &FGViewMgr::getViewPitchOffset_deg,
176 &FGViewMgr::setViewPitchOffset_deg);
177 fgSetArchivable("/sim/current-view/pitch-offset-deg");
178 fgTie("/sim/current-view/goal-pitch-offset-deg", this,
179 &FGViewMgr::getGoalViewPitchOffset_deg,
180 &FGViewMgr::setGoalViewPitchOffset_deg);
181 fgSetArchivable("/sim/current-view/goal-pitch-offset-deg");
182 fgTie("/sim/current-view/roll-offset-deg", this,
183 &FGViewMgr::getViewRollOffset_deg,
184 &FGViewMgr::setViewRollOffset_deg);
185 fgSetArchivable("/sim/current-view/roll-offset-deg");
186 fgTie("/sim/current-view/goal-roll-offset-deg", this,
187 &FGViewMgr::getGoalViewRollOffset_deg,
188 &FGViewMgr::setGoalViewRollOffset_deg);
189 fgSetArchivable("/sim/current-view/goal-roll-offset-deg");
191 fgTie("/sim/current-view/view-number", this,
192 &FGViewMgr::getView, &FGViewMgr::setView);
193 fgSetArchivable("/sim/current-view/view-number", FALSE);
195 fgTie("/sim/current-view/axes/long", this,
196 (double_getter)0, &FGViewMgr::setViewAxisLong);
197 fgSetArchivable("/sim/current-view/axes/long");
199 fgTie("/sim/current-view/axes/lat", this,
200 (double_getter)0, &FGViewMgr::setViewAxisLat);
201 fgSetArchivable("/sim/current-view/axes/lat");
203 fgTie("/sim/current-view/field-of-view", this,
204 &FGViewMgr::getFOV_deg, &FGViewMgr::setFOV_deg);
205 fgSetArchivable("/sim/current-view/field-of-view");
207 fgTie("/sim/current-view/aspect-ratio-multiplier", this,
208 &FGViewMgr::getARM_deg, &FGViewMgr::setARM_deg);
209 fgSetArchivable("/sim/current-view/field-of-view");
211 fgTie("/sim/current-view/ground-level-nearplane-m", this,
212 &FGViewMgr::getNear_m, &FGViewMgr::setNear_m);
213 fgSetArchivable("/sim/current-view/ground-level-nearplane-m");
215 SGPropertyNode *n = fgGetNode("/sim/current-view", true);
216 n->tie("viewer-x-m", SGRawValuePointer<double>(&abs_viewer_position[0]));
217 n->tie("viewer-y-m", SGRawValuePointer<double>(&abs_viewer_position[1]));
218 n->tie("viewer-z-m", SGRawValuePointer<double>(&abs_viewer_position[2]));
225 // need to redo these bindings to the new locations (move to viewer?)
226 fgUntie("/sim/current-view/heading-offset-deg");
227 fgUntie("/sim/current-view/goal-heading-offset-deg");
228 fgUntie("/sim/current-view/pitch-offset-deg");
229 fgUntie("/sim/current-view/goal-pitch-offset-deg");
230 fgUntie("/sim/current-view/field-of-view");
231 fgUntie("/sim/current-view/aspect-ratio-multiplier");
232 fgUntie("/sim/current-view/view-number");
233 fgUntie("/sim/current-view/axes/long");
234 fgUntie("/sim/current-view/axes/lat");
235 fgUntie("/sim/current-view/ground-level-nearplane-m");
236 fgUntie("/sim/current-view/viewer-x-m");
237 fgUntie("/sim/current-view/viewer-y-m");
238 fgUntie("/sim/current-view/viewer-z-m");
242 FGViewMgr::update (double dt)
244 FGViewer * view = get_current_view();
248 FGViewer *loop_view = (FGViewer *)get_view(current);
249 SGPropertyNode *n = config_list[current];
250 double lon_deg, lat_deg, alt_ft, roll_deg, pitch_deg, heading_deg;
251 SGVec3f velocity = SGVec3f(0,0,0);
253 // Set up view location and orientation
255 if (!n->getBoolValue("config/from-model")) {
256 lon_deg = fgGetDouble(n->getStringValue("config/eye-lon-deg-path"));
257 lat_deg = fgGetDouble(n->getStringValue("config/eye-lat-deg-path"));
258 alt_ft = fgGetDouble(n->getStringValue("config/eye-alt-ft-path"));
259 roll_deg = fgGetDouble(n->getStringValue("config/eye-roll-deg-path"));
260 pitch_deg = fgGetDouble(n->getStringValue("config/eye-pitch-deg-path"));
261 heading_deg = fgGetDouble(n->getStringValue("config/eye-heading-deg-path"));
263 loop_view->setPosition(lon_deg, lat_deg, alt_ft);
264 loop_view->setOrientation(roll_deg, pitch_deg, heading_deg);
266 // force recalc in viewer
267 loop_view->set_dirty();
269 // get the model velocity for the in-cockpit view
270 FGAircraftModel *aircraft = globals->get_aircraft_model();
271 velocity = aircraft->getVelocity();
274 // if lookat (type 1) then get target data...
275 if (loop_view->getType() == FG_LOOKAT) {
276 if (!n->getBoolValue("config/from-model")) {
277 lon_deg = fgGetDouble(n->getStringValue("config/target-lon-deg-path"));
278 lat_deg = fgGetDouble(n->getStringValue("config/target-lat-deg-path"));
279 alt_ft = fgGetDouble(n->getStringValue("config/target-alt-ft-path"));
280 roll_deg = fgGetDouble(n->getStringValue("config/target-roll-deg-path"));
281 pitch_deg = fgGetDouble(n->getStringValue("config/target-pitch-deg-path"));
282 heading_deg = fgGetDouble(n->getStringValue("config/target-heading-deg-path"));
284 loop_view->setTargetPosition(lon_deg, lat_deg, alt_ft);
285 loop_view->setTargetOrientation(roll_deg, pitch_deg, heading_deg);
287 loop_view->set_dirty();
291 setViewXOffset_m(fgGetDouble("/sim/current-view/x-offset-m"));
292 setViewYOffset_m(fgGetDouble("/sim/current-view/y-offset-m"));
293 setViewZOffset_m(fgGetDouble("/sim/current-view/z-offset-m"));
295 setViewTargetXOffset_m(fgGetDouble("/sim/current-view/target-x-offset-m"));
296 setViewTargetYOffset_m(fgGetDouble("/sim/current-view/target-y-offset-m"));
297 setViewTargetZOffset_m(fgGetDouble("/sim/current-view/target-z-offset-m"));
299 // Update the current view
302 abs_viewer_position = loop_view->getViewPosition();
304 // update audio listener values
305 // set the viewer posotion in Cartesian coordinates in meters
306 smgr->set_position(abs_viewer_position);
307 smgr->set_orientation(loop_view->getViewOrientation());
308 smgr->set_velocity(velocity);
312 FGViewMgr::copyToCurrent()
314 SGPropertyNode *n = config_list[current];
315 fgSetString("/sim/current-view/name", n->getStringValue("name"));
316 fgSetString("/sim/current-view/type", n->getStringValue("type"));
318 // copy certain view config data for default values
319 fgSetDouble("/sim/current-view/config/heading-offset-deg",
320 n->getDoubleValue("config/default-heading-offset-deg"));
321 fgSetDouble("/sim/current-view/config/pitch-offset-deg",
322 n->getDoubleValue("config/pitch-offset-deg"));
323 fgSetDouble("/sim/current-view/config/roll-offset-deg",
324 n->getDoubleValue("config/roll-offset-deg"));
325 fgSetDouble("/sim/current-view/config/default-field-of-view-deg",
326 n->getDoubleValue("config/default-field-of-view-deg"));
327 fgSetBool("/sim/current-view/config/from-model",
328 n->getBoolValue("config/from-model"));
331 fgSetDouble("/sim/current-view/x-offset-m", getViewXOffset_m());
332 fgSetDouble("/sim/current-view/y-offset-m", getViewYOffset_m());
333 fgSetDouble("/sim/current-view/z-offset-m", getViewZOffset_m());
335 fgSetDouble("/sim/current-view/goal-heading-offset-deg",
336 get_current_view()->getGoalHeadingOffset_deg());
337 fgSetDouble("/sim/current-view/goal-pitch-offset-deg",
338 get_current_view()->getGoalPitchOffset_deg());
339 fgSetDouble("/sim/current-view/goal-roll-offset-deg",
340 get_current_view()->getRollOffset_deg());
341 fgSetDouble("/sim/current-view/heading-offset-deg",
342 get_current_view()->getHeadingOffset_deg());
343 fgSetDouble("/sim/current-view/pitch-offset-deg",
344 get_current_view()->getPitchOffset_deg());
345 fgSetDouble("/sim/current-view/roll-offset-deg",
346 get_current_view()->getRollOffset_deg());
347 fgSetDouble("/sim/current-view/target-x-offset-m",
348 get_current_view()->getTargetXOffset_m());
349 fgSetDouble("/sim/current-view/target-y-offset-m",
350 get_current_view()->getTargetYOffset_m());
351 fgSetDouble("/sim/current-view/target-z-offset-m",
352 get_current_view()->getTargetZOffset_m());
353 fgSetBool("/sim/current-view/internal",
354 get_current_view()->getInternal());
357 void FGViewMgr::clear()
363 FGViewMgr::get_current_view()
365 if ( current < (int)views.size() ) {
366 return views[current];
373 FGViewMgr::get_current_view() const
375 if ( current < (int)views.size() ) {
376 return views[current];
384 FGViewMgr::get_view( int i )
386 if ( i < 0 ) { i = 0; }
387 if ( i >= (int)views.size() ) { i = views.size() - 1; }
392 FGViewMgr::get_view( int i ) const
394 if ( i < 0 ) { i = 0; }
395 if ( i >= (int)views.size() ) { i = views.size() - 1; }
400 FGViewMgr::next_view()
402 setView((current+1 < (int)views.size()) ? (current + 1) : 0);
403 view_number->fireValueChanged();
404 return views[current];
408 FGViewMgr::prev_view()
410 setView((0 < current) ? (current - 1) : (views.size() - 1));
411 view_number->fireValueChanged();
412 return views[current];
416 FGViewMgr::add_view( FGViewer * v )
423 FGViewMgr::getViewHeadingOffset_deg () const
425 const FGViewer * view = get_current_view();
426 return (view == 0 ? 0 : view->getHeadingOffset_deg());
430 FGViewMgr::setViewHeadingOffset_deg (double offset)
432 FGViewer * view = get_current_view();
434 view->setGoalHeadingOffset_deg(offset);
435 view->setHeadingOffset_deg(offset);
440 FGViewMgr::getViewGoalHeadingOffset_deg () const
442 const FGViewer * view = get_current_view();
443 return (view == 0 ? 0 : view->getGoalHeadingOffset_deg());
447 FGViewMgr::setViewGoalHeadingOffset_deg (double offset)
449 FGViewer * view = get_current_view();
451 view->setGoalHeadingOffset_deg(offset);
455 FGViewMgr::getViewPitchOffset_deg () const
457 const FGViewer * view = get_current_view();
458 return (view == 0 ? 0 : view->getPitchOffset_deg());
462 FGViewMgr::setViewPitchOffset_deg (double tilt)
464 FGViewer * view = get_current_view();
466 view->setGoalPitchOffset_deg(tilt);
467 view->setPitchOffset_deg(tilt);
472 FGViewMgr::getGoalViewPitchOffset_deg () const
474 const FGViewer * view = get_current_view();
475 return (view == 0 ? 0 : view->getGoalPitchOffset_deg());
479 FGViewMgr::setGoalViewPitchOffset_deg (double tilt)
481 FGViewer * view = get_current_view();
483 view->setGoalPitchOffset_deg(tilt);
487 FGViewMgr::getViewRollOffset_deg () const
489 const FGViewer * view = get_current_view();
490 return (view == 0 ? 0 : view->getRollOffset_deg());
494 FGViewMgr::setViewRollOffset_deg (double tilt)
496 FGViewer * view = get_current_view();
498 view->setGoalRollOffset_deg(tilt);
499 view->setRollOffset_deg(tilt);
504 FGViewMgr::getGoalViewRollOffset_deg () const
506 const FGViewer * view = get_current_view();
507 return (view == 0 ? 0 : view->getGoalRollOffset_deg());
511 FGViewMgr::setGoalViewRollOffset_deg (double tilt)
513 FGViewer * view = get_current_view();
515 view->setGoalRollOffset_deg(tilt);
519 FGViewMgr::getViewXOffset_m () const
521 const FGViewer * view = get_current_view();
523 return ((FGViewer *)view)->getXOffset_m();
530 FGViewMgr::setViewXOffset_m (double x)
532 FGViewer * view = get_current_view();
534 view->setXOffset_m(x);
539 FGViewMgr::getViewYOffset_m () const
541 const FGViewer * view = get_current_view();
543 return ((FGViewer *)view)->getYOffset_m();
550 FGViewMgr::setViewYOffset_m (double y)
552 FGViewer * view = get_current_view();
554 view->setYOffset_m(y);
559 FGViewMgr::getViewZOffset_m () const
561 const FGViewer * view = get_current_view();
563 return ((FGViewer *)view)->getZOffset_m();
570 FGViewMgr::setViewZOffset_m (double z)
572 FGViewer * view = get_current_view();
574 view->setZOffset_m(z);
579 FGViewMgr::getViewTargetXOffset_m () const
581 const FGViewer * view = get_current_view();
583 return ((FGViewer *)view)->getTargetXOffset_m();
590 FGViewMgr::setViewTargetXOffset_m (double x)
592 FGViewer * view = get_current_view();
594 view->setTargetXOffset_m(x);
599 FGViewMgr::getViewTargetYOffset_m () const
601 const FGViewer * view = get_current_view();
603 return ((FGViewer *)view)->getTargetYOffset_m();
610 FGViewMgr::setViewTargetYOffset_m (double y)
612 FGViewer * view = get_current_view();
614 view->setTargetYOffset_m(y);
619 FGViewMgr::getViewTargetZOffset_m () const
621 const FGViewer * view = get_current_view();
623 return ((FGViewer *)view)->getTargetZOffset_m();
630 FGViewMgr::setViewTargetZOffset_m (double z)
632 FGViewer * view = get_current_view();
634 view->setTargetZOffset_m(z);
639 FGViewMgr::getView () const
645 FGViewMgr::setView (int newview)
647 // negative numbers -> set view with node index -newview
649 for (int i = 0; i < (int)config_list.size(); i++) {
650 int index = -config_list[i]->getIndex();
651 if (index == newview)
658 // if newview number too low wrap to last view...
660 newview = (int)views.size() - 1;
662 // if newview number to high wrap to zero...
663 if (newview >= (int)views.size())
671 // Copy the fdm's position into the SGLocation which is shared with
673 globals->get_aircraft_model()->update(0);
680 FGViewMgr::getFOV_deg () const
682 const FGViewer * view = get_current_view();
683 return (view == 0 ? 0 : view->get_fov());
687 FGViewMgr::setFOV_deg (double fov)
689 FGViewer * view = get_current_view();
695 FGViewMgr::getARM_deg () const
697 const FGViewer * view = get_current_view();
698 return (view == 0 ? 0 : view->get_aspect_ratio_multiplier());
702 FGViewMgr::setARM_deg (double aspect_ratio_multiplier)
704 FGViewer * view = get_current_view();
706 view->set_aspect_ratio_multiplier(aspect_ratio_multiplier);
710 FGViewMgr::getNear_m () const
712 const FGViewer * view = get_current_view();
713 return (view == 0 ? 0.5f : view->getNear_m());
717 FGViewMgr::setNear_m (double near_m)
719 FGViewer * view = get_current_view();
721 view->setNear_m(near_m);
725 FGViewMgr::setViewAxisLong (double axis)
731 FGViewMgr::setViewAxisLat (double axis)
737 FGViewMgr::do_axes ()
739 // Take no action when hat is centered
740 if ( ( axis_long < 0.01 ) &&
741 ( axis_long > -0.01 ) &&
742 ( axis_lat < 0.01 ) &&
747 double viewDir = 999;
749 /* Do all the quick and easy cases */
750 if (axis_long < 0) { // Longitudinal axis forward
751 if (axis_lat == axis_long)
752 viewDir = fgGetDouble("/sim/view/config/front-left-direction-deg");
753 else if (axis_lat == - axis_long)
754 viewDir = fgGetDouble("/sim/view/config/front-right-direction-deg");
755 else if (axis_lat == 0)
756 viewDir = fgGetDouble("/sim/view/config/front-direction-deg");
757 } else if (axis_long > 0) { // Longitudinal axis backward
758 if (axis_lat == - axis_long)
759 viewDir = fgGetDouble("/sim/view/config/back-left-direction-deg");
760 else if (axis_lat == axis_long)
761 viewDir = fgGetDouble("/sim/view/config/back-right-direction-deg");
762 else if (axis_lat == 0)
763 viewDir = fgGetDouble("/sim/view/config/back-direction-deg");
764 } else if (axis_long == 0) { // Longitudinal axis neutral
766 viewDir = fgGetDouble("/sim/view/config/left-direction-deg");
767 else if (axis_lat > 0)
768 viewDir = fgGetDouble("/sim/view/config/right-direction-deg");
769 else return; /* And assertion failure maybe? */
772 // Do all the difficult cases
774 viewDir = SGD_RADIANS_TO_DEGREES * atan2 ( -axis_lat, -axis_long );
775 if ( viewDir < -1 ) viewDir += 360;
777 get_current_view()->setGoalHeadingOffset_deg(viewDir);