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