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
30 #include <simgear/compiler.h>
32 #include <Model/acmodel.hxx>
34 #include "viewmgr.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());
346 FGViewMgr::getViewHeadingOffset_deg () const
348 const FGViewer * view = get_current_view();
349 return (view == 0 ? 0 : view->getHeadingOffset_deg());
353 FGViewMgr::setViewHeadingOffset_deg (double offset)
355 FGViewer * view = get_current_view();
357 view->setGoalHeadingOffset_deg(offset);
358 view->setHeadingOffset_deg(offset);
363 FGViewMgr::getViewGoalHeadingOffset_deg () const
365 const FGViewer * view = get_current_view();
366 return (view == 0 ? 0 : view->getGoalHeadingOffset_deg());
370 FGViewMgr::setViewGoalHeadingOffset_deg (double offset)
372 FGViewer * view = get_current_view();
374 view->setGoalHeadingOffset_deg(offset);
378 FGViewMgr::getViewPitchOffset_deg () const
380 const FGViewer * view = get_current_view();
381 return (view == 0 ? 0 : view->getPitchOffset_deg());
385 FGViewMgr::setViewPitchOffset_deg (double tilt)
387 FGViewer * view = get_current_view();
389 view->setGoalPitchOffset_deg(tilt);
390 view->setPitchOffset_deg(tilt);
395 FGViewMgr::getGoalViewPitchOffset_deg () const
397 const FGViewer * view = get_current_view();
398 return (view == 0 ? 0 : view->getGoalPitchOffset_deg());
402 FGViewMgr::setGoalViewPitchOffset_deg (double tilt)
404 FGViewer * view = get_current_view();
406 view->setGoalPitchOffset_deg(tilt);
410 FGViewMgr::getViewRollOffset_deg () const
412 const FGViewer * view = get_current_view();
413 return (view == 0 ? 0 : view->getRollOffset_deg());
417 FGViewMgr::setViewRollOffset_deg (double tilt)
419 FGViewer * view = get_current_view();
421 view->setGoalRollOffset_deg(tilt);
422 view->setRollOffset_deg(tilt);
427 FGViewMgr::getGoalViewRollOffset_deg () const
429 const FGViewer * view = get_current_view();
430 return (view == 0 ? 0 : view->getGoalRollOffset_deg());
434 FGViewMgr::setGoalViewRollOffset_deg (double tilt)
436 FGViewer * view = get_current_view();
438 view->setGoalRollOffset_deg(tilt);
442 FGViewMgr::getViewXOffset_m () const
444 const FGViewer * view = get_current_view();
446 return ((FGViewer *)view)->getXOffset_m();
453 FGViewMgr::setViewXOffset_m (double x)
455 FGViewer * view = get_current_view();
457 view->setXOffset_m(x);
462 FGViewMgr::getViewYOffset_m () const
464 const FGViewer * view = get_current_view();
466 return ((FGViewer *)view)->getYOffset_m();
473 FGViewMgr::setViewYOffset_m (double y)
475 FGViewer * view = get_current_view();
477 view->setYOffset_m(y);
482 FGViewMgr::getViewZOffset_m () const
484 const FGViewer * view = get_current_view();
486 return ((FGViewer *)view)->getZOffset_m();
493 FGViewMgr::setViewZOffset_m (double z)
495 FGViewer * view = get_current_view();
497 view->setZOffset_m(z);
502 FGViewMgr::getViewTargetXOffset_m () const
504 const FGViewer * view = get_current_view();
506 return ((FGViewer *)view)->getTargetXOffset_m();
513 FGViewMgr::setViewTargetXOffset_m (double x)
515 FGViewer * view = get_current_view();
517 view->setTargetXOffset_m(x);
522 FGViewMgr::getViewTargetYOffset_m () const
524 const FGViewer * view = get_current_view();
526 return ((FGViewer *)view)->getTargetYOffset_m();
533 FGViewMgr::setViewTargetYOffset_m (double y)
535 FGViewer * view = get_current_view();
537 view->setTargetYOffset_m(y);
542 FGViewMgr::getViewTargetZOffset_m () const
544 const FGViewer * view = get_current_view();
546 return ((FGViewer *)view)->getTargetZOffset_m();
553 FGViewMgr::setViewTargetZOffset_m (double z)
555 FGViewer * view = get_current_view();
557 view->setTargetZOffset_m(z);
562 FGViewMgr::getView () const
568 FGViewMgr::setView (int newview)
570 // negative numbers -> set view with node index -newview
572 for (int i = 0; i < (int)config_list.size(); i++) {
573 int index = -config_list[i]->getIndex();
574 if (index == newview)
581 // if newview number too low wrap to last view...
583 newview = (int)views.size() - 1;
585 // if newview number to high wrap to zero...
586 if (newview >= (int)views.size())
594 // Copy the fdm's position into the SGLocation which is shared with
596 globals->get_aircraft_model()->update(0);
603 FGViewMgr::getFOV_deg () const
605 const FGViewer * view = get_current_view();
606 return (view == 0 ? 0 : view->get_fov());
610 FGViewMgr::setFOV_deg (double fov)
612 FGViewer * view = get_current_view();
618 FGViewMgr::getARM_deg () const
620 const FGViewer * view = get_current_view();
621 return (view == 0 ? 0 : view->get_aspect_ratio_multiplier());
625 FGViewMgr::setARM_deg (double aspect_ratio_multiplier)
627 FGViewer * view = get_current_view();
629 view->set_aspect_ratio_multiplier(aspect_ratio_multiplier);
633 FGViewMgr::getNear_m () const
635 const FGViewer * view = get_current_view();
636 return (view == 0 ? 0.5f : view->getNear_m());
640 FGViewMgr::setNear_m (double near_m)
642 FGViewer * view = get_current_view();
644 view->setNear_m(near_m);
648 FGViewMgr::setViewAxisLong (double axis)
654 FGViewMgr::setViewAxisLat (double axis)
660 FGViewMgr::do_axes ()
662 // Take no action when hat is centered
663 if ( ( axis_long < 0.01 ) &&
664 ( axis_long > -0.01 ) &&
665 ( axis_lat < 0.01 ) &&
670 double viewDir = 999;
672 /* Do all the quick and easy cases */
673 if (axis_long < 0) { // Longitudinal axis forward
674 if (axis_lat == axis_long)
675 viewDir = fgGetDouble("/sim/view/config/front-left-direction-deg");
676 else if (axis_lat == - axis_long)
677 viewDir = fgGetDouble("/sim/view/config/front-right-direction-deg");
678 else if (axis_lat == 0)
679 viewDir = fgGetDouble("/sim/view/config/front-direction-deg");
680 } else if (axis_long > 0) { // Longitudinal axis backward
681 if (axis_lat == - axis_long)
682 viewDir = fgGetDouble("/sim/view/config/back-left-direction-deg");
683 else if (axis_lat == axis_long)
684 viewDir = fgGetDouble("/sim/view/config/back-right-direction-deg");
685 else if (axis_lat == 0)
686 viewDir = fgGetDouble("/sim/view/config/back-direction-deg");
687 } else if (axis_long == 0) { // Longitudinal axis neutral
689 viewDir = fgGetDouble("/sim/view/config/left-direction-deg");
690 else if (axis_lat > 0)
691 viewDir = fgGetDouble("/sim/view/config/right-direction-deg");
692 else return; /* And assertion failure maybe? */
695 // Do all the difficult cases
697 viewDir = SGD_RADIANS_TO_DEGREES * atan2 ( -axis_lat, -axis_long );
698 if ( viewDir < -1 ) viewDir += 360;
700 get_current_view()->setGoalHeadingOffset_deg(viewDir);