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