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 <string.h> // strcmp
32 #include <simgear/compiler.h>
34 #include <Model/acmodel.hxx>
36 #include "viewmgr.hxx"
40 FGViewMgr::FGViewMgr( void ) :
43 view_number(fgGetNode("/sim/current-view/view-number", true)),
44 config_list(fgGetNode("/sim", true)->getChildren("view")),
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-deg",
151 n->getDoubleValue("config/target-x-offset-m"));
152 fgSetDouble("/sim/current-view/target-y-offset-deg",
153 n->getDoubleValue("config/target-y-offset-m"));
154 fgSetDouble("/sim/current-view/target-z-offset-deg",
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");
221 // need to redo these bindings to the new locations (move to viewer?)
222 fgUntie("/sim/current-view/heading-offset-deg");
223 fgUntie("/sim/current-view/goal-heading-offset-deg");
224 fgUntie("/sim/current-view/pitch-offset-deg");
225 fgUntie("/sim/current-view/goal-pitch-offset-deg");
226 fgUntie("/sim/current-view/field-of-view");
227 fgUntie("/sim/current-view/aspect-ratio-multiplier");
228 fgUntie("/sim/current-view/view-number");
229 fgUntie("/sim/current-view/axes/long");
230 fgUntie("/sim/current-view/axes/lat");
231 fgUntie("/sim/current-view/ground-level-nearplane-m");
235 FGViewMgr::update (double dt)
237 FGViewer * view = get_current_view();
241 FGViewer *loop_view = (FGViewer *)get_view(current);
242 SGPropertyNode *n = config_list[current];
243 double lon_deg, lat_deg, alt_ft, roll_deg, pitch_deg, heading_deg;
245 // Set up view location and orientation
247 if (!n->getBoolValue("config/from-model")) {
248 lon_deg = fgGetDouble(n->getStringValue("config/eye-lon-deg-path"));
249 lat_deg = fgGetDouble(n->getStringValue("config/eye-lat-deg-path"));
250 alt_ft = fgGetDouble(n->getStringValue("config/eye-alt-ft-path"));
251 roll_deg = fgGetDouble(n->getStringValue("config/eye-roll-deg-path"));
252 pitch_deg = fgGetDouble(n->getStringValue("config/eye-pitch-deg-path"));
253 heading_deg = fgGetDouble(n->getStringValue("config/eye-heading-deg-path"));
255 loop_view->setPosition(lon_deg, lat_deg, alt_ft);
256 loop_view->setOrientation(roll_deg, pitch_deg, heading_deg);
258 // force recalc in viewer
259 loop_view->set_dirty();
262 // if lookat (type 1) then get target data...
263 if (loop_view->getType() == FG_LOOKAT) {
264 if (!n->getBoolValue("config/from-model")) {
265 lon_deg = fgGetDouble(n->getStringValue("config/target-lon-deg-path"));
266 lat_deg = fgGetDouble(n->getStringValue("config/target-lat-deg-path"));
267 alt_ft = fgGetDouble(n->getStringValue("config/target-alt-ft-path"));
268 roll_deg = fgGetDouble(n->getStringValue("config/target-roll-deg-path"));
269 pitch_deg = fgGetDouble(n->getStringValue("config/target-pitch-deg-path"));
270 heading_deg = fgGetDouble(n->getStringValue("config/target-heading-deg-path"));
272 loop_view->setTargetPosition(lon_deg, lat_deg, alt_ft);
273 loop_view->setTargetOrientation(roll_deg, pitch_deg, heading_deg);
275 loop_view->set_dirty();
279 setViewXOffset_m(fgGetDouble("/sim/current-view/x-offset-m"));
280 setViewYOffset_m(fgGetDouble("/sim/current-view/y-offset-m"));
281 setViewZOffset_m(fgGetDouble("/sim/current-view/z-offset-m"));
283 setViewTargetXOffset_m(fgGetDouble("/sim/current-view/target-x-offset-m"));
284 setViewTargetYOffset_m(fgGetDouble("/sim/current-view/target-y-offset-m"));
285 setViewTargetZOffset_m(fgGetDouble("/sim/current-view/target-z-offset-m"));
287 // Update the current view
293 FGViewMgr::copyToCurrent()
295 SGPropertyNode *n = config_list[current];
296 fgSetString("/sim/current-view/name", n->getStringValue("name"));
297 fgSetString("/sim/current-view/type", n->getStringValue("type"));
299 // copy certain view config data for default values
300 fgSetDouble("/sim/current-view/config/heading-offset-deg",
301 n->getDoubleValue("config/default-heading-offset-deg"));
302 fgSetDouble("/sim/current-view/config/pitch-offset-deg",
303 n->getDoubleValue("config/pitch-offset-deg"));
304 fgSetDouble("/sim/current-view/config/roll-offset-deg",
305 n->getDoubleValue("config/roll-offset-deg"));
306 fgSetDouble("/sim/current-view/config/default-field-of-view-deg",
307 n->getDoubleValue("config/default-field-of-view-deg"));
308 fgSetBool("/sim/current-view/config/from-model",
309 n->getBoolValue("config/from-model"));
312 fgSetDouble("/sim/current-view/x-offset-m", getViewXOffset_m());
313 fgSetDouble("/sim/current-view/y-offset-m", getViewYOffset_m());
314 fgSetDouble("/sim/current-view/z-offset-m", getViewZOffset_m());
316 fgSetDouble("/sim/current-view/goal-heading-offset-deg",
317 get_current_view()->getGoalHeadingOffset_deg());
318 fgSetDouble("/sim/current-view/goal-pitch-offset-deg",
319 get_current_view()->getGoalPitchOffset_deg());
320 fgSetDouble("/sim/current-view/goal-roll-offset-deg",
321 get_current_view()->getRollOffset_deg());
322 fgSetDouble("/sim/current-view/heading-offset-deg",
323 get_current_view()->getHeadingOffset_deg());
324 fgSetDouble("/sim/current-view/pitch-offset-deg",
325 get_current_view()->getPitchOffset_deg());
326 fgSetDouble("/sim/current-view/roll-offset-deg",
327 get_current_view()->getRollOffset_deg());
328 fgSetDouble("/sim/current-view/target-x-offset-m",
329 get_current_view()->getTargetXOffset_m());
330 fgSetDouble("/sim/current-view/target-y-offset-m",
331 get_current_view()->getTargetYOffset_m());
332 fgSetDouble("/sim/current-view/target-z-offset-m",
333 get_current_view()->getTargetZOffset_m());
334 fgSetBool("/sim/current-view/internal",
335 get_current_view()->getInternal());
340 FGViewMgr::getViewHeadingOffset_deg () const
342 const FGViewer * view = get_current_view();
343 return (view == 0 ? 0 : view->getHeadingOffset_deg());
347 FGViewMgr::setViewHeadingOffset_deg (double offset)
349 FGViewer * view = get_current_view();
351 view->setGoalHeadingOffset_deg(offset);
352 view->setHeadingOffset_deg(offset);
357 FGViewMgr::getViewGoalHeadingOffset_deg () const
359 const FGViewer * view = get_current_view();
360 return (view == 0 ? 0 : view->getGoalHeadingOffset_deg());
364 FGViewMgr::setViewGoalHeadingOffset_deg (double offset)
366 FGViewer * view = get_current_view();
368 view->setGoalHeadingOffset_deg(offset);
372 FGViewMgr::getViewPitchOffset_deg () const
374 const FGViewer * view = get_current_view();
375 return (view == 0 ? 0 : view->getPitchOffset_deg());
379 FGViewMgr::setViewPitchOffset_deg (double tilt)
381 FGViewer * view = get_current_view();
383 view->setGoalPitchOffset_deg(tilt);
384 view->setPitchOffset_deg(tilt);
389 FGViewMgr::getGoalViewPitchOffset_deg () const
391 const FGViewer * view = get_current_view();
392 return (view == 0 ? 0 : view->getGoalPitchOffset_deg());
396 FGViewMgr::setGoalViewPitchOffset_deg (double tilt)
398 FGViewer * view = get_current_view();
400 view->setGoalPitchOffset_deg(tilt);
404 FGViewMgr::getViewRollOffset_deg () const
406 const FGViewer * view = get_current_view();
407 return (view == 0 ? 0 : view->getRollOffset_deg());
411 FGViewMgr::setViewRollOffset_deg (double tilt)
413 FGViewer * view = get_current_view();
415 view->setGoalRollOffset_deg(tilt);
416 view->setRollOffset_deg(tilt);
421 FGViewMgr::getGoalViewRollOffset_deg () const
423 const FGViewer * view = get_current_view();
424 return (view == 0 ? 0 : view->getGoalRollOffset_deg());
428 FGViewMgr::setGoalViewRollOffset_deg (double tilt)
430 FGViewer * view = get_current_view();
432 view->setGoalRollOffset_deg(tilt);
436 FGViewMgr::getViewXOffset_m () const
438 const FGViewer * view = get_current_view();
440 return ((FGViewer *)view)->getXOffset_m();
447 FGViewMgr::setViewXOffset_m (double x)
449 FGViewer * view = get_current_view();
451 view->setXOffset_m(x);
456 FGViewMgr::getViewYOffset_m () const
458 const FGViewer * view = get_current_view();
460 return ((FGViewer *)view)->getYOffset_m();
467 FGViewMgr::setViewYOffset_m (double y)
469 FGViewer * view = get_current_view();
471 view->setYOffset_m(y);
476 FGViewMgr::getViewZOffset_m () const
478 const FGViewer * view = get_current_view();
480 return ((FGViewer *)view)->getZOffset_m();
487 FGViewMgr::setViewZOffset_m (double z)
489 FGViewer * view = get_current_view();
491 view->setZOffset_m(z);
496 FGViewMgr::getViewTargetXOffset_m () const
498 const FGViewer * view = get_current_view();
500 return ((FGViewer *)view)->getTargetXOffset_m();
507 FGViewMgr::setViewTargetXOffset_m (double x)
509 FGViewer * view = get_current_view();
511 view->setTargetXOffset_m(x);
516 FGViewMgr::getViewTargetYOffset_m () const
518 const FGViewer * view = get_current_view();
520 return ((FGViewer *)view)->getTargetYOffset_m();
527 FGViewMgr::setViewTargetYOffset_m (double y)
529 FGViewer * view = get_current_view();
531 view->setTargetYOffset_m(y);
536 FGViewMgr::getViewTargetZOffset_m () const
538 const FGViewer * view = get_current_view();
540 return ((FGViewer *)view)->getTargetZOffset_m();
547 FGViewMgr::setViewTargetZOffset_m (double z)
549 FGViewer * view = get_current_view();
551 view->setTargetZOffset_m(z);
556 FGViewMgr::getView () const
562 FGViewMgr::setView (int newview)
564 // negative numbers -> set view with node index -newview
566 for (int i = 0; i < (int)config_list.size(); i++) {
567 int index = -config_list[i]->getIndex();
568 if (index == newview)
575 // if newview number too low wrap to last view...
577 newview = (int)views.size() - 1;
579 // if newview number to high wrap to zero...
580 if (newview >= (int)views.size())
588 // Copy the fdm's position into the SGLocation which is shared with
590 globals->get_aircraft_model()->update(0);
597 FGViewMgr::getFOV_deg () const
599 const FGViewer * view = get_current_view();
600 return (view == 0 ? 0 : view->get_fov());
604 FGViewMgr::setFOV_deg (double fov)
606 FGViewer * view = get_current_view();
612 FGViewMgr::getARM_deg () const
614 const FGViewer * view = get_current_view();
615 return (view == 0 ? 0 : view->get_aspect_ratio_multiplier());
619 FGViewMgr::setARM_deg (double aspect_ratio_multiplier)
621 FGViewer * view = get_current_view();
623 view->set_aspect_ratio_multiplier(aspect_ratio_multiplier);
627 FGViewMgr::getNear_m () const
629 const FGViewer * view = get_current_view();
630 return (view == 0 ? 0.5f : view->getNear_m());
634 FGViewMgr::setNear_m (double near_m)
636 FGViewer * view = get_current_view();
638 view->setNear_m(near_m);
642 FGViewMgr::setViewAxisLong (double axis)
648 FGViewMgr::setViewAxisLat (double axis)
654 FGViewMgr::do_axes ()
656 // Take no action when hat is centered
657 if ( ( axis_long < 0.01 ) &&
658 ( axis_long > -0.01 ) &&
659 ( axis_lat < 0.01 ) &&
664 double viewDir = 999;
666 /* Do all the quick and easy cases */
667 if (axis_long < 0) { // Longitudinal axis forward
668 if (axis_lat == axis_long)
669 viewDir = fgGetDouble("/sim/view/config/front-left-direction-deg");
670 else if (axis_lat == - axis_long)
671 viewDir = fgGetDouble("/sim/view/config/front-right-direction-deg");
672 else if (axis_lat == 0)
673 viewDir = fgGetDouble("/sim/view/config/front-direction-deg");
674 } else if (axis_long > 0) { // Longitudinal axis backward
675 if (axis_lat == - axis_long)
676 viewDir = fgGetDouble("/sim/view/config/back-left-direction-deg");
677 else if (axis_lat == axis_long)
678 viewDir = fgGetDouble("/sim/view/config/back-right-direction-deg");
679 else if (axis_lat == 0)
680 viewDir = fgGetDouble("/sim/view/config/back-direction-deg");
681 } else if (axis_long == 0) { // Longitudinal axis neutral
683 viewDir = fgGetDouble("/sim/view/config/left-direction-deg");
684 else if (axis_lat > 0)
685 viewDir = fgGetDouble("/sim/view/config/right-direction-deg");
686 else return; /* And assertion failure maybe? */
689 // Do all the difficult cases
691 viewDir = SGD_RADIANS_TO_DEGREES * atan2 ( -axis_lat, -axis_long );
692 if ( viewDir < -1 ) viewDir += 360;
694 get_current_view()->setGoalHeadingOffset_deg(viewDir);