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