]> git.mxchange.org Git - flightgear.git/blob - src/Main/location.hxx
Make spoilers and speed-brake position accessible
[flightgear.git] / src / Main / location.hxx
1 // location.hxx -- class for determining model location in the flightgear world.
2 //
3 // Written by Jim Wilson, David Megginson, started April 2002.
4 //
5 // Copyright (C) 2002  Jim Wilson, David Megginson
6 //
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
11 //
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 // General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 //
21 // $Id$
22
23
24 #ifndef _LOCATION_HXX
25 #define _LOCATION_HXX
26
27
28 #ifndef __cplusplus                                                          
29 # error This library requires C++
30 #endif                                   
31
32 #include <simgear/compiler.h>
33 #include <simgear/constants.h>
34 #include <simgear/math/point3d.hxx>
35
36 #include <plib/sg.h>            // plib include
37
38 #include "fgfs.hxx"
39
40
41 // Define a structure containing view information
42 class FGLocation
43 {
44
45 public:
46
47     // Constructor
48     FGLocation( void );
49
50     // Destructor
51     virtual ~FGLocation( void );
52
53     //////////////////////////////////////////////////////////////////////
54     // Part 1: standard FGSubsystem implementation.
55     //////////////////////////////////////////////////////////////////////
56
57     virtual void init ();
58     virtual void bind ();
59     virtual void unbind ();
60     void update (int dt);
61
62
63     //////////////////////////////////////////////////////////////////////
64     // Part 2: user settings.
65     //////////////////////////////////////////////////////////////////////
66
67     // Geodetic position of model...
68     virtual double getLongitude_deg () const { return _lon_deg; }
69     virtual double getLatitude_deg () const { return _lat_deg; }
70     virtual double getAltitudeASL_ft () const { return _alt_ft; }
71     virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
72
73
74     // Reference orientation rotations...
75     //   These are rotations that represent the plane attitude effect on
76     //   the view (in Pilot view).  IE The view frustrum rotates as the plane
77     //   turns, pitches, and rolls.
78     //   In model view (lookat/chaseview) these end up changing the angle that
79     //   the eye is looking at the ojbect (ie the model).
80     //   FIXME: the FGModel class should have its own version of these so that
81     //   it can generate it's own model rotations.
82     virtual double getRoll_deg () const { return _roll_deg; }
83     virtual double getPitch_deg () const {return _pitch_deg; }
84     virtual double getHeading_deg () const {return _heading_deg; }
85     virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
86
87
88     //////////////////////////////////////////////////////////////////////
89     // Part 3: output vectors and matrices in FlightGear coordinates.
90     //////////////////////////////////////////////////////////////////////
91
92     // Vectors and positions...
93
94     // Get zero view_pos
95     virtual float * get_view_pos() { return _relative_view_pos; }
96     // Get the absolute view position in fgfs coordinates.
97     virtual double * get_absolute_view_pos ();
98     // Get zero elev
99     virtual float * get_zero_elev() { return _zero_elev_view_pos; }
100     // Get world up vector
101     virtual float *get_world_up() { return _world_up; }
102     // Get the relative (to scenery center) view position in fgfs coordinates.
103     virtual float * getRelativeViewPos ();
104     // Get the absolute zero-elevation view position in fgfs coordinates.
105     virtual float * getZeroElevViewPos ();
106     // Get surface east vector
107     virtual float *get_surface_east() { return _surface_east; }
108     // Get surface south vector
109     virtual float *get_surface_south() { return _surface_south; }
110     // Elevation of ground under location (based on scenery output)...
111     void set_cur_elev_m ( double elev ) { _cur_elev_m = elev; }
112     inline double get_cur_elev_m () { return _cur_elev_m; }
113     // Interface to current buckets for use with tilemgr...
114     void set_tile_center ( Point3D tile_center ) { _tile_center = tile_center; }
115     inline Point3D get_tile_center () { return _tile_center; }
116
117     // Matrices...
118     virtual const sgVec4 * getTransformMatrix() { if ( _dirty ) { recalc(); }   return TRANS; }
119     virtual const sgVec4 * getCachedTransformMatrix() { return TRANS; }
120     virtual const sgVec4 * getUpMatrix()  { if ( _dirty ) { recalc(); } return UP; }
121     virtual const sgVec4 * getCachedUpMatrix()  { return UP; }
122
123
124 private:
125
126     //////////////////////////////////////////////////////////////////
127     // private data                                                 //
128     //////////////////////////////////////////////////////////////////
129
130     // flag forcing a recalc of derived view parameters
131     bool _dirty;
132
133     mutable sgdVec3 _absolute_view_pos;
134     mutable sgVec3 _relative_view_pos;
135     mutable sgVec3 _zero_elev_view_pos;
136
137     double _lon_deg;
138     double _lat_deg;
139     double _alt_ft;
140
141     double _roll_deg;
142     double _pitch_deg;
143     double _heading_deg;
144
145     // elevation of ground under this location...
146     double _cur_elev_m;
147     Point3D _tile_center;
148
149     // surface vector heading south
150     sgVec3 _surface_south;
151
152     // surface vector heading east (used to unambiguously align sky
153     // with sun)
154     sgVec3 _surface_east;
155
156     // world up vector (normal to the plane tangent to the earth's
157     // surface at the spot we are directly above
158     sgVec3 _world_up;
159
160     // sg versions of our friendly matrices
161     sgMat4 TRANS, UP;
162
163     //////////////////////////////////////////////////////////////////
164     // private functions                                            //
165     //////////////////////////////////////////////////////////////////
166
167     void recalc ();
168     void recalcPosition (double lon_deg, double lat_deg, double alt_ft) const;
169
170     inline void set_dirty() { _dirty = true; }
171     inline void set_clean() { _dirty = false; }
172
173 };
174
175
176 #endif // _LOCATION_HXX