1 // viewer.hxx -- 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.
35 #include <osg/ref_ptr>
37 #include <simgear/compiler.h>
38 #include <simgear/constants.h>
39 #include <simgear/structure/subsystem_mgr.hxx>
40 #include <simgear/math/SGMath.hxx>
42 #define FG_FOV_MIN 0.1
43 #define FG_FOV_MAX 179.9
50 // Define a structure containing view information
51 class FGViewer : public SGSubsystem {
55 enum fgScalingType { // nominal Field Of View actually applies to ...
56 FG_SCALING_WIDTH, // window width
57 FG_SCALING_MAX // max(width, height)
58 // FG_SCALING_G_MEAN, // geometric_mean(width, height)
59 // FG_SCALING_INDEPENDENT // whole screen
63 FGViewer( fgViewType Type, bool from_model, int from_model_index,
64 bool at_model, int at_model_index,
65 double damp_roll, double damp_pitch, double damp_heading,
66 double x_offset_m, double y_offset_m, double z_offset_m,
67 double heading_offset_deg, double pitch_offset_deg,
68 double roll_offset_deg,
69 double fov_deg, double aspect_ratio_multiplier,
70 double target_x_offset_m, double target_y_offset_m,
71 double target_z_offset_m, double near_m, bool internal );
74 virtual ~FGViewer( void );
76 //////////////////////////////////////////////////////////////////////
77 // Part 1: standard SGSubsystem implementation.
78 //////////////////////////////////////////////////////////////////////
82 virtual void unbind ();
83 void update (double dt);
86 //////////////////////////////////////////////////////////////////////
87 // Part 2: user settings.
88 //////////////////////////////////////////////////////////////////////
90 virtual fgViewType getType() const { return _type; }
91 virtual void setType( int type );
93 virtual bool getInternal() const { return _internal; }
94 virtual void setInternal( bool internal );
96 // Reference geodetic position of view from position...
97 // These are the actual aircraft position (pilot in
98 // pilot view, model in model view).
99 // FIXME: the model view position (ie target positions)
100 // should be in the model class.
101 virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
102 const SGGeod& getPosition() const { return _position; }
104 // Reference geodetic target position...
105 virtual void setTargetPosition (double lon_deg, double lat_deg, double alt_ft);
106 const SGGeod& getTargetPosition() const { return _target; }
110 // Position offsets from reference
111 // These offsets position they "eye" in the scene according to a given
112 // location. For example in pilot view they are used to position the
113 // head inside the aircraft.
114 // Note that in pilot view these are applied "before" the orientation
115 // rotations (see below) so that the orientation rotations have the
116 // effect of the pilot staying in his seat and "looking out" in
117 // different directions.
118 // In chase view these are applied "after" the application of the
119 // orientation rotations listed below. This has the effect of the
120 // eye moving around and "looking at" the object (model) from
122 virtual SGVec3d getOffset_m () const { return _offset_m; }
123 virtual double getXOffset_m () const { return _offset_m.x(); }
124 virtual double getYOffset_m () const { return _offset_m.y(); }
125 virtual double getZOffset_m () const { return _offset_m.z(); }
126 virtual double getTargetXOffset_m () const { return _target_offset_m.x(); }
127 virtual double getTargetYOffset_m () const { return _target_offset_m.y(); }
128 virtual double getTargetZOffset_m () const { return _target_offset_m.z(); }
129 virtual void setXOffset_m (double x_offset_m);
130 virtual void setYOffset_m (double y_offset_m);
131 virtual void setZOffset_m (double z_offset_m);
132 virtual void setTargetXOffset_m (double x_offset_m);
133 virtual void setTargetYOffset_m (double y_offset_m);
134 virtual void setTargetZOffset_m (double z_offset_m);
135 virtual void setPositionOffsets (double x_offset_m,
142 // Reference orientation rotations...
143 // These are rotations that represent the plane attitude effect on
144 // the view (in Pilot view). IE The view frustrum rotates as the plane
145 // turns, pitches, and rolls.
146 // In model view (lookat/chaseview) these end up changing the angle that
147 // the eye is looking at the ojbect (ie the model).
148 // FIXME: the FGModel class should have its own version of these so that
149 // it can generate it's own model rotations.
150 virtual double getRoll_deg () const { return _roll_deg; }
151 virtual double getPitch_deg () const {return _pitch_deg; }
152 virtual double getHeading_deg () const {return _heading_deg; }
153 virtual void setRoll_deg (double roll_deg);
154 virtual void setPitch_deg (double pitch_deg);
155 virtual void setHeading_deg (double heading_deg);
156 virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
157 virtual double getTargetRoll_deg () const { return _target_roll_deg; }
158 virtual double getTargetPitch_deg () const {return _target_pitch_deg; }
159 virtual double getTargetHeading_deg () const {return _target_heading_deg; }
160 virtual void setTargetRoll_deg (double roll_deg);
161 virtual void setTargetPitch_deg (double pitch_deg);
162 virtual void setTargetHeading_deg (double heading_deg);
163 virtual void setTargetOrientation (double roll_deg, double pitch_deg, double heading_deg);
168 // Orientation offsets rotations from reference orientation.
169 // Goal settings are for smooth transition from prior
170 // offset when changing view direction.
171 // These offsets are in ADDITION to the orientation rotations listed
173 // In pilot view they are applied after the position offsets in order to
174 // give the effect of the pilot looking around.
175 // In lookat view they are applied before the position offsets so that
176 // the effect is the eye moving around looking at the object (ie the model)
177 // from different angles.
178 virtual double getRollOffset_deg () const { return _roll_offset_deg; }
179 virtual double getPitchOffset_deg () const { return _pitch_offset_deg; }
180 virtual double getHeadingOffset_deg () const { return _heading_offset_deg; }
181 virtual double getGoalRollOffset_deg () const { return _goal_roll_offset_deg; }
182 virtual double getGoalPitchOffset_deg () const { return _goal_pitch_offset_deg; }
183 virtual double getGoalHeadingOffset_deg () const {return _goal_heading_offset_deg; }
184 virtual void setRollOffset_deg (double roll_offset_deg);
185 virtual void setPitchOffset_deg (double pitch_offset_deg);
186 virtual void setHeadingOffset_deg (double heading_offset_deg);
187 virtual void setGoalRollOffset_deg (double goal_roll_offset_deg);
188 virtual void setGoalPitchOffset_deg (double goal_pitch_offset_deg);
189 virtual void setGoalHeadingOffset_deg (double goal_heading_offset_deg);
190 virtual void setOrientationOffsets (double roll_offset_deg,
191 double heading_offset_deg,
192 double pitch_offset_deg);
196 //////////////////////////////////////////////////////////////////////
197 // Part 3: output vectors and matrices in FlightGear coordinates.
198 //////////////////////////////////////////////////////////////////////
200 // Vectors and positions...
202 const SGVec3d& get_view_pos() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
203 const SGVec3d& getViewPosition() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
204 const SGQuatd& getViewOrientation() { if ( _dirty ) { recalc(); } return mViewOrientation; }
205 const SGQuatd& getViewOrientationOffset() { if ( _dirty ) { recalc(); } return mViewOffsetOr; }
207 //////////////////////////////////////////////////////////////////////
208 // Part 4: View and frustrum data setters and getters
209 //////////////////////////////////////////////////////////////////////
211 virtual void set_fov( double fov_deg ) {
214 virtual double get_fov() const { return _fov_deg; }
215 virtual double get_h_fov(); // Get horizontal fov, in degrees.
216 virtual double get_v_fov(); // Get vertical fov, in degrees.
218 virtual void set_aspect_ratio( double r ) {
221 virtual double get_aspect_ratio() const { return _aspect_ratio; }
223 virtual void set_aspect_ratio_multiplier( double m ) {
224 _aspect_ratio_multiplier = m;
226 virtual double get_aspect_ratio_multiplier() const {
227 return _aspect_ratio_multiplier;
230 virtual double getNear_m () const { return _ground_level_nearplane_m; }
231 inline void setNear_m (double near_m) {
232 _ground_level_nearplane_m = near_m;
235 //////////////////////////////////////////////////////////////////////
236 // Part 5: misc setters and getters
237 //////////////////////////////////////////////////////////////////////
239 inline void set_dirty() { _dirty = true; }
240 inline void set_clean() { _dirty = false; }
244 //////////////////////////////////////////////////////////////////
246 //////////////////////////////////////////////////////////////////
248 // flag forcing a recalc of derived view parameters
251 SGQuatd mViewOrientation;
252 SGQuatd mViewOffsetOr;
253 SGVec3d _absolute_view_pos;
261 double _target_roll_deg;
262 double _target_pitch_deg;
263 double _target_heading_deg;
268 double _damp_heading;
270 double _damped_roll_deg;
271 double _damped_pitch_deg;
272 double _damped_heading_deg;
274 // Position offsets from FDM origin. The X axis is positive
275 // out the tail, Y is out the right wing, and Z is positive up.
276 // distance in meters
279 // Target offsets from FDM origin (for "lookat" targets) The X
280 // axis is positive out the tail, Y is out the right wing, and Z
281 // is positive up. distance in meters
282 SGVec3d _target_offset_m;
285 // orientation offsets from reference (_goal* are for smoothed transitions)
286 double _roll_offset_deg;
287 double _pitch_offset_deg;
288 double _heading_offset_deg;
289 double _goal_roll_offset_deg;
290 double _goal_pitch_offset_deg;
291 double _goal_heading_offset_deg;
293 // used to set nearplane when at ground level for this view
294 double _ground_level_nearplane_m;
297 fgScalingType _scaling_type;
299 // internal view (e.g. cockpit) flag
302 // view is looking from a model
304 int _from_model_index; // number of model (for multi model)
306 // view is looking at a model
308 int _at_model_index; // number of model (for multi model)
310 // the nominal field of view (angle, in degrees)
313 // Ratio of window width and height; height = width *
314 // aspect_ratio. This value is automatically calculated based on
315 // window dimentions.
316 double _aspect_ratio;
318 // default = 1.0, this value is user configurable and is
319 // multiplied into the aspect_ratio to get the actual vertical fov
320 double _aspect_ratio_multiplier;
322 // camera group controled by this view
323 osg::ref_ptr<flightgear::CameraGroup> _cameraGroup;
324 //////////////////////////////////////////////////////////////////
325 // private functions //
326 //////////////////////////////////////////////////////////////////
329 void recalcLookFrom();
331 void dampEyeData(double &roll_deg, double &pitch_deg, double &heading_deg);
333 // add to _heading_offset_deg
334 inline void incHeadingOffset_deg( double amt ) {
336 _heading_offset_deg += amt;
339 // add to _pitch_offset_deg
340 inline void incPitchOffset_deg( double amt ) {
342 _pitch_offset_deg += amt;
345 // add to _roll_offset_deg
346 inline void incRollOffset_deg( double amt ) {
348 _roll_offset_deg += amt;
354 #endif // _VIEWER_HXX