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 <Model/acmodel.hxx>
34 #include <Main/viewer.hxx>
35 #include <Main/fg_props.hxx>
38 FGViewMgr::FGViewMgr( void ) :
41 view_number(fgGetNode("/sim/current-view/view-number", true)),
42 config_list(fgGetNode("/sim", true)->getChildren("view")),
48 FGViewMgr::~FGViewMgr( void ) {
54 double aspect_ratio_multiplier
55 = fgGetDouble("/sim/current-view/aspect-ratio-multiplier");
57 for (unsigned int i = 0; i < config_list.size(); i++) {
58 SGPropertyNode *n = config_list[i];
60 // find out if this is an internal view (e.g. in cockpit, low near plane)
61 bool internal = n->getBoolValue("internal", false);
64 // this is assumed to be an aircraft model...we will need to read
65 // model-from-type as well.
67 // find out if this is a model we are looking from...
68 bool from_model = n->getBoolValue("config/from-model");
69 int from_model_index = n->getIntValue("config/from-model-idx");
71 double x_offset_m = n->getDoubleValue("config/x-offset-m");
72 double y_offset_m = n->getDoubleValue("config/y-offset-m");
73 double z_offset_m = n->getDoubleValue("config/z-offset-m");
75 double heading_offset_deg = n->getDoubleValue("config/heading-offset-deg");
76 n->setDoubleValue("config/heading-offset-deg", heading_offset_deg);
77 double pitch_offset_deg = n->getDoubleValue("config/pitch-offset-deg");
78 n->setDoubleValue("config/pitch-offset-deg", pitch_offset_deg);
79 double roll_offset_deg = n->getDoubleValue("config/roll-offset-deg");
80 n->setDoubleValue("config/roll-offset-deg", roll_offset_deg);
82 double fov_deg = n->getDoubleValue("config/default-field-of-view-deg");
83 double near_m = n->getDoubleValue("config/ground-level-nearplane-m");
85 // supporting two types "lookat" = 1 and "lookfrom" = 0
86 const char *type = n->getStringValue("type");
87 if (!strcmp(type, "lookat")) {
89 bool at_model = n->getBoolValue("config/at-model");
90 int at_model_index = n->getIntValue("config/at-model-idx");
92 double damp_roll = n->getDoubleValue("config/at-model-roll-damping");
93 double damp_pitch = n->getDoubleValue("config/at-model-pitch-damping");
94 double damp_heading = n->getDoubleValue("config/at-model-heading-damping");
96 double target_x_offset_m = n->getDoubleValue("config/target-x-offset-m");
97 double target_y_offset_m = n->getDoubleValue("config/target-y-offset-m");
98 double target_z_offset_m = n->getDoubleValue("config/target-z-offset-m");
100 add_view(new FGViewer ( FG_LOOKAT, from_model, from_model_index,
101 at_model, at_model_index,
102 damp_roll, damp_pitch, damp_heading,
103 x_offset_m, y_offset_m,z_offset_m,
104 heading_offset_deg, pitch_offset_deg,
105 roll_offset_deg, fov_deg, aspect_ratio_multiplier,
106 target_x_offset_m, target_y_offset_m,
107 target_z_offset_m, near_m, internal ));
109 add_view(new FGViewer ( FG_LOOKFROM, from_model, from_model_index,
110 false, 0, 0.0, 0.0, 0.0,
111 x_offset_m, y_offset_m, z_offset_m,
112 heading_offset_deg, pitch_offset_deg,
113 roll_offset_deg, fov_deg, aspect_ratio_multiplier,
114 0, 0, 0, near_m, internal ));
124 // reset offsets and fov to configuration defaults
125 for (unsigned int i = 0; i < config_list.size(); i++) {
126 SGPropertyNode *n = config_list[i];
129 fgSetDouble("/sim/current-view/x-offset-m",
130 n->getDoubleValue("config/x-offset-m"));
131 fgSetDouble("/sim/current-view/y-offset-m",
132 n->getDoubleValue("config/y-offset-m"));
133 fgSetDouble("/sim/current-view/z-offset-m",
134 n->getDoubleValue("config/z-offset-m"));
135 fgSetDouble("/sim/current-view/pitch-offset-deg",
136 n->getDoubleValue("config/pitch-offset-deg"));
137 fgSetDouble("/sim/current-view/heading-offset-deg",
138 n->getDoubleValue("config/heading-offset-deg"));
139 fgSetDouble("/sim/current-view/roll-offset-deg",
140 n->getDoubleValue("config/roll-offset-deg"));
142 double fov_deg = n->getDoubleValue("config/default-field-of-view-deg");
145 fgSetDouble("/sim/current-view/field-of-view", fov_deg);
147 // target offsets for lookat mode only...
148 fgSetDouble("/sim/current-view/target-x-offset-m",
149 n->getDoubleValue("config/target-x-offset-m"));
150 fgSetDouble("/sim/current-view/target-y-offset-m",
151 n->getDoubleValue("config/target-y-offset-m"));
152 fgSetDouble("/sim/current-view/target-z-offset-m",
153 n->getDoubleValue("config/target-z-offset-m"));
158 typedef double (FGViewMgr::*double_getter)() const;
163 // these are bound to the current view properties
164 fgTie("/sim/current-view/heading-offset-deg", this,
165 &FGViewMgr::getViewHeadingOffset_deg,
166 &FGViewMgr::setViewHeadingOffset_deg);
167 fgSetArchivable("/sim/current-view/heading-offset-deg");
168 fgTie("/sim/current-view/goal-heading-offset-deg", this,
169 &FGViewMgr::getViewGoalHeadingOffset_deg,
170 &FGViewMgr::setViewGoalHeadingOffset_deg);
171 fgSetArchivable("/sim/current-view/goal-heading-offset-deg");
172 fgTie("/sim/current-view/pitch-offset-deg", this,
173 &FGViewMgr::getViewPitchOffset_deg,
174 &FGViewMgr::setViewPitchOffset_deg);
175 fgSetArchivable("/sim/current-view/pitch-offset-deg");
176 fgTie("/sim/current-view/goal-pitch-offset-deg", this,
177 &FGViewMgr::getGoalViewPitchOffset_deg,
178 &FGViewMgr::setGoalViewPitchOffset_deg);
179 fgSetArchivable("/sim/current-view/goal-pitch-offset-deg");
180 fgTie("/sim/current-view/roll-offset-deg", this,
181 &FGViewMgr::getViewRollOffset_deg,
182 &FGViewMgr::setViewRollOffset_deg);
183 fgSetArchivable("/sim/current-view/roll-offset-deg");
184 fgTie("/sim/current-view/goal-roll-offset-deg", this,
185 &FGViewMgr::getGoalViewRollOffset_deg,
186 &FGViewMgr::setGoalViewRollOffset_deg);
187 fgSetArchivable("/sim/current-view/goal-roll-offset-deg");
189 fgTie("/sim/current-view/view-number", this,
190 &FGViewMgr::getView, &FGViewMgr::setView);
191 fgSetArchivable("/sim/current-view/view-number", FALSE);
193 fgTie("/sim/current-view/axes/long", this,
194 (double_getter)0, &FGViewMgr::setViewAxisLong);
195 fgSetArchivable("/sim/current-view/axes/long");
197 fgTie("/sim/current-view/axes/lat", this,
198 (double_getter)0, &FGViewMgr::setViewAxisLat);
199 fgSetArchivable("/sim/current-view/axes/lat");
201 fgTie("/sim/current-view/field-of-view", this,
202 &FGViewMgr::getFOV_deg, &FGViewMgr::setFOV_deg);
203 fgSetArchivable("/sim/current-view/field-of-view");
205 fgTie("/sim/current-view/aspect-ratio-multiplier", this,
206 &FGViewMgr::getARM_deg, &FGViewMgr::setARM_deg);
207 fgSetArchivable("/sim/current-view/field-of-view");
209 fgTie("/sim/current-view/ground-level-nearplane-m", this,
210 &FGViewMgr::getNear_m, &FGViewMgr::setNear_m);
211 fgSetArchivable("/sim/current-view/ground-level-nearplane-m");
213 SGPropertyNode *n = fgGetNode("/sim/current-view", true);
214 n->tie("viewer-x-m", SGRawValuePointer<double>(&abs_viewer_position[0]));
215 n->tie("viewer-y-m", SGRawValuePointer<double>(&abs_viewer_position[1]));
216 n->tie("viewer-z-m", SGRawValuePointer<double>(&abs_viewer_position[2]));
223 // need to redo these bindings to the new locations (move to viewer?)
224 fgUntie("/sim/current-view/heading-offset-deg");
225 fgUntie("/sim/current-view/goal-heading-offset-deg");
226 fgUntie("/sim/current-view/pitch-offset-deg");
227 fgUntie("/sim/current-view/goal-pitch-offset-deg");
228 fgUntie("/sim/current-view/field-of-view");
229 fgUntie("/sim/current-view/aspect-ratio-multiplier");
230 fgUntie("/sim/current-view/view-number");
231 fgUntie("/sim/current-view/axes/long");
232 fgUntie("/sim/current-view/axes/lat");
233 fgUntie("/sim/current-view/ground-level-nearplane-m");
234 fgUntie("/sim/current-view/viewer-x-m");
235 fgUntie("/sim/current-view/viewer-y-m");
236 fgUntie("/sim/current-view/viewer-z-m");
240 FGViewMgr::update (double dt)
242 FGViewer * view = get_current_view();
246 FGViewer *loop_view = (FGViewer *)get_view(current);
247 SGPropertyNode *n = config_list[current];
248 double lon_deg, lat_deg, alt_ft, roll_deg, pitch_deg, heading_deg;
250 // Set up view location and orientation
252 if (!n->getBoolValue("config/from-model")) {
253 lon_deg = fgGetDouble(n->getStringValue("config/eye-lon-deg-path"));
254 lat_deg = fgGetDouble(n->getStringValue("config/eye-lat-deg-path"));
255 alt_ft = fgGetDouble(n->getStringValue("config/eye-alt-ft-path"));
256 roll_deg = fgGetDouble(n->getStringValue("config/eye-roll-deg-path"));
257 pitch_deg = fgGetDouble(n->getStringValue("config/eye-pitch-deg-path"));
258 heading_deg = fgGetDouble(n->getStringValue("config/eye-heading-deg-path"));
260 loop_view->setPosition(lon_deg, lat_deg, alt_ft);
261 loop_view->setOrientation(roll_deg, pitch_deg, heading_deg);
263 // force recalc in viewer
264 loop_view->set_dirty();
267 // if lookat (type 1) then get target data...
268 if (loop_view->getType() == FG_LOOKAT) {
269 if (!n->getBoolValue("config/from-model")) {
270 lon_deg = fgGetDouble(n->getStringValue("config/target-lon-deg-path"));
271 lat_deg = fgGetDouble(n->getStringValue("config/target-lat-deg-path"));
272 alt_ft = fgGetDouble(n->getStringValue("config/target-alt-ft-path"));
273 roll_deg = fgGetDouble(n->getStringValue("config/target-roll-deg-path"));
274 pitch_deg = fgGetDouble(n->getStringValue("config/target-pitch-deg-path"));
275 heading_deg = fgGetDouble(n->getStringValue("config/target-heading-deg-path"));
277 loop_view->setTargetPosition(lon_deg, lat_deg, alt_ft);
278 loop_view->setTargetOrientation(roll_deg, pitch_deg, heading_deg);
280 loop_view->set_dirty();
284 setViewXOffset_m(fgGetDouble("/sim/current-view/x-offset-m"));
285 setViewYOffset_m(fgGetDouble("/sim/current-view/y-offset-m"));
286 setViewZOffset_m(fgGetDouble("/sim/current-view/z-offset-m"));
288 setViewTargetXOffset_m(fgGetDouble("/sim/current-view/target-x-offset-m"));
289 setViewTargetYOffset_m(fgGetDouble("/sim/current-view/target-y-offset-m"));
290 setViewTargetZOffset_m(fgGetDouble("/sim/current-view/target-z-offset-m"));
292 // Update the current view
295 abs_viewer_position = loop_view->getViewPosition();
299 FGViewMgr::copyToCurrent()
301 SGPropertyNode *n = config_list[current];
302 fgSetString("/sim/current-view/name", n->getStringValue("name"));
303 fgSetString("/sim/current-view/type", n->getStringValue("type"));
305 // copy certain view config data for default values
306 fgSetDouble("/sim/current-view/config/heading-offset-deg",
307 n->getDoubleValue("config/default-heading-offset-deg"));
308 fgSetDouble("/sim/current-view/config/pitch-offset-deg",
309 n->getDoubleValue("config/pitch-offset-deg"));
310 fgSetDouble("/sim/current-view/config/roll-offset-deg",
311 n->getDoubleValue("config/roll-offset-deg"));
312 fgSetDouble("/sim/current-view/config/default-field-of-view-deg",
313 n->getDoubleValue("config/default-field-of-view-deg"));
314 fgSetBool("/sim/current-view/config/from-model",
315 n->getBoolValue("config/from-model"));
318 fgSetDouble("/sim/current-view/x-offset-m", getViewXOffset_m());
319 fgSetDouble("/sim/current-view/y-offset-m", getViewYOffset_m());
320 fgSetDouble("/sim/current-view/z-offset-m", getViewZOffset_m());
322 fgSetDouble("/sim/current-view/goal-heading-offset-deg",
323 get_current_view()->getGoalHeadingOffset_deg());
324 fgSetDouble("/sim/current-view/goal-pitch-offset-deg",
325 get_current_view()->getGoalPitchOffset_deg());
326 fgSetDouble("/sim/current-view/goal-roll-offset-deg",
327 get_current_view()->getRollOffset_deg());
328 fgSetDouble("/sim/current-view/heading-offset-deg",
329 get_current_view()->getHeadingOffset_deg());
330 fgSetDouble("/sim/current-view/pitch-offset-deg",
331 get_current_view()->getPitchOffset_deg());
332 fgSetDouble("/sim/current-view/roll-offset-deg",
333 get_current_view()->getRollOffset_deg());
334 fgSetDouble("/sim/current-view/target-x-offset-m",
335 get_current_view()->getTargetXOffset_m());
336 fgSetDouble("/sim/current-view/target-y-offset-m",
337 get_current_view()->getTargetYOffset_m());
338 fgSetDouble("/sim/current-view/target-z-offset-m",
339 get_current_view()->getTargetZOffset_m());
340 fgSetBool("/sim/current-view/internal",
341 get_current_view()->getInternal());
344 void FGViewMgr::clear()
350 FGViewMgr::get_current_view()
352 if ( current < (int)views.size() ) {
353 return views[current];
360 FGViewMgr::get_current_view() const
362 if ( current < (int)views.size() ) {
363 return views[current];
371 FGViewMgr::get_view( int i )
373 if ( i < 0 ) { i = 0; }
374 if ( i >= (int)views.size() ) { i = views.size() - 1; }
379 FGViewMgr::get_view( int i ) const
381 if ( i < 0 ) { i = 0; }
382 if ( i >= (int)views.size() ) { i = views.size() - 1; }
387 FGViewMgr::next_view()
389 setView((current+1 < (int)views.size()) ? (current + 1) : 0);
390 view_number->fireValueChanged();
391 return views[current];
395 FGViewMgr::prev_view()
397 setView((0 < current) ? (current - 1) : (views.size() - 1));
398 view_number->fireValueChanged();
399 return views[current];
403 FGViewMgr::add_view( FGViewer * v )
410 FGViewMgr::getViewHeadingOffset_deg () const
412 const FGViewer * view = get_current_view();
413 return (view == 0 ? 0 : view->getHeadingOffset_deg());
417 FGViewMgr::setViewHeadingOffset_deg (double offset)
419 FGViewer * view = get_current_view();
421 view->setGoalHeadingOffset_deg(offset);
422 view->setHeadingOffset_deg(offset);
427 FGViewMgr::getViewGoalHeadingOffset_deg () const
429 const FGViewer * view = get_current_view();
430 return (view == 0 ? 0 : view->getGoalHeadingOffset_deg());
434 FGViewMgr::setViewGoalHeadingOffset_deg (double offset)
436 FGViewer * view = get_current_view();
438 view->setGoalHeadingOffset_deg(offset);
442 FGViewMgr::getViewPitchOffset_deg () const
444 const FGViewer * view = get_current_view();
445 return (view == 0 ? 0 : view->getPitchOffset_deg());
449 FGViewMgr::setViewPitchOffset_deg (double tilt)
451 FGViewer * view = get_current_view();
453 view->setGoalPitchOffset_deg(tilt);
454 view->setPitchOffset_deg(tilt);
459 FGViewMgr::getGoalViewPitchOffset_deg () const
461 const FGViewer * view = get_current_view();
462 return (view == 0 ? 0 : view->getGoalPitchOffset_deg());
466 FGViewMgr::setGoalViewPitchOffset_deg (double tilt)
468 FGViewer * view = get_current_view();
470 view->setGoalPitchOffset_deg(tilt);
474 FGViewMgr::getViewRollOffset_deg () const
476 const FGViewer * view = get_current_view();
477 return (view == 0 ? 0 : view->getRollOffset_deg());
481 FGViewMgr::setViewRollOffset_deg (double tilt)
483 FGViewer * view = get_current_view();
485 view->setGoalRollOffset_deg(tilt);
486 view->setRollOffset_deg(tilt);
491 FGViewMgr::getGoalViewRollOffset_deg () const
493 const FGViewer * view = get_current_view();
494 return (view == 0 ? 0 : view->getGoalRollOffset_deg());
498 FGViewMgr::setGoalViewRollOffset_deg (double tilt)
500 FGViewer * view = get_current_view();
502 view->setGoalRollOffset_deg(tilt);
506 FGViewMgr::getViewXOffset_m () const
508 const FGViewer * view = get_current_view();
510 return ((FGViewer *)view)->getXOffset_m();
517 FGViewMgr::setViewXOffset_m (double x)
519 FGViewer * view = get_current_view();
521 view->setXOffset_m(x);
526 FGViewMgr::getViewYOffset_m () const
528 const FGViewer * view = get_current_view();
530 return ((FGViewer *)view)->getYOffset_m();
537 FGViewMgr::setViewYOffset_m (double y)
539 FGViewer * view = get_current_view();
541 view->setYOffset_m(y);
546 FGViewMgr::getViewZOffset_m () const
548 const FGViewer * view = get_current_view();
550 return ((FGViewer *)view)->getZOffset_m();
557 FGViewMgr::setViewZOffset_m (double z)
559 FGViewer * view = get_current_view();
561 view->setZOffset_m(z);
566 FGViewMgr::getViewTargetXOffset_m () const
568 const FGViewer * view = get_current_view();
570 return ((FGViewer *)view)->getTargetXOffset_m();
577 FGViewMgr::setViewTargetXOffset_m (double x)
579 FGViewer * view = get_current_view();
581 view->setTargetXOffset_m(x);
586 FGViewMgr::getViewTargetYOffset_m () const
588 const FGViewer * view = get_current_view();
590 return ((FGViewer *)view)->getTargetYOffset_m();
597 FGViewMgr::setViewTargetYOffset_m (double y)
599 FGViewer * view = get_current_view();
601 view->setTargetYOffset_m(y);
606 FGViewMgr::getViewTargetZOffset_m () const
608 const FGViewer * view = get_current_view();
610 return ((FGViewer *)view)->getTargetZOffset_m();
617 FGViewMgr::setViewTargetZOffset_m (double z)
619 FGViewer * view = get_current_view();
621 view->setTargetZOffset_m(z);
626 FGViewMgr::getView () const
632 FGViewMgr::setView (int newview)
634 // negative numbers -> set view with node index -newview
636 for (int i = 0; i < (int)config_list.size(); i++) {
637 int index = -config_list[i]->getIndex();
638 if (index == newview)
645 // if newview number too low wrap to last view...
647 newview = (int)views.size() - 1;
649 // if newview number to high wrap to zero...
650 if (newview >= (int)views.size())
658 // Copy the fdm's position into the SGLocation which is shared with
660 globals->get_aircraft_model()->update(0);
667 FGViewMgr::getFOV_deg () const
669 const FGViewer * view = get_current_view();
670 return (view == 0 ? 0 : view->get_fov());
674 FGViewMgr::setFOV_deg (double fov)
676 FGViewer * view = get_current_view();
682 FGViewMgr::getARM_deg () const
684 const FGViewer * view = get_current_view();
685 return (view == 0 ? 0 : view->get_aspect_ratio_multiplier());
689 FGViewMgr::setARM_deg (double aspect_ratio_multiplier)
691 FGViewer * view = get_current_view();
693 view->set_aspect_ratio_multiplier(aspect_ratio_multiplier);
697 FGViewMgr::getNear_m () const
699 const FGViewer * view = get_current_view();
700 return (view == 0 ? 0.5f : view->getNear_m());
704 FGViewMgr::setNear_m (double near_m)
706 FGViewer * view = get_current_view();
708 view->setNear_m(near_m);
712 FGViewMgr::setViewAxisLong (double axis)
718 FGViewMgr::setViewAxisLat (double axis)
724 FGViewMgr::do_axes ()
726 // Take no action when hat is centered
727 if ( ( axis_long < 0.01 ) &&
728 ( axis_long > -0.01 ) &&
729 ( axis_lat < 0.01 ) &&
734 double viewDir = 999;
736 /* Do all the quick and easy cases */
737 if (axis_long < 0) { // Longitudinal axis forward
738 if (axis_lat == axis_long)
739 viewDir = fgGetDouble("/sim/view/config/front-left-direction-deg");
740 else if (axis_lat == - axis_long)
741 viewDir = fgGetDouble("/sim/view/config/front-right-direction-deg");
742 else if (axis_lat == 0)
743 viewDir = fgGetDouble("/sim/view/config/front-direction-deg");
744 } else if (axis_long > 0) { // Longitudinal axis backward
745 if (axis_lat == - axis_long)
746 viewDir = fgGetDouble("/sim/view/config/back-left-direction-deg");
747 else if (axis_lat == axis_long)
748 viewDir = fgGetDouble("/sim/view/config/back-right-direction-deg");
749 else if (axis_lat == 0)
750 viewDir = fgGetDouble("/sim/view/config/back-direction-deg");
751 } else if (axis_long == 0) { // Longitudinal axis neutral
753 viewDir = fgGetDouble("/sim/view/config/left-direction-deg");
754 else if (axis_lat > 0)
755 viewDir = fgGetDouble("/sim/view/config/right-direction-deg");
756 else return; /* And assertion failure maybe? */
759 // Do all the difficult cases
761 viewDir = SGD_RADIANS_TO_DEGREES * atan2 ( -axis_lat, -axis_long );
762 if ( viewDir < -1 ) viewDir += 360;
764 get_current_view()->setGoalHeadingOffset_deg(viewDir);