src/AIModel/AIBase.cxx

   1 // FGAIBase - abstract base class for AI objects
   2 // Written by David Culp, started Nov 2003, based on
   3 // David Luff's FGAIEntity class.
   4 // - davidculp2@comcast.net
   5 //
   6 // With additions by Mathias Froehlich & Vivian Meazza 2004 -2007
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <simgear/compiler.h>
  28
  29 #include STL_STRING
  30
  31 #include <osg/ref_ptr>
  32 #include <osg/Node>
  33
  34 #include <simgear/math/point3d.hxx>
  35 #include <simgear/math/polar3d.hxx>
  36 #include <simgear/math/sg_geodesy.hxx>
  37 #include <simgear/misc/sg_path.hxx>
  38 #include <simgear/scene/model/location.hxx>
  39 #include <simgear/scene/model/model.hxx>
  40 #include <simgear/scene/util/SGNodeMasks.hxx>
  41 #include <simgear/debug/logstream.hxx>
  42 #include <simgear/props/props.hxx>
  43
  44 #include <Main/globals.hxx>
  45 #include <Scenery/scenery.hxx>
  46
  47
  48 #include "AIBase.hxx"
  49 #include "AIManager.hxx"
  50
  51
  52 const double FGAIBase::e = 2.71828183;
  53 const double FGAIBase::lbs_to_slugs = 0.031080950172;   //conversion factor
  54
  55
  56 FGAIBase::FGAIBase(object_type ot) :
  57     props( NULL ),
  58     model_removed( fgGetNode("/ai/models/model-removed", true) ),
  59     manager( NULL ),
  60     fp( NULL ),
  61     _refID( _newAIModelID() ),
  62     _otype(ot)
  63 {
  64     tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
  65     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
  66     bearing = elevation = range = rdot = 0.0;
  67     x_shift = y_shift = rotation = 0.0;
  68     in_range = false;
  69     invisible = true;
  70     no_roll = true;
  71     life = 900;
  72     delete_me = false;
  73 }
  74
  75 FGAIBase::~FGAIBase() {
  76     // Unregister that one at the scenery manager
  77     if (globals->get_scenery()) {
  78         globals->get_scenery()->unregister_placement_transform(aip.getTransform());
  79         globals->get_scenery()->get_scene_graph()->removeChild(aip.getSceneGraph());
  80     }
  81
  82     if (props) {
  83         SGPropertyNode* parent = props->getParent();
  84
  85         if (parent) {
  86             model_removed->setStringValue(props->getPath());
  87             parent->removeChild(props->getName(), props->getIndex(), false);
  88         }
  89
  90         // so that radar does not have to do extra checks
  91         props->setBoolValue("radar/in-range", false);
  92         props->removeChild("id", 0);
  93
  94     }
  95     delete fp;
  96     fp = 0;
  97 }
  98
  99 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
 100 {
 101     if (!scFileNode)
 102         return;
 103
 104     setPath(scFileNode->getStringValue("model", "Models/Geometry/glider.ac"));
 105
 106     setHeading(scFileNode->getDoubleValue("heading", 0.0));
 107     setSpeed(scFileNode->getDoubleValue("speed", 0.0));
 108     setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
 109     setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
 110     setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
 111     setBank(scFileNode->getDoubleValue("roll", 0.0));
 112
 113     SGPropertyNode* submodels = scFileNode->getChild("submodels");
 114
 115     if (submodels) {
 116         setServiceable(submodels->getBoolValue("serviceable", false));
 117         setSMPath(submodels->getStringValue("path", ""));
 118     }
 119
 120 }
 121
 122 void FGAIBase::update(double dt) {
 123
 124     if (_otype == otStatic)
 125         return;
 126
 127     if (_otype == otBallistic)
 128         CalculateMach();
 129
 130     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
 131     ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
 132 }
 133
 134 void FGAIBase::Transform() {
 135
 136     if (!invisible) {
 137       aip.setPosition(pos);
 138
 139         if (no_roll)
 140          aip.setOrientation(0.0, pitch, hdg);
 141         else
 142          aip.setOrientation(roll, pitch, hdg);
 143
 144       aip.update();
 145     }
 146
 147 }
 148
 149 bool FGAIBase::init(bool search_in_AI_path) {
 150
 151     if (!model_path.empty()) {
 152
 153      if ( (search_in_AI_path)
 154           &&(model_path.substr(model_path.size() - 4, 4) == ".xml")) {
 155        SGPath ai_path("AI");
 156        ai_path.append(model_path);
 157        try {
 158          model = load3DModel( globals->get_fg_root(), ai_path.str(), props,
 159                         globals->get_sim_time_sec() );
 160        } catch (const sg_exception &e) {
 161          model = NULL;
 162        }
 163      } else
 164         model = NULL;
 165
 166      if (!model) {
 167        try {
 168          model = load3DModel( globals->get_fg_root(), model_path, props,
 169                         globals->get_sim_time_sec() );
 170        } catch (const sg_exception &e) {
 171          model = NULL;
 172        }
 173      }
 174
 175    }
 176
 177    if (model.get()) {
 178      aip.init( model.get() );
 179      aip.setVisible(true);
 180      invisible = false;
 181      globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
 182
 183      // Register that one at the scenery manager
 184      globals->get_scenery()->register_placement_transform(aip.getTransform());
 185      fgSetString("/ai/models/model-added", props->getPath());
 186    } else {
 187
 188         if (!model_path.empty())
 189        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
 190
 191    }
 192
 193     props->setStringValue("submodels/path", _path.c_str());
 194    setDie(false);
 195    return true;
 196 }
 197
 198
 199 osg::Node* FGAIBase::load3DModel(const string& fg_root,
 200                       const string &path,
 201                       SGPropertyNode *prop_root,
 202                       double sim_time_sec)
 203 {
 204   model = sgLoad3DModel(fg_root, path, prop_root, sim_time_sec);
 205   model->setNodeMask(model->getNodeMask() & ~SG_NODEMASK_TERRAIN_BIT);
 206   return model.get();
 207 }
 208
 209 bool FGAIBase::isa( object_type otype ) {
 210
 211   if ( otype == _otype )
 212     return true;
 213   else
 214     return false;
 215 }
 216
 217
 218 void FGAIBase::bind() {
 219    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 220                                          &FGAIBase::getID));
 221    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 222    props->tie("velocities/vertical-speed-fps",
 223                SGRawValueMethods<FGAIBase,double>(*this,
 224                                          &FGAIBase::_getVS_fps,
 225                                          &FGAIBase::_setVS_fps));
 226
 227    props->tie("position/altitude-ft",
 228                SGRawValueMethods<FGAIBase,double>(*this,
 229                                          &FGAIBase::_getAltitude,
 230                                          &FGAIBase::_setAltitude));
 231    props->tie("position/latitude-deg",
 232                SGRawValueMethods<FGAIBase,double>(*this,
 233                                          &FGAIBase::_getLatitude,
 234                                          &FGAIBase::_setLatitude));
 235    props->tie("position/longitude-deg",
 236                SGRawValueMethods<FGAIBase,double>(*this,
 237                                          &FGAIBase::_getLongitude,
 238                                          &FGAIBase::_setLongitude));
 239
 240    props->tie("position/global-x",
 241                SGRawValueMethods<FGAIBase,double>(*this,
 242                                          &FGAIBase::_getCartPosX,
 243                                          0));
 244    props->tie("position/global-y",
 245                SGRawValueMethods<FGAIBase,double>(*this,
 246                                          &FGAIBase::_getCartPosY,
 247                                          0));
 248    props->tie("position/global-z",
 249                SGRawValueMethods<FGAIBase,double>(*this,
 250                                          &FGAIBase::_getCartPosZ,
 251                                          0));
 252
 253    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 254    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 255    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 256
 257    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 258    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 259    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 260    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 261    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 262    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 263    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 264    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 265    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 266    props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
 267
 268    props->tie("controls/lighting/nav-lights",
 269                SGRawValueFunctions<bool>(_isNight));
 270    props->setBoolValue("controls/lighting/beacon", true);
 271    props->setBoolValue("controls/lighting/strobe", true);
 272    props->setBoolValue("controls/glide-path", true);
 273
 274    props->setStringValue("controls/flight/lateral-mode", "roll");
 275    props->setDoubleValue("controls/flight/target-hdg", hdg);
 276    props->setDoubleValue("controls/flight/target-roll", roll);
 277
 278    props->setStringValue("controls/flight/longitude-mode", "alt");
 279    props->setDoubleValue("controls/flight/target-alt", altitude_ft);
 280    props->setDoubleValue("controls/flight/target-pitch", pitch);
 281
 282    props->setDoubleValue("controls/flight/target-spd", speed);
 283
 284 }
 285
 286 void FGAIBase::unbind() {
 287     props->untie("id");
 288     props->untie("velocities/true-airspeed-kt");
 289     props->untie("velocities/vertical-speed-fps");
 290
 291     props->untie("position/altitude-ft");
 292     props->untie("position/latitude-deg");
 293     props->untie("position/longitude-deg");
 294     props->untie("position/global-x");
 295     props->untie("position/global-y");
 296     props->untie("position/global-z");
 297
 298     props->untie("orientation/pitch-deg");
 299     props->untie("orientation/roll-deg");
 300     props->untie("orientation/true-heading-deg");
 301
 302     props->untie("radar/in-range");
 303     props->untie("radar/bearing-deg");
 304     props->untie("radar/elevation-deg");
 305     props->untie("radar/range-nm");
 306     props->untie("radar/h-offset");
 307     props->untie("radar/v-offset");
 308     props->untie("radar/x-shift");
 309     props->untie("radar/y-shift");
 310     props->untie("radar/rotation");
 311     props->untie("radar/ht-diff-ft");
 312
 313     props->untie("controls/lighting/nav-lights");
 314 }
 315
 316 double FGAIBase::UpdateRadar(FGAIManager* manager) {
 317    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 318    bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
 319    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 320    radar_range_ft2 *= radar_range_ft2;
 321
 322    double user_latitude  = manager->get_user_latitude();
 323    double user_longitude = manager->get_user_longitude();
 324    double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
 325    double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
 326    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 327
 328    //
 329    // Test whether the target is within radar range.
 330    //
 331    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 332
 333    if ( in_range || force_on ) {
 334      props->setBoolValue("radar/in-range", true);
 335
 336      // copy values from the AIManager
 337      double user_altitude  = manager->get_user_altitude();
 338      double user_heading   = manager->get_user_heading();
 339      double user_pitch     = manager->get_user_pitch();
 340      //double user_yaw       = manager->get_user_yaw();
 341      //double user_speed     = manager->get_user_speed();
 342
 343      // calculate range to target in feet and nautical miles
 344      double range_ft = sqrt( range_ft2 );
 345      range = range_ft / 6076.11549;
 346
 347      // calculate bearing to target
 348      if (pos.getLatitudeDeg() >= user_latitude) {
 349         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 350         if (pos.getLongitudeDeg() >= user_longitude) {
 351            bearing = 90.0 - bearing;
 352         } else {
 353            bearing = 270.0 + bearing;
 354         }
 355      } else {
 356         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 357         if (pos.getLongitudeDeg() >= user_longitude) {
 358            bearing = 180.0 - bearing;
 359         } else {
 360            bearing = 180.0 + bearing;
 361         }
 362      }
 363
 364      // This is an alternate way to compute bearing and distance which
 365      // agrees with the original scheme within about 0.1 degrees.
 366      //
 367      // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
 368      //                user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
 369      // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
 370      // double gc_bearing, gc_range;
 371      // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
 372      // gc_range *= SG_METER_TO_NM;
 373      // gc_bearing *= SGD_RADIANS_TO_DEGREES;
 374      // printf("orig b = %.3f %.2f  gc b= %.3f, %.2f\n",
 375      //        bearing, range, gc_bearing, gc_range);
 376
 377      // calculate look left/right to target, without yaw correction
 378      horiz_offset = bearing - user_heading;
 379      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 380      if (horiz_offset < -180.0) horiz_offset += 360.0;
 381
 382      // calculate elevation to target
 383      elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
 384
 385      // calculate look up/down to target
 386      vert_offset = elevation - user_pitch;
 387
 388      /* this calculation needs to be fixed, but it isn't important anyway
 389      // calculate range rate
 390      double recip_bearing = bearing + 180.0;
 391      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 392      double my_horiz_offset = recip_bearing - hdg;
 393      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 394      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 395      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 396              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 397 */
 398
 399      // now correct look left/right for yaw
 400      // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
 401
 402      // calculate values for radar display
 403      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 404      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 405      rotation = hdg - user_heading;
 406      if (rotation < 0.0) rotation += 360.0;
 407      ht_diff = altitude_ft - user_altitude;
 408
 409    }
 410
 411    return range_ft2;
 412 }
 413
 414 /*
 415 * Getters and Setters
 416 */
 417
 418 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
 419     // Transform that one to the horizontal local coordinate system.
 420   SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
 421
 422   // and postrotate the orientation of the AIModel wrt the horizontal
 423   // local frame
 424   hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 425
 426   // The offset converted to the usual body fixed coordinate system
 427   // rotated to the earth fiexed coordinates axis
 428   SGVec3d off = hlTrans.backTransform(_off);
 429
 430   // Add the position offset of the AIModel to gain the earth centered position
 431   SGVec3d cartPos = SGVec3d::fromGeod(pos);
 432
 433   return cartPos + off;
 434 }
 435
 436 SGVec3d FGAIBase::getCartPos() const {
 437   // Transform that one to the horizontal local coordinate system.
 438   SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
 439
 440   // and postrotate the orientation of the AIModel wrt the horizontal
 441   // local frame
 442   hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 443
 444   SGVec3d cartPos = SGVec3d::fromGeod(pos);
 445
 446   return cartPos;
 447 }
 448
 449 double FGAIBase::_getCartPosX() const {
 450     SGVec3d cartPos = getCartPos();
 451     return cartPos.x();
 452 }
 453
 454 double FGAIBase::_getCartPosY() const {
 455     SGVec3d cartPos = getCartPos();
 456     return cartPos.y();
 457 }
 458
 459 double FGAIBase::_getCartPosZ() const {
 460     SGVec3d cartPos = getCartPos();
 461     return cartPos.z();
 462 }
 463
 464 void FGAIBase::_setLongitude( double longitude ) {
 465     pos.setLongitudeDeg(longitude);
 466 }
 467
 468 void FGAIBase::_setLatitude ( double latitude )  {
 469     pos.setLatitudeDeg(latitude);
 470 }
 471
 472 double FGAIBase::_getLongitude() const {
 473     return pos.getLongitudeDeg();
 474 }
 475
 476 double FGAIBase::_getLatitude () const {
 477     return pos.getLatitudeDeg();
 478 }
 479
 480 double FGAIBase::_getRdot() const {
 481     return rdot;
 482 }
 483
 484 double FGAIBase::_getVS_fps() const {
 485     return vs*60.0;
 486 }
 487
 488 double FGAIBase::_get_speed_east_fps() const {
 489     return speed_east_deg_sec * ft_per_deg_lon;
 490 }
 491
 492 double FGAIBase::_get_speed_north_fps() const {
 493     return speed_north_deg_sec * ft_per_deg_lat;
 494 }
 495
 496 void FGAIBase::_setVS_fps( double _vs ) {
 497     vs = _vs/60.0;
 498 }
 499
 500 double FGAIBase::_getAltitude() const {
 501     return altitude_ft;
 502 }
 503
 504 bool FGAIBase::_getServiceable() const {
 505     return serviceable;
 506 }
 507
 508 void FGAIBase::_setAltitude( double _alt ) {
 509     setAltitude( _alt );
 510 }
 511
 512 bool FGAIBase::_isNight() {
 513     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 514 }
 515
 516 int FGAIBase::getID() const {
 517     return  _refID;
 518 }
 519
 520 double FGAIBase::_getSpeed() const {
 521     return speed;
 522 }
 523
 524 double FGAIBase::_getRoll() const {
 525     return roll;
 526 }
 527
 528 double FGAIBase::_getPitch() const {
 529     return pitch;
 530 }
 531
 532 double FGAIBase::_getHeading() const {
 533     return hdg;
 534 }
 535
 536 const char* FGAIBase::_getPath() {
 537     return _path.c_str();
 538 }
 539
 540 void FGAIBase::CalculateMach() {
 541     // Calculate rho at altitude, using standard atmosphere
 542     // For the temperature T and the pressure p,
 543     double altitude = altitude_ft;
 544
 545     if (altitude < 36152) {             // curve fits for the troposphere
 546       T = 59 - 0.00356 * altitude;
 547       p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
 548     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
 549       T = -70;
 550       p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
 551     } else {                                    //  upper stratosphere
 552       T = -205.05 + (0.00164 * altitude);
 553       p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
 554     }
 555
 556     rho = p / (1718 * (T + 459.7));
 557
 558     // calculate the speed of sound at altitude
 559     // a = sqrt ( g * R * (T + 459.7))
 560     // where:
 561     // a = speed of sound [ft/s]
 562     // g = specific heat ratio, which is usually equal to 1.4
 563     // R = specific gas constant, which equals 1716 ft-lb/slug/°R
 564     a = sqrt ( 1.4 * 1716 * (T + 459.7));
 565
 566     // calculate Mach number
 567     Mach = speed/a;
 568
 569 //    cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
 570 }
 571
 572 int FGAIBase::_newAIModelID() {
 573     static int id = 0;
 574
 575    if (!++id)
 576       id++;     // id = 0 is not allowed.
 577
 578    return id;
 579 }
 580