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 <string.h>
  28
  29 #include <simgear/compiler.h>
  30
  31 #include <boost/foreach.hpp>
  32 #include <string>
  33
  34 #include <osg/ref_ptr>
  35 #include <osg/Node>
  36 #include <osgDB/FileUtils>
  37
  38 #include <simgear/misc/sg_path.hxx>
  39 #include <simgear/scene/model/modellib.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 #include <Scripting/NasalSys.hxx>
  47 #include <Scripting/NasalModelData.hxx>
  48 #include <Sound/fg_fx.hxx>
  49
  50 #include "AIBase.hxx"
  51 #include "AIManager.hxx"
  52
  53 const char *default_model = "Models/Geometry/glider.ac";
  54 const double FGAIBase::e = 2.71828183;
  55 const double FGAIBase::lbs_to_slugs = 0.031080950172;   //conversion factor
  56
  57 using std::string;
  58 using namespace simgear;
  59
  60 class FGAIModelData : public simgear::SGModelData {
  61 public:
  62     FGAIModelData(SGPropertyNode *root = NULL)
  63         : _nasal( new FGNasalModelDataProxy(root) ),
  64         _ready(false),
  65         _initialized(false)
  66     {
  67     }
  68
  69
  70     ~FGAIModelData()
  71     {
  72     }
  73
  74     virtual FGAIModelData* clone() const { return new FGAIModelData(); }
  75
  76     /** osg callback, thread-safe */
  77     void modelLoaded(const std::string& path, SGPropertyNode *prop, osg::Node *n)
  78     {
  79         // WARNING: Called in a separate OSG thread! Only use thread-safe stuff here...
  80         if (_ready)
  81             return;
  82
  83         _fxpath = prop->getStringValue("sound/path");
  84         _nasal->modelLoaded(path, prop, n);
  85
  86         _ready = true;
  87
  88     }
  89
  90     /** init hook to be called after model is loaded.
  91      * Not thread-safe. Call from main thread only. */
  92     void init(void) { _initialized = true; }
  93
  94     bool needInitilization(void) { return _ready && !_initialized;}
  95     bool isInitialized(void) { return _initialized;}
  96     inline std::string& get_sound_path() { return _fxpath;}
  97
  98 private:
  99     std::auto_ptr<FGNasalModelDataProxy> _nasal;
 100     std::string _fxpath;
 101     bool _ready;
 102     bool _initialized;
 103 };
 104
 105 FGAIBase::FGAIBase(object_type ot, bool enableHot) :
 106     _max_speed(300),
 107     _name(""),
 108     _parent(""),
 109     props( NULL ),
 110     model_removed( fgGetNode("/ai/models/model-removed", true) ),
 111     manager( NULL ),
 112     _installed(false),
 113     fp( NULL ),
 114     _impact_lat(0),
 115     _impact_lon(0),
 116     _impact_elev(0),
 117     _impact_hdg(0),
 118     _impact_pitch(0),
 119     _impact_roll(0),
 120     _impact_speed(0),
 121     _refID( _newAIModelID() ),
 122     _otype(ot),
 123     _initialized(false),
 124     _modeldata(0),
 125     _fx(0)
 126 {
 127     tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
 128     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
 129     bearing = elevation = range = rdot = 0.0;
 130     x_shift = y_shift = rotation = 0.0;
 131     in_range = false;
 132     invisible = false;
 133     no_roll = true;
 134     life = 900;
 135     delete_me = false;
 136     _impact_reported = false;
 137     _collision_reported = false;
 138     _expiry_reported = false;
 139
 140     _subID = 0;
 141
 142     _x_offset = 0;
 143     _y_offset = 0;
 144     _z_offset = 0;
 145
 146     _pitch_offset = 0;
 147     _roll_offset = 0;
 148     _yaw_offset = 0;
 149
 150     pos = SGGeod::fromDeg(0, 0);
 151     speed = 0;
 152     altitude_ft = 0;
 153     speed_north_deg_sec = 0;
 154     speed_east_deg_sec = 0;
 155     turn_radius_ft = 0;
 156
 157     ft_per_deg_lon = 0;
 158     ft_per_deg_lat = 0;
 159
 160     horiz_offset = 0;
 161     vert_offset = 0;
 162     ht_diff = 0;
 163
 164     serviceable = false;
 165
 166     fp = 0;
 167
 168     rho = 1;
 169     T = 280;
 170     p = 1e5;
 171     a = 340;
 172     Mach = 0;
 173
 174     // explicitly disable HOT for (most) AI models
 175     if (!enableHot)
 176         aip.getSceneGraph()->setNodeMask(~SG_NODEMASK_TERRAIN_BIT);
 177 }
 178
 179 FGAIBase::~FGAIBase() {
 180     // Unregister that one at the scenery manager
 181     removeModel();
 182
 183     if (props) {
 184         SGPropertyNode* parent = props->getParent();
 185
 186         if (parent)
 187             model_removed->setStringValue(props->getPath());
 188     }
 189
 190     removeSoundFx();
 191
 192     if (fp)
 193         delete fp;
 194     fp = 0;
 195 }
 196
 197 /** Cleanly remove the model
 198  * and let the scenery database pager do the clean-up work.
 199  */
 200 void
 201 FGAIBase::removeModel()
 202 {
 203     if (!_model.valid())
 204         return;
 205
 206     FGScenery* pSceneryManager = globals->get_scenery();
 207     if (pSceneryManager)
 208     {
 209         osg::ref_ptr<osg::Object> temp = _model.get();
 210         pSceneryManager->get_scene_graph()->removeChild(aip.getSceneGraph());
 211         // withdraw from SGModelPlacement and drop own reference (unref)
 212         aip.init( 0 );
 213         _model = 0;
 214         // pass it on to the pager, to be be deleted in the pager thread
 215         pSceneryManager->getPager()->queueDeleteRequest(temp);
 216     }
 217     else
 218     {
 219         SG_LOG(SG_AI, SG_ALERT, "AIBase: Could not unload model. Missing scenery manager!");
 220     }
 221 }
 222
 223 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
 224 {
 225     if (!scFileNode)
 226         return;
 227
 228     setPath(scFileNode->getStringValue("model",
 229             fgGetString("/sim/multiplay/default-model", default_model)));
 230
 231     setHeading(scFileNode->getDoubleValue("heading", 0.0));
 232     setSpeed(scFileNode->getDoubleValue("speed", 0.0));
 233     setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
 234     setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
 235     setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
 236     setBank(scFileNode->getDoubleValue("roll", 0.0));
 237
 238     SGPropertyNode* submodels = scFileNode->getChild("submodels");
 239
 240     if (submodels) {
 241         setServiceable(submodels->getBoolValue("serviceable", false));
 242         setSMPath(submodels->getStringValue("path", ""));
 243     }
 244
 245 }
 246
 247 void FGAIBase::update(double dt) {
 248
 249     if (_otype == otStatic)
 250         return;
 251
 252     if (_otype == otBallistic)
 253         CalculateMach();
 254
 255     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
 256     ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
 257
 258     if ( _fx )
 259     {
 260         // update model's audio sample values
 261         _fx->set_position_geod( pos );
 262
 263         SGQuatd orient = SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 264         _fx->set_orientation( orient );
 265
 266         SGVec3d velocity;
 267         velocity = SGVec3d( speed_north_deg_sec, speed_east_deg_sec,
 268                             pitch*speed );
 269         _fx->set_velocity( velocity );
 270     }
 271     else if ((_modeldata)&&(_modeldata->needInitilization()))
 272     {
 273         // process deferred nasal initialization,
 274         // which must be done in main thread
 275         _modeldata->init();
 276
 277         // sound initialization
 278         if (fgGetBool("/sim/sound/aimodels/enabled",false))
 279         {
 280             const string& fxpath = _modeldata->get_sound_path();
 281             if (fxpath != "")
 282             {
 283                 props->setStringValue("sim/sound/path", fxpath.c_str());
 284
 285                 // initialize the sound configuration
 286                 std::stringstream name;
 287                 name <<  "aifx:";
 288                 name << _refID;
 289                 _fx = new FGFX(name.str(), props);
 290                 _fx->init();
 291             }
 292         }
 293     }
 294 }
 295
 296 /** update LOD properties of the model */
 297 void FGAIBase::updateLOD()
 298 {
 299     double maxRangeDetail = fgGetDouble("/sim/rendering/static-lod/ai-detailed", 10000.0);
 300     double maxRangeBare   = fgGetDouble("/sim/rendering/static-lod/ai-bare", 20000.0);
 301     if (_model.valid())
 302     {
 303         if( maxRangeDetail == 0.0 )
 304         {
 305             // disable LOD
 306             _model->setRange(0, 0.0,     FLT_MAX);
 307             _model->setRange(1, FLT_MAX, FLT_MAX);
 308         }
 309         else
 310         {
 311             _model->setRange(0, 0.0, maxRangeDetail);
 312             _model->setRange(1, maxRangeDetail,maxRangeBare);
 313         }
 314     }
 315 }
 316
 317 void FGAIBase::Transform() {
 318
 319     if (!invisible) {
 320         aip.setVisible(true);
 321         aip.setPosition(pos);
 322
 323         if (no_roll)
 324             aip.setOrientation(0.0, pitch, hdg);
 325         else
 326             aip.setOrientation(roll, pitch, hdg);
 327
 328         aip.update();
 329     } else {
 330         aip.setVisible(false);
 331         aip.update();
 332     }
 333
 334 }
 335
 336 bool FGAIBase::init(bool search_in_AI_path)
 337 {
 338     if (_model.valid())
 339     {
 340         SG_LOG(SG_AI, SG_ALERT, "AIBase: Cannot initialize a model multiple times! " << model_path);
 341         return false;
 342     }
 343
 344     string f;
 345     if(search_in_AI_path)
 346     {
 347     // setup a modified Options structure, with only the $fg-root/AI defined;
 348     // we'll check that first, then give the normal search logic a chance.
 349     // this ensures that models in AI/ are preferred to normal models, where
 350     // both exist.
 351         osg::ref_ptr<osgDB::ReaderWriter::Options>
 352           opt(osg::clone(osgDB::Registry::instance()->getOptions(), osg::CopyOp::SHALLOW_COPY));
 353
 354         osgDB::FilePathList& paths(opt->getDatabasePathList());
 355         paths.clear();
 356         BOOST_FOREACH(SGPath p, globals->get_data_paths("AI")) {
 357             paths.push_back(p.str());
 358         }
 359         f = osgDB::findDataFile(model_path, opt.get());
 360     }
 361
 362     if (f.empty()) {
 363       f = simgear::SGModelLib::findDataFile(model_path);
 364     }
 365
 366     if(f.empty())
 367         f = fgGetString("/sim/multiplay/default-model", default_model);
 368     else
 369         _installed = true;
 370
 371     _modeldata = new FGAIModelData(props);
 372     osg::Node * mdl = SGModelLib::loadDeferredModel(f, props, _modeldata);
 373
 374     _model = new osg::LOD;
 375     _model->setName("AI-model range animation node");
 376
 377     _model->addChild( mdl, 0, FLT_MAX );
 378     _model->setCenterMode(osg::LOD::USE_BOUNDING_SPHERE_CENTER);
 379     _model->setRangeMode(osg::LOD::DISTANCE_FROM_EYE_POINT);
 380 //    We really need low-resolution versions of AI/MP aircraft.
 381 //    Or at least dummy "stubs" with some default silhouette.
 382 //        _model->addChild( SGModelLib::loadPagedModel(fgGetString("/sim/multiplay/default-model", default_model),
 383 //                                                    props, new FGNasalModelData(props)), FLT_MAX, FLT_MAX);
 384     updateLOD();
 385
 386     initModel(mdl);
 387     if (_model.valid() && _initialized == false) {
 388         aip.init( _model.get() );
 389         aip.setVisible(true);
 390         invisible = false;
 391         globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
 392         _initialized = true;
 393
 394         SG_LOG(SG_AI, SG_DEBUG, "AIBase: Loaded model " << model_path);
 395
 396     } else if (!model_path.empty()) {
 397         SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path);
 398         // not properly installed...
 399         _installed = false;
 400     }
 401
 402     setDie(false);
 403     return true;
 404 }
 405
 406 void FGAIBase::initModel(osg::Node *node)
 407 {
 408     if (_model.valid()) {
 409
 410         if( _path != ""){
 411             props->setStringValue("submodels/path", _path.c_str());
 412             SG_LOG(SG_AI, SG_DEBUG, "AIBase: submodels/path " << _path);
 413         }
 414
 415         if( _parent!= ""){
 416             props->setStringValue("parent-name", _parent.c_str());
 417         }
 418
 419         fgSetString("/ai/models/model-added", props->getPath().c_str());
 420     } else if (!model_path.empty()) {
 421         SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path);
 422     }
 423
 424     setDie(false);
 425 }
 426
 427
 428 bool FGAIBase::isa( object_type otype ) {
 429     return otype == _otype;
 430 }
 431
 432
 433 void FGAIBase::bind() {
 434     _tiedProperties.setRoot(props);
 435     tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 436         &FGAIBase::getID));
 437     tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 438     tie("velocities/vertical-speed-fps",
 439         SGRawValueMethods<FGAIBase,double>(*this,
 440         &FGAIBase::_getVS_fps,
 441         &FGAIBase::_setVS_fps));
 442
 443     tie("position/altitude-ft",
 444         SGRawValueMethods<FGAIBase,double>(*this,
 445         &FGAIBase::_getAltitude,
 446         &FGAIBase::_setAltitude));
 447     tie("position/latitude-deg",
 448         SGRawValueMethods<FGAIBase,double>(*this,
 449         &FGAIBase::_getLatitude,
 450         &FGAIBase::_setLatitude));
 451     tie("position/longitude-deg",
 452         SGRawValueMethods<FGAIBase,double>(*this,
 453         &FGAIBase::_getLongitude,
 454         &FGAIBase::_setLongitude));
 455
 456     tie("position/global-x",
 457         SGRawValueMethods<FGAIBase,double>(*this,
 458         &FGAIBase::_getCartPosX,
 459         0));
 460     tie("position/global-y",
 461         SGRawValueMethods<FGAIBase,double>(*this,
 462         &FGAIBase::_getCartPosY,
 463         0));
 464     tie("position/global-z",
 465         SGRawValueMethods<FGAIBase,double>(*this,
 466         &FGAIBase::_getCartPosZ,
 467         0));
 468     tie("callsign",
 469         SGRawValueMethods<FGAIBase,const char*>(*this,
 470         &FGAIBase::_getCallsign,
 471         0));
 472
 473     tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 474     tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 475     tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 476
 477     tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 478     tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 479     tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 480     tie("radar/range-nm", SGRawValuePointer<double>(&range));
 481     tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 482     tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 483     tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 484     tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 485     tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 486     tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
 487     tie("subID", SGRawValuePointer<int>(&_subID));
 488     tie("controls/lighting/nav-lights", SGRawValueFunctions<bool>(_isNight));
 489
 490     props->setBoolValue("controls/lighting/beacon", true);
 491     props->setBoolValue("controls/lighting/strobe", true);
 492     props->setBoolValue("controls/glide-path", true);
 493
 494     props->setStringValue("controls/flight/lateral-mode", "roll");
 495     props->setDoubleValue("controls/flight/target-hdg", hdg);
 496     props->setDoubleValue("controls/flight/target-roll", roll);
 497
 498     props->setStringValue("controls/flight/longitude-mode", "alt");
 499     props->setDoubleValue("controls/flight/target-alt", altitude_ft);
 500     props->setDoubleValue("controls/flight/target-pitch", pitch);
 501
 502     props->setDoubleValue("controls/flight/target-spd", speed);
 503
 504     props->setBoolValue("sim/sound/avionics/enabled", false);
 505     props->setDoubleValue("sim/sound/avionics/volume", 0.0);
 506     props->setBoolValue("sim/sound/avionics/external-view", false);
 507     props->setBoolValue("sim/current-view/internal", false);
 508 }
 509
 510 void FGAIBase::unbind() {
 511     _tiedProperties.Untie();
 512
 513     props->setBoolValue("/sim/controls/radar", true);
 514
 515     removeSoundFx();
 516 }
 517
 518 void FGAIBase::removeSoundFx() {
 519     // drop reference to sound effects now
 520     if (_fx)
 521     {
 522         // must remove explicitly - since the sound manager also keeps a reference
 523         _fx->unbind();
 524         // now drop last reference - kill the object
 525         _fx = 0;
 526     }
 527 }
 528
 529 double FGAIBase::UpdateRadar(FGAIManager* manager)
 530 {
 531     bool control = fgGetBool("/sim/controls/radar", true);
 532
 533     if(!control) return 0;
 534
 535     double radar_range_m = fgGetDouble("/instrumentation/radar/range");
 536     bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
 537     radar_range_m *= SG_NM_TO_METER  * 1.1; // + 10%
 538     radar_range_m *= radar_range_m; // squared
 539
 540     double d2 = distSqr(SGVec3d::fromGeod(pos), globals->get_aircraft_position_cart());
 541     double range_ft = sqrt(d2) * SG_METER_TO_FEET;
 542
 543     if (!force_on && (d2 > radar_range_m)) {
 544         return range_ft * range_ft;
 545     }
 546
 547     props->setBoolValue("radar/in-range", true);
 548
 549     // copy values from the AIManager
 550     double user_heading   = manager->get_user_heading();
 551     double user_pitch     = manager->get_user_pitch();
 552
 553     range = range_ft * SG_FEET_TO_METER * SG_METER_TO_NM;
 554
 555     // calculate bearing to target
 556     bearing = SGGeodesy::courseDeg(globals->get_aircraft_position(), pos);
 557
 558     // calculate look left/right to target, without yaw correction
 559     horiz_offset = bearing - user_heading;
 560     SG_NORMALIZE_RANGE(horiz_offset, -180.0, 180.0);
 561
 562     // calculate elevation to target
 563     ht_diff = altitude_ft - globals->get_aircraft_position().getElevationFt();
 564     elevation = atan2( ht_diff, range_ft ) * SG_RADIANS_TO_DEGREES;
 565
 566     // calculate look up/down to target
 567     vert_offset = elevation - user_pitch;
 568
 569     /* this calculation needs to be fixed, but it isn't important anyway
 570     // calculate range rate
 571     double recip_bearing = bearing + 180.0;
 572     if (recip_bearing > 360.0) recip_bearing -= 360.0;
 573     double my_horiz_offset = recip_bearing - hdg;
 574     if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 575     if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 576     rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 577     +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 578     */
 579
 580     // now correct look left/right for yaw
 581     // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
 582
 583     // calculate values for radar display
 584     y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 585     x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 586
 587     rotation = hdg - user_heading;
 588     SG_NORMALIZE_RANGE(rotation, 0.0, 360.0);
 589
 590     return range_ft * range_ft;
 591 }
 592
 593 /*
 594 * Getters and Setters
 595 */
 596
 597 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
 598     // Transform that one to the horizontal local coordinate system.
 599     SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
 600
 601     // and postrotate the orientation of the AIModel wrt the horizontal
 602     // local frame
 603     hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 604
 605     // The offset converted to the usual body fixed coordinate system
 606     // rotated to the earth fixed coordinates axis
 607     SGVec3d off = hlTrans.backTransform(_off);
 608
 609     // Add the position offset of the AIModel to gain the earth centered position
 610     SGVec3d cartPos = SGVec3d::fromGeod(pos);
 611
 612     return cartPos + off;
 613 }
 614
 615 SGVec3d FGAIBase::getCartPos() const {
 616     SGVec3d cartPos = SGVec3d::fromGeod(pos);
 617     return cartPos;
 618 }
 619
 620 bool FGAIBase::getGroundElevationM(const SGGeod& pos, double& elev,
 621                                    const simgear::BVHMaterial** material) const {
 622     return globals->get_scenery()->get_elevation_m(pos, elev, material,
 623                                                    _model.get());
 624 }
 625
 626 double FGAIBase::_getCartPosX() const {
 627     SGVec3d cartPos = getCartPos();
 628     return cartPos.x();
 629 }
 630
 631 double FGAIBase::_getCartPosY() const {
 632     SGVec3d cartPos = getCartPos();
 633     return cartPos.y();
 634 }
 635
 636 double FGAIBase::_getCartPosZ() const {
 637     SGVec3d cartPos = getCartPos();
 638     return cartPos.z();
 639 }
 640
 641 void FGAIBase::_setLongitude( double longitude ) {
 642     pos.setLongitudeDeg(longitude);
 643 }
 644
 645 void FGAIBase::_setLatitude ( double latitude )  {
 646     pos.setLatitudeDeg(latitude);
 647 }
 648
 649 void FGAIBase::_setSubID( int s ) {
 650     _subID = s;
 651 }
 652
 653 bool FGAIBase::setParentNode() {
 654
 655     if (_parent == ""){
 656        SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name
 657             << " parent not set ");
 658        return false;
 659     }
 660
 661     const SGPropertyNode_ptr ai = fgGetNode("/ai/models", true);
 662
 663     for (int i = ai->nChildren() - 1; i >= -1; i--) {
 664         SGPropertyNode_ptr model;
 665
 666         if (i < 0) { // last iteration: selected model
 667             model = _selected_ac;
 668         } else {
 669             model = ai->getChild(i);
 670             //const string& path = ai->getPath();
 671             const string name = model->getStringValue("name");
 672
 673             if (!model->nChildren()){
 674                 continue;
 675             }
 676             if (name == _parent) {
 677                 _selected_ac = model;  // save selected model for last iteration
 678                 break;
 679             }
 680
 681         }
 682         if (!model)
 683             continue;
 684
 685     }// end for loop
 686
 687     if (_selected_ac != 0){
 688         const string name = _selected_ac->getStringValue("name");
 689         return true;
 690     } else {
 691         SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name
 692             << " parent not found: dying ");
 693         setDie(true);
 694         return false;
 695     }
 696
 697 }
 698
 699 double FGAIBase::_getLongitude() const {
 700     return pos.getLongitudeDeg();
 701 }
 702
 703 double FGAIBase::_getLatitude() const {
 704     return pos.getLatitudeDeg();
 705 }
 706
 707 double FGAIBase::_getElevationFt() const {
 708     return pos.getElevationFt();
 709 }
 710
 711 double FGAIBase::_getRdot() const {
 712     return rdot;
 713 }
 714
 715 double FGAIBase::_getVS_fps() const {
 716     return vs/60.0;
 717 }
 718
 719 double FGAIBase::_get_speed_east_fps() const {
 720     return speed_east_deg_sec * ft_per_deg_lon;
 721 }
 722
 723 double FGAIBase::_get_speed_north_fps() const {
 724     return speed_north_deg_sec * ft_per_deg_lat;
 725 }
 726
 727 void FGAIBase::_setVS_fps( double _vs ) {
 728     vs = _vs*60.0;
 729 }
 730
 731 double FGAIBase::_getAltitude() const {
 732     return altitude_ft;
 733 }
 734
 735 double FGAIBase::_getAltitudeAGL(SGGeod inpos, double start){
 736     getGroundElevationM(SGGeod::fromGeodM(inpos, start),
 737         _elevation_m, NULL);
 738     return inpos.getElevationFt() - _elevation_m * SG_METER_TO_FEET;
 739 }
 740
 741 bool FGAIBase::_getServiceable() const {
 742     return serviceable;
 743 }
 744
 745 SGPropertyNode* FGAIBase::_getProps() const {
 746     return props;
 747 }
 748
 749 void FGAIBase::_setAltitude( double _alt ) {
 750     setAltitude( _alt );
 751 }
 752
 753 bool FGAIBase::_isNight() {
 754     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 755 }
 756
 757 bool FGAIBase::_getCollisionData() {
 758     return _collision_reported;
 759 }
 760
 761 bool FGAIBase::_getExpiryData() {
 762     return _expiry_reported;
 763 }
 764
 765 bool FGAIBase::_getImpactData() {
 766     return _impact_reported;
 767 }
 768
 769 double FGAIBase::_getImpactLat() const {
 770     return _impact_lat;
 771 }
 772
 773 double FGAIBase::_getImpactLon() const {
 774     return _impact_lon;
 775 }
 776
 777 double FGAIBase::_getImpactElevFt() const {
 778     return _impact_elev * SG_METER_TO_FEET;
 779 }
 780
 781 double FGAIBase::_getImpactPitch() const {
 782     return _impact_pitch;
 783 }
 784
 785 double FGAIBase::_getImpactRoll() const {
 786     return _impact_roll;
 787 }
 788
 789 double FGAIBase::_getImpactHdg() const {
 790     return _impact_hdg;
 791 }
 792
 793 double FGAIBase::_getImpactSpeed() const {
 794     return _impact_speed;
 795 }
 796
 797 int FGAIBase::getID() const {
 798     return  _refID;
 799 }
 800
 801 int FGAIBase::_getSubID() const {
 802     return  _subID;
 803 }
 804
 805 double FGAIBase::_getSpeed() const {
 806     return speed;
 807 }
 808
 809 double FGAIBase::_getRoll() const {
 810     return roll;
 811 }
 812
 813 double FGAIBase::_getPitch() const {
 814     return pitch;
 815 }
 816
 817 double FGAIBase::_getHeading() const {
 818     return hdg;
 819 }
 820
 821 double  FGAIBase::_getXOffset() const {
 822     return _x_offset;
 823 }
 824
 825 double  FGAIBase::_getYOffset() const {
 826     return _y_offset;
 827 }
 828
 829 double  FGAIBase::_getZOffset() const {
 830     return _z_offset;
 831 }
 832
 833 const char* FGAIBase::_getPath() const {
 834     return model_path.c_str();
 835 }
 836
 837 const char* FGAIBase::_getSMPath() const {
 838     return _path.c_str();
 839 }
 840
 841 const char* FGAIBase::_getName() const {
 842     return _name.c_str();
 843 }
 844
 845 const char* FGAIBase::_getCallsign() const {
 846     return _callsign.c_str();
 847 }
 848
 849 const char* FGAIBase::_getSubmodel() const {
 850     return _submodel.c_str();
 851 }
 852
 853 void FGAIBase::CalculateMach() {
 854     // Calculate rho at altitude, using standard atmosphere
 855     // For the temperature T and the pressure p,
 856     double altitude = altitude_ft;
 857
 858     if (altitude < 36152) {             // curve fits for the troposphere
 859         T = 59 - 0.00356 * altitude;
 860         p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
 861     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
 862         T = -70;
 863         p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
 864     } else {                                    //  upper stratosphere
 865         T = -205.05 + (0.00164 * altitude);
 866         p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
 867     }
 868
 869     rho = p / (1718 * (T + 459.7));
 870
 871     // calculate the speed of sound at altitude
 872     // a = sqrt ( g * R * (T + 459.7))
 873     // where:
 874     // a = speed of sound [ft/s]
 875     // g = specific heat ratio, which is usually equal to 1.4
 876     // R = specific gas constant, which equals 1716 ft-lb/slug/R
 877     a = sqrt ( 1.4 * 1716 * (T + 459.7));
 878
 879     // calculate Mach number
 880     Mach = speed/a;
 881
 882     // cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
 883 }
 884
 885 int FGAIBase::_newAIModelID() {
 886     static int id = 0;
 887
 888     if (!++id)
 889         id++;   // id = 0 is not allowed.
 890
 891     return id;
 892 }
 893
 894
 895