]> git.mxchange.org Git - flightgear.git/blob - src/FDM/flight.hxx
Fix some sim time issues with the locations of the ground cache and the
[flightgear.git] / src / FDM / flight.hxx
1 // flight.hxx -- define shared flight model parameters
2 //
3 // Written by Curtis Olson, started May 1997.
4 //
5 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 //
21 // $Id$
22
23
24 #ifndef _FLIGHT_HXX
25 #define _FLIGHT_HXX
26
27
28 #ifndef __cplusplus
29 # error This library requires C++
30 #endif
31
32
33 /* Required get_()
34
35    `FGInterface::get_Longitude ()'
36    `FGInterface::get_Latitude ()'
37    `FGInterface::get_Altitude ()'
38    `FGInterface::get_Phi ()'
39    `FGInterface::get_Theta ()'
40    `FGInterface::get_Psi ()'
41    `FGInterface::get_V_equiv_kts ()'
42
43    `FGInterface::get_V_north ()'
44    `FGInterface::get_V_east ()'
45    `FGInterface::get_V_down ()'
46
47    `FGInterface::get_P_Body ()'
48    `FGInterface::get_Q_Body ()'
49    `FGInterface::get_R_Body ()'
50
51    `FGInterface::get_Gamma_vert_rad ()'
52    `FGInterface::get_Climb_Rate ()'
53    `FGInterface::get_Alpha ()'
54    `FGInterface::get_Beta ()'
55
56    `FGInterface::get_Runway_altitude ()'
57
58    `FGInterface::get_Lon_geocentric ()'
59    `FGInterface::get_Lat_geocentric ()'
60    `FGInterface::get_Sea_level_radius ()'
61    `FGInterface::get_Earth_position_angle ()'
62
63    `FGInterface::get_Latitude_dot()'
64    `FGInterface::get_Longitude_dot()'
65    `FGInterface::get_Radius_dot()'
66
67    `FGInterface::get_Dx_cg ()'
68    `FGInterface::get_Dy_cg ()'
69    `FGInterface::get_Dz_cg ()'
70
71    `FGInterface::get_Radius_to_vehicle ()'
72
73  */
74
75
76 #include <math.h>
77
78 #include <list>
79 #include <vector>
80 #include <string>
81
82 #include <simgear/compiler.h>
83 #include <simgear/constants.h>
84 #include <simgear/structure/subsystem_mgr.hxx>
85 #include <FDM/groundcache.hxx>
86
87 using std::list;
88 using std::vector;
89 using std::string;
90
91 // This is based heavily on LaRCsim/ls_generic.h
92 class FGInterface : public SGSubsystem {
93
94 private:
95   
96     // Has the init() method been called.  This is used to delay
97     // initialization until scenery can be loaded and we know the true
98     // ground elevation.
99     bool inited;
100
101     // Have we bound to the property system
102     bool bound; 
103
104     // periodic update management variable.  This is a scheme to run
105     // the fdm with a fixed delta-t.  We control how many iteration of
106     // the fdm to run with the fixed dt based on the elapsed time from
107     // the last update.  This allows us to maintain sync with the real
108     // time clock, even though each frame could take a random amount
109     // of time.  Since "dt" is unlikely to divide evenly into the
110     // elapse time, we keep track of the remainder and add it into the
111     // next elapsed time.  This yields a small amount of temporal
112     // jitter ( < dt ) but in practice seems to work well.
113
114     double remainder;           // remainder time from last run
115
116     // CG position w.r.t. ref. point
117     SGVec3d d_cg_rp_body_v;
118
119     // Accelerations
120     SGVec3d v_dot_local_v;
121     SGVec3d v_dot_body_v;
122     SGVec3d a_cg_body_v;
123     SGVec3d a_pilot_body_v;
124     SGVec3d n_cg_body_v;
125     SGVec3d omega_dot_body_v;
126
127     // Velocities
128     SGVec3d v_local_v;
129     SGVec3d v_local_rel_ground_v; // V rel w.r.t. earth surface
130     SGVec3d v_local_airmass_v;    // velocity of airmass (steady winds)
131     SGVec3d v_wind_body_v;        // Wind-relative velocities in body axis
132
133     SGVec3d omega_body_v;         // Angular B rates
134     SGVec3d euler_rates_v;
135     SGVec3d geocentric_rates_v;   // Geocentric linear velocities
136
137     // Positions
138     SGGeod geodetic_position_v;
139     SGVec3d cartesian_position_v;
140     SGGeoc geocentric_position_v;
141     SGVec3d euler_angles_v;
142
143     // Normal Load Factor
144     double nlf;
145
146     // Velocities
147     double v_rel_wind, v_true_kts;
148     double v_ground_speed, v_equiv_kts;
149     double v_calibrated_kts;
150
151     // Miscellaneious Quantities
152     double alpha, beta;  // in radians
153     double gamma_vert_rad;  // Flight path angles
154     double density, mach_number;
155     double static_pressure, total_pressure;
156     double dynamic_pressure;
157     double static_temperature, total_temperature;
158     double sea_level_radius, earth_position_angle;
159     double runway_altitude;
160     double climb_rate;                // in feet per second
161     double altitude_agl;
162
163     double daux[16];            // auxilliary doubles
164     float  faux[16];            // auxilliary floats
165     int    iaux[16];            // auxilliary ints
166
167     // the ground cache object itself.
168     FGGroundCache ground_cache;
169
170 protected:
171
172     int _calc_multiloop (double dt);
173
174 public:
175
176                                 // deliberately not virtual so that
177                                 // FGInterface constructor will call
178                                 // the right version
179     void _setup();
180
181     void _busdump(void);
182     void _updatePositionM(const SGVec3d& cartPos);
183     void _updatePositionFt(const SGVec3d& cartPos) {
184         _updatePositionM(SG_FEET_TO_METER*cartPos);
185     }
186     void _updatePosition(const SGGeod& geod);
187     void _updatePosition(const SGGeoc& geoc);
188   
189     void _updateGeodeticPosition( double lat, double lon, double alt );
190     void _updateGeocentricPosition( double lat_geoc, double lon, double alt );
191     void _update_ground_elev_at_pos( void );
192
193     inline void _set_CG_Position( double dx, double dy, double dz ) {
194         d_cg_rp_body_v[0] = dx;
195         d_cg_rp_body_v[1] = dy;
196         d_cg_rp_body_v[2] = dz;
197     }
198     inline void _set_Accels_Local( double north, double east, double down ) {
199         v_dot_local_v[0] = north;
200         v_dot_local_v[1] = east;
201         v_dot_local_v[2] = down;
202     }
203     inline void _set_Accels_Body( double u, double v, double w ) {
204         v_dot_body_v[0] = u;
205         v_dot_body_v[1] = v;
206         v_dot_body_v[2] = w;
207     }
208     inline void _set_Accels_CG_Body( double x, double y, double z ) {
209         a_cg_body_v[0] = x;
210         a_cg_body_v[1] = y;
211         a_cg_body_v[2] = z;
212     }
213     inline void _set_Accels_Pilot_Body( double x, double y, double z ) {
214         a_pilot_body_v[0] = x;
215         a_pilot_body_v[1] = y;
216         a_pilot_body_v[2] = z;
217     }
218     inline void _set_Accels_CG_Body_N( double x, double y, double z ) {
219         n_cg_body_v[0] = x;
220         n_cg_body_v[1] = y;
221         n_cg_body_v[2] = z;
222     }
223     void _set_Nlf(double n) { nlf=n;  }
224     inline void _set_Velocities_Local( double north, double east, double down ){
225         v_local_v[0] = north;
226         v_local_v[1] = east;
227         v_local_v[2] = down;
228     }
229     inline void _set_Velocities_Ground(double north, double east, double down) {
230         v_local_rel_ground_v[0] = north;
231         v_local_rel_ground_v[1] = east;
232         v_local_rel_ground_v[2] = down;
233     }
234     inline void _set_Velocities_Local_Airmass( double north, double east, 
235                                               double down)
236     {
237         v_local_airmass_v[0] = north;
238         v_local_airmass_v[1] = east;
239         v_local_airmass_v[2] = down;
240     }
241     inline void _set_Velocities_Wind_Body( double u, double v, double w) {
242         v_wind_body_v[0] = u;
243         v_wind_body_v[1] = v;
244         v_wind_body_v[2] = w;
245     }
246     inline void _set_V_rel_wind(double vt) { v_rel_wind = vt; }
247     inline void _set_V_ground_speed( double v) { v_ground_speed = v; }
248     inline void _set_V_equiv_kts( double kts ) { v_equiv_kts = kts; }
249     inline void _set_V_calibrated_kts( double kts ) { v_calibrated_kts = kts; }
250     inline void _set_Omega_Body( double p, double q, double r ) {
251         omega_body_v[0] = p;
252         omega_body_v[1] = q;
253         omega_body_v[2] = r;
254     }
255     inline void _set_Euler_Rates( double phi, double theta, double psi ) {
256         euler_rates_v[0] = phi;
257         euler_rates_v[1] = theta;
258         euler_rates_v[2] = psi;
259     }
260     inline void _set_Geocentric_Rates( double lat, double lon, double rad ) {
261         geocentric_rates_v[0] = lat;
262         geocentric_rates_v[1] = lon;
263         geocentric_rates_v[2] = rad;
264     }
265     inline void _set_Geocentric_Position( double lat, double lon, double rad ) {
266         geocentric_position_v.setLatitudeRad(lat);
267         geocentric_position_v.setLongitudeRad(lon);
268         geocentric_position_v.setRadiusFt(rad);
269     }
270     inline void _set_Latitude(double lat) {
271         geodetic_position_v.setLatitudeRad(lat);
272     }
273     inline void _set_Longitude(double lon) {
274         geodetic_position_v.setLongitudeRad(lon);
275     }
276     inline void _set_Altitude(double altitude) {
277         geodetic_position_v.setElevationFt(altitude);
278     }
279     inline void _set_Altitude_AGL(double agl) {
280         altitude_agl = agl;
281     }
282     inline void _set_Geodetic_Position( double lat, double lon, double alt ) {
283         geodetic_position_v.setLatitudeRad(lat);
284         geodetic_position_v.setLongitudeRad(lon);
285         geodetic_position_v.setElevationFt(alt);
286     }
287     inline void _set_Euler_Angles( double phi, double theta, double psi ) {
288         euler_angles_v[0] = phi;
289         euler_angles_v[1] = theta;
290         euler_angles_v[2] = psi;
291     }
292     // FIXME, for compatibility with JSBSim
293     inline void _set_T_Local_to_Body( int i, int j, double value) { }
294     inline void _set_Alpha( double a ) { alpha = a; }
295     inline void _set_Beta( double b ) { beta = b; }
296     inline void _set_Gamma_vert_rad( double gv ) { gamma_vert_rad = gv; }
297     inline void _set_Density( double d ) { density = d; }
298     inline void _set_Mach_number( double m ) { mach_number = m; }
299     inline void _set_Static_pressure( double sp ) { static_pressure = sp; }
300     inline void _set_Static_temperature( double t ) { static_temperature = t; } 
301     inline void _set_Total_temperature( double tat ) { total_temperature = tat; } //JW
302     inline void _set_Sea_level_radius( double r ) { sea_level_radius = r; }
303     inline void _set_Earth_position_angle(double a) { earth_position_angle = a; }
304     inline void _set_Runway_altitude( double alt ) { runway_altitude = alt; }
305     inline void _set_Climb_Rate(double rate) { climb_rate = rate; }
306
307     inline void _set_daux( int n, double value ) { daux[n] = value; }
308     inline void _set_faux( int n, float value ) { faux[n] = value; }
309     inline void _set_iaux( int n, int value ) { iaux[n] = value; }
310
311 public:
312   
313     FGInterface();
314     FGInterface( double dt );
315     virtual ~FGInterface();
316
317     virtual void init ();
318     virtual void bind ();
319     virtual void unbind ();
320     virtual void update(double dt);
321     virtual bool ToggleDataLogging(bool state) { return false; }
322     virtual bool ToggleDataLogging(void) { return false; }
323
324     // Define the various supported flight models (many not yet implemented)
325     enum {
326         // Magic Carpet mode
327         FG_MAGICCARPET = 0,
328
329         // The NASA LaRCsim (Navion) flight model
330         FG_LARCSIM = 1,
331
332         // Jon S. Berndt's new FDM written from the ground up in C++
333         FG_JSBSIM = 2,
334
335         // Christian's hot air balloon simulation
336         FG_BALLOONSIM = 3,
337
338         // Aeronautical DEvelopment AGEncy, Bangalore India
339         FG_ADA = 4,
340
341         // The following aren't implemented but are here to spark
342         // thoughts and discussions, and maybe even action.
343         FG_ACM = 5,
344         FG_SUPER_SONIC = 6,
345         FG_HELICOPTER = 7,
346         FG_AUTOGYRO = 8,
347         FG_PARACHUTE = 9,
348
349         // Driven externally via a serial port, net, file, etc.
350         FG_EXTERNAL = 10
351     };
352
353     // initialization
354     inline bool get_inited() const { return inited; }
355     inline void set_inited( bool value ) { inited = value; }
356
357     inline bool get_bound() const { return bound; }
358
359     //perform initializion that is common to all FDM's
360     void common_init();
361
362     // Positions
363     virtual void set_Latitude(double lat);       // geocentric
364     virtual void set_Longitude(double lon);    
365     virtual void set_Altitude(double alt);  // triggers re-calc of AGL altitude
366     virtual void set_AltitudeAGL(double altagl); // and vice-versa
367     virtual void set_Latitude_deg (double lat) {
368       set_Latitude(lat * SGD_DEGREES_TO_RADIANS);
369     }
370     virtual void set_Longitude_deg (double lon) {
371       set_Longitude(lon * SGD_DEGREES_TO_RADIANS);
372     }
373     
374     // Speeds -- setting any of these will trigger a re-calc of the rest
375     virtual void set_V_calibrated_kts(double vc);
376     virtual void set_Mach_number(double mach);
377     virtual void set_Velocities_Local( double north, double east, double down );
378     inline void set_V_north (double north) { 
379       set_Velocities_Local(north, v_local_v[1], v_local_v[2]);
380     }
381     inline void set_V_east (double east) { 
382       set_Velocities_Local(v_local_v[0], east, v_local_v[2]);
383     }
384     inline void set_V_down (double down) { 
385       set_Velocities_Local(v_local_v[0], v_local_v[1], down);
386     }
387     virtual void set_Velocities_Wind_Body( double u, double v, double w);
388     virtual void set_uBody (double uBody) { 
389       set_Velocities_Wind_Body(uBody, v_wind_body_v[1], v_wind_body_v[2]);
390     }
391     virtual void set_vBody (double vBody) { 
392       set_Velocities_Wind_Body(v_wind_body_v[0], vBody, v_wind_body_v[2]);
393     }
394     virtual void set_wBody (double wBody) {
395       set_Velocities_Wind_Body(v_wind_body_v[0], v_wind_body_v[1], wBody);
396     }
397     
398     // Euler angles 
399     virtual void set_Euler_Angles( double phi, double theta, double psi );
400     virtual void set_Phi (double phi) {
401       set_Euler_Angles(phi, get_Theta(), get_Psi());
402     }
403     virtual void set_Theta (double theta) {
404       set_Euler_Angles(get_Phi(), theta, get_Psi());
405     }
406     virtual void set_Psi (double psi) { 
407       set_Euler_Angles(get_Phi(), get_Theta(), psi);
408     }
409     virtual void set_Phi_deg (double phi) {
410       set_Phi(phi * SGD_DEGREES_TO_RADIANS);
411     }
412     virtual void set_Theta_deg (double theta) {
413       set_Theta(theta * SGD_DEGREES_TO_RADIANS); 
414     }
415     virtual void set_Psi_deg (double psi) {
416       set_Psi(psi * SGD_DEGREES_TO_RADIANS);
417     }
418     
419     // Flight Path
420     virtual void set_Climb_Rate( double roc);
421     virtual void set_Gamma_vert_rad( double gamma);
422     
423     // Earth
424     
425     virtual void set_Static_pressure(double p);
426     virtual void set_Static_temperature(double T);
427     virtual void set_Density(double rho);
428     
429     virtual void set_Velocities_Local_Airmass (double wnorth, 
430                                                double weast, 
431                                                double wdown );
432
433     // ========== Mass properties and geometry values ==========
434
435     // CG position w.r.t. ref. point
436     inline double get_Dx_cg() const { return d_cg_rp_body_v[0]; }
437     inline double get_Dy_cg() const { return d_cg_rp_body_v[1]; }
438     inline double get_Dz_cg() const { return d_cg_rp_body_v[2]; }
439
440     // ========== Accelerations ==========
441
442     inline double get_V_dot_north() const { return v_dot_local_v[0]; }
443     inline double get_V_dot_east() const { return v_dot_local_v[1]; }
444     inline double get_V_dot_down() const { return v_dot_local_v[2]; }
445
446     inline double get_U_dot_body() const { return v_dot_body_v[0]; }
447     inline double get_V_dot_body() const { return v_dot_body_v[1]; }
448     inline double get_W_dot_body() const { return v_dot_body_v[2]; }
449
450     inline double get_A_X_cg() const { return a_cg_body_v[0]; }
451     inline double get_A_Y_cg() const { return a_cg_body_v[1]; }
452     inline double get_A_Z_cg() const { return a_cg_body_v[2]; }
453
454     inline double get_A_X_pilot() const { return a_pilot_body_v[0]; }
455     inline double get_A_Y_pilot() const { return a_pilot_body_v[1]; }
456     inline double get_A_Z_pilot() const { return a_pilot_body_v[2]; }
457
458     inline double get_N_X_cg() const { return n_cg_body_v[0]; }
459     inline double get_N_Y_cg() const { return n_cg_body_v[1]; }
460     inline double get_N_Z_cg() const { return n_cg_body_v[2]; }
461
462     inline double get_Nlf(void) const { return nlf; }
463
464     // ========== Velocities ==========
465
466     inline double get_V_north() const { return v_local_v[0]; }
467     inline double get_V_east() const { return v_local_v[1]; }
468     inline double get_V_down() const { return v_local_v[2]; }
469     inline double get_uBody () const { return v_wind_body_v[0]; }
470     inline double get_vBody () const { return v_wind_body_v[1]; }
471     inline double get_wBody () const { return v_wind_body_v[2]; }
472
473     // Please dont comment these out. fdm=ada uses these (see
474     // cockpit.cxx) --->
475     inline double get_V_north_rel_ground() const {
476         return v_local_rel_ground_v[0];
477     }
478     inline double get_V_east_rel_ground() const {
479         return v_local_rel_ground_v[1];
480     }
481     inline double get_V_down_rel_ground() const {
482         return v_local_rel_ground_v[2];
483     }
484     // <--- fdm=ada uses these (see cockpit.cxx)
485
486     inline double get_V_north_airmass() const { return v_local_airmass_v[0]; }
487     inline double get_V_east_airmass() const { return v_local_airmass_v[1]; }
488     inline double get_V_down_airmass() const { return v_local_airmass_v[2]; }
489
490     inline double get_U_body() const { return v_wind_body_v[0]; }
491     inline double get_V_body() const { return v_wind_body_v[1]; }
492     inline double get_W_body() const { return v_wind_body_v[2]; }
493
494     inline double get_V_rel_wind() const { return v_rel_wind; }
495
496     inline double get_V_true_kts() const { return v_true_kts; }
497
498     inline double get_V_ground_speed() const { return v_ground_speed; }
499     inline double get_V_ground_speed_kt() const { return v_ground_speed * SG_FEET_TO_METER * 3600 * SG_METER_TO_NM; }
500
501     inline double get_V_equiv_kts() const { return v_equiv_kts; }
502
503     inline double get_V_calibrated_kts() const { return v_calibrated_kts; }
504
505     inline double get_P_body() const { return omega_body_v[0]; }
506     inline double get_Q_body() const { return omega_body_v[1]; }
507     inline double get_R_body() const { return omega_body_v[2]; }
508
509     inline double get_Phi_dot() const { return euler_rates_v[0]; }
510     inline double get_Theta_dot() const { return euler_rates_v[1]; }
511     inline double get_Psi_dot() const { return euler_rates_v[2]; }
512     inline double get_Phi_dot_degps() const { return euler_rates_v[0] * SGD_RADIANS_TO_DEGREES; }
513     inline double get_Theta_dot_degps() const { return euler_rates_v[1] * SGD_RADIANS_TO_DEGREES; }
514     inline double get_Psi_dot_degps() const { return euler_rates_v[2] * SGD_RADIANS_TO_DEGREES; }
515
516     inline double get_Latitude_dot() const { return geocentric_rates_v[0]; }
517     inline double get_Longitude_dot() const { return geocentric_rates_v[1]; }
518     inline double get_Radius_dot() const { return geocentric_rates_v[2]; }
519
520     // ========== Positions ==========
521
522     inline double get_Lat_geocentric() const {
523         return geocentric_position_v.getLatitudeRad();
524     }
525     inline double get_Lon_geocentric() const {
526         return geocentric_position_v.getLongitudeRad();
527     }
528     inline double get_Radius_to_vehicle() const {
529         return geocentric_position_v.getRadiusFt();
530     }
531
532     const SGGeod& getPosition() const { return geodetic_position_v; }
533     const SGGeoc& getGeocPosition() const { return geocentric_position_v; }
534     const SGVec3d& getCartPosition() const { return cartesian_position_v; }
535
536     inline double get_Latitude() const {
537         return geodetic_position_v.getLatitudeRad();
538     }
539     inline double get_Longitude() const {
540         return geodetic_position_v.getLongitudeRad();
541     }
542     inline double get_Altitude() const {
543         return geodetic_position_v.getElevationFt();
544     }
545     inline double get_Altitude_AGL(void) const { return altitude_agl; }
546
547     inline double get_Latitude_deg () const {
548       return geodetic_position_v.getLatitudeDeg();
549     }
550     inline double get_Longitude_deg () const {
551       return geodetic_position_v.getLongitudeDeg();
552     }
553
554     inline double get_Phi() const { return euler_angles_v[0]; }
555     inline double get_Theta() const { return euler_angles_v[1]; }
556     inline double get_Psi() const { return euler_angles_v[2]; }
557     inline double get_Phi_deg () const { return get_Phi() * SGD_RADIANS_TO_DEGREES; }
558     inline double get_Theta_deg () const { return get_Theta() * SGD_RADIANS_TO_DEGREES; }
559     inline double get_Psi_deg () const { return get_Psi() * SGD_RADIANS_TO_DEGREES; }
560
561
562     // ========== Miscellaneous quantities ==========
563
564     inline double get_Alpha() const { return alpha; }
565     inline double get_Alpha_deg() const { return alpha * SGD_RADIANS_TO_DEGREES; }
566     inline double get_Beta() const { return beta; }
567     inline double get_Beta_deg() const { return beta * SGD_RADIANS_TO_DEGREES; }
568     inline double get_Gamma_vert_rad() const { return gamma_vert_rad; }
569
570     inline double get_Density() const { return density; }
571     inline double get_Mach_number() const { return mach_number; }
572
573     inline double get_Static_pressure() const { return static_pressure; }
574     inline double get_Total_pressure() const { return total_pressure; }
575     inline double get_Dynamic_pressure() const { return dynamic_pressure; }
576
577     inline double get_Static_temperature() const { return static_temperature; }
578     inline double get_Total_temperature() const { return total_temperature; }
579
580     inline double get_Sea_level_radius() const { return sea_level_radius; }
581     inline double get_Earth_position_angle() const {
582         return earth_position_angle;
583     }
584
585     inline double get_Runway_altitude() const { return runway_altitude; }
586     inline double get_Runway_altitude_m() const { return SG_FEET_TO_METER * runway_altitude; }
587
588     inline double get_Climb_Rate() const { return climb_rate; }
589
590     // Auxilliary variables
591     inline double get_daux( int n ) const { return daux[n]; }
592     inline float  get_faux( int n ) const { return faux[n]; }
593     inline int    get_iaux( int n ) const { return iaux[n]; }
594
595     // Note that currently this is the "same" value runway altitude...
596     inline double get_ground_elev_ft() const { return runway_altitude; }
597
598
599     //////////////////////////////////////////////////////////////////////////
600     // Ground handling routines
601     //////////////////////////////////////////////////////////////////////////
602
603     // Prepare the ground cache for the wgs84 position pt_*.
604     // That is take all vertices in the ball with radius rad around the
605     // position given by the pt_* and store them in a local scene graph.
606     bool prepare_ground_cache_m(double startSimTime, double endSimTime,
607                                 const double pt[3], double rad);
608     bool prepare_ground_cache_ft(double startSimTime, double endSimTime,
609                                  const double pt[3], double rad);
610
611
612     // Returns true if the cache is valid.
613     // Also the reference time, point and radius values where the cache
614     // is valid for are returned.
615     bool is_valid_m(double *ref_time, double pt[3], double *rad);
616     bool is_valid_ft(double *ref_time, double pt[3], double *rad);
617
618     // Return the nearest catapult to the given point
619     // pt in wgs84 coordinates.
620     double get_cat_m(double t, const double pt[3],
621                      double end[2][3], double vel[2][3]);
622     double get_cat_ft(double t, const double pt[3],
623                       double end[2][3], double vel[2][3]);
624   
625
626     // Return the orientation and position matrix and the linear and angular
627     // velocity of that local coordinate systems origin for a given time and
628     // body id. The velocities are in the wgs84 frame at the bodys origin.
629     bool get_body_m(double t, simgear::BVHNode::Id id, double bodyToWorld[16],
630                     double linearVel[3], double angularVel[3]);
631
632
633     // Return the altitude above ground below the wgs84 point pt
634     // Search for the nearest triangle to pt in downward direction.
635     // Return ground properties. The velocities are in the wgs84 frame at the
636     // contact point.
637     bool get_agl_m(double t, const double pt[3], double max_altoff,
638                    double contact[3], double normal[3], double linearVel[3],
639                    double angularVel[3], SGMaterial const*& material,
640                    simgear::BVHNode::Id& id);
641     bool get_agl_ft(double t, const double pt[3], double max_altoff,
642                     double contact[3], double normal[3], double linearVel[3],
643                     double angularVel[3], SGMaterial const*& material,
644                     simgear::BVHNode::Id& id);
645     double get_groundlevel_m(double lat, double lon, double alt);
646     double get_groundlevel_m(const SGGeod& geod);
647
648
649     // Return the nearest point in any direction to the point pt with a maximum
650     // distance maxDist. The velocities are in the wgs84 frame at the query
651     // position pt.
652     bool get_nearest_m(double t, const double pt[3], double maxDist,
653                        double contact[3], double normal[3], double linearVel[3],
654                        double angularVel[3], SGMaterial const*& material,
655                        simgear::BVHNode::Id& id);
656     bool get_nearest_ft(double t, const double pt[3], double maxDist,
657                         double contact[3], double normal[3],double linearVel[3],
658                         double angularVel[3], SGMaterial const*& material,
659                         simgear::BVHNode::Id& id);
660
661
662     // Return 1 if the hook intersects with a wire.
663     // That test is done by checking if the quad spanned by the points pt*
664     // intersects with the line representing the wire.
665     // If the wire is caught, the cache will trace this wires endpoints until
666     // the FDM calls release_wire().
667     bool caught_wire_m(double t, const double pt[4][3]);
668     bool caught_wire_ft(double t, const double pt[4][3]);
669   
670     // Return the location and speed of the wire endpoints.
671     bool get_wire_ends_m(double t, double end[2][3], double vel[2][3]);
672     bool get_wire_ends_ft(double t, double end[2][3], double vel[2][3]);
673
674     // Tell the cache code that it does no longer need to care for
675     // the wire end position.
676     void release_wire(void);
677 };
678
679 extern FGInterface * cur_fdm_state;
680
681 // Toggle data logging on/off
682 void fgToggleFDMdataLogging(void);
683
684
685 #endif // _FLIGHT_HXX