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.
6 // Copyright (C) 1997 - 2000 Curtis L. Olson - curt@flightgear.org
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., 675 Mass Ave, Cambridge, MA 02139, USA.
30 # error This library requires C++
33 #include <simgear/compiler.h>
35 #include <plib/sg.h> // plib include
38 #define FG_FOV_MIN 0.1
39 #define FG_FOV_MAX 179.9
42 // Define a structure containing view information
55 // flag forcing a recalc of derived view parameters
62 // the field of view in the x (width) direction
65 // ratio of x and y fov's; fov(y) = fov(x) * win_ratio
68 // the current view offset angle from forward (rotated about the
72 // the goal view offset angle (used for smooth view changes)
73 double goal_view_offset;
75 // geodetic view position
76 sgdVec3 geod_view_pos;
78 // absolute view position in earth coordinates
81 // view position in opengl world coordinates (this is the
82 // abs_view_pos translated to scenery.center)
85 // radius to sea level from center of the earth (m)
86 double sea_level_radius;
88 // cartesion coordinates of current lon/lat if at sea level
89 // translated to scenery.center
92 // pilot offset from center of gravity. The X axis is positive
93 // out the tail, Y is out the right wing, and Z is positive up.
94 // Distances in meters of course.
97 // surface vector heading south
100 // surface vector heading east (used to unambiguously align sky
104 // world up vector (normal to the plane tangent to the earth's
105 // surface at the spot we are directly above
108 // sg versions of our friendly matrices
109 sgMat4 VIEW, VIEW_ROT, UP;
111 inline void set_dirty() { dirty = true; }
112 inline void set_clean() { dirty = false; }
114 // Update the view volume, position, and orientation
115 virtual void update();
123 virtual ~FGViewer( void );
125 //////////////////////////////////////////////////////////////////////
127 //////////////////////////////////////////////////////////////////////
128 inline void set_fov( double amount ) { fov = amount; }
129 inline void set_win_ratio( double r ) { win_ratio = r; }
130 inline void set_view_offset( double a ) {
134 inline void inc_view_offset( double amt ) {
138 inline void set_goal_view_offset( double a) {
140 goal_view_offset = a;
142 inline void set_geod_view_pos( double lon, double lat, double alt ) {
143 // data should be in radians and meters asl
145 // cout << "set_geod_view_pos = " << lon << ", " << lat << ", " << alt
147 sgdSetVec3( geod_view_pos, lon, lat, alt );
149 inline void set_pilot_offset( float x, float y, float z ) {
151 sgSetVec3( pilot_offset, x, y, z );
153 inline void set_sea_level_radius( double r ) {
154 // data should be in meters from the center of the earth
156 sea_level_radius = r;
159 //////////////////////////////////////////////////////////////////////
160 // accessor functions
161 //////////////////////////////////////////////////////////////////////
162 inline int get_type() const { return _type ; }
163 inline int is_a( int t ) const { return get_type() == t ; }
164 inline bool is_dirty() const { return dirty; }
165 inline double get_fov() const { return fov; }
166 inline double get_win_ratio() const { return win_ratio; }
167 inline double get_view_offset() const { return view_offset; }
168 inline double get_goal_view_offset() const { return goal_view_offset; }
169 inline double *get_geod_view_pos() { return geod_view_pos; }
170 inline float *get_pilot_offset() { return pilot_offset; }
171 inline double get_sea_level_radius() const { return sea_level_radius; }
173 //////////////////////////////////////////////////////////////////////
174 // derived values accessor functions
175 //////////////////////////////////////////////////////////////////////
176 inline double *get_abs_view_pos() {
177 if ( dirty ) { update(); }
180 inline float *get_view_pos() {
181 if ( dirty ) { update(); }
184 inline float *get_zero_elev() {
185 if ( dirty ) { update(); }
188 inline float *get_surface_south() {
189 if ( dirty ) { update(); }
190 return surface_south;
192 inline float *get_surface_east() {
193 if ( dirty ) { update(); }
196 inline float *get_world_up() {
197 if ( dirty ) { update(); }
200 inline const sgVec4 *get_VIEW() {
201 if ( dirty ) { update(); }
204 inline const sgVec4 *get_VIEW_ROT() {
205 if ( dirty ) { update(); }
208 inline const sgVec4 *get_UP() {
209 if ( dirty ) { update(); }
215 #endif // _VIEWER_HXX