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