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