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 a structure containing view information
51 // flag forcing a recalc of derived view parameters
58 // the current view offset angle from forward (rotated about the
62 // the goal view offset angle (used for smooth view changes)
63 double goal_view_offset;
65 // geodetic view position
66 sgdVec3 geod_view_pos;
68 // absolute view position in earth coordinates
71 // view position in opengl world coordinates (this is the
72 // abs_view_pos translated to scenery.center)
75 // radius to sea level from center of the earth (m)
76 double sea_level_radius;
78 // cartesion coordinates of current lon/lat if at sea level
79 // translated to scenery.center
82 // pilot offset from center of gravity. The X axis is positive
83 // out the tail, Y is out the right wing, and Z is positive up.
84 // Distances in meters of course.
87 // surface vector heading south
90 // surface vector heading east (used to unambiguously align sky
94 // world up vector (normal to the plane tangent to the earth's
95 // surface at the spot we are directly above
98 // sg versions of our friendly matrices
99 sgMat4 VIEW, VIEW_ROT, UP;
101 inline void set_dirty() { dirty = true; }
102 inline void set_clean() { dirty = false; }
104 // Update the view volume, position, and orientation
105 virtual void update();
113 virtual ~FGViewer( void );
115 //////////////////////////////////////////////////////////////////////
117 //////////////////////////////////////////////////////////////////////
118 inline void set_view_offset( double a ) {
122 inline void inc_view_offset( double amt ) {
126 inline void set_goal_view_offset( double a) {
128 goal_view_offset = a;
130 inline void set_geod_view_pos( double lon, double lat, double alt ) {
131 // data should be in radians and meters asl
133 // cout << "set_geod_view_pos = " << lon << ", " << lat << ", " << alt
135 sgdSetVec3( geod_view_pos, lon, lat, alt );
137 inline void set_pilot_offset( float x, float y, float z ) {
139 sgSetVec3( pilot_offset, x, y, z );
141 inline void set_sea_level_radius( double r ) {
142 // data should be in meters from the center of the earth
144 sea_level_radius = r;
147 //////////////////////////////////////////////////////////////////////
148 // accessor functions
149 //////////////////////////////////////////////////////////////////////
150 inline int get_type() const { return _type ; }
151 inline int is_a( int t ) const { return get_type() == t ; }
152 inline bool is_dirty() const { return dirty; }
153 inline double get_view_offset() const { return view_offset; }
154 inline double get_goal_view_offset() const { return goal_view_offset; }
155 inline double *get_geod_view_pos() { return geod_view_pos; }
156 inline float *get_pilot_offset() { return pilot_offset; }
157 inline double get_sea_level_radius() const { return sea_level_radius; }
159 //////////////////////////////////////////////////////////////////////
160 // derived values accessor functions
161 //////////////////////////////////////////////////////////////////////
162 inline double *get_abs_view_pos() {
163 if ( dirty ) { update(); }
166 inline float *get_view_pos() {
167 if ( dirty ) { update(); }
170 inline float *get_zero_elev() {
171 if ( dirty ) { update(); }
174 inline float *get_surface_south() {
175 if ( dirty ) { update(); }
176 return surface_south;
178 inline float *get_surface_east() {
179 if ( dirty ) { update(); }
182 inline float *get_world_up() {
183 if ( dirty ) { update(); }
186 inline const sgVec4 *get_VIEW() {
187 if ( dirty ) { update(); }
190 inline const sgVec4 *get_VIEW_ROT() {
191 if ( dirty ) { update(); }
194 inline const sgVec4 *get_UP() {
195 if ( dirty ) { update(); }
201 #endif // _VIEWER_HXX