src/AIModel/AIManager.cxx

   1 // AIManager.cxx  Based on David Luff's AIMgr:
   2 // - a global management type for AI objects
   3 //
   4 // Written by David Culp, started October 2003.
   5 // - davidculp2@comcast.net
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #include <cstring>
  22 #include <algorithm>
  23
  24 #include <simgear/sg_inlines.h>
  25 #include <simgear/math/sg_geodesy.hxx>
  26 #include <simgear/props/props_io.hxx>
  27 #include <simgear/structure/exception.hxx>
  28 #include <simgear/structure/commands.hxx>
  29 #include <simgear/structure/SGBinding.hxx>
  30
  31 #include <boost/mem_fn.hpp>
  32 #include <boost/foreach.hpp>
  33
  34 #include <Main/globals.hxx>
  35 #include <Airports/airport.hxx>
  36 #include <Scripting/NasalSys.hxx>
  37
  38 #include "AIManager.hxx"
  39 #include "AIAircraft.hxx"
  40 #include "AIShip.hxx"
  41 #include "AIBallistic.hxx"
  42 #include "AIStorm.hxx"
  43 #include "AIThermal.hxx"
  44 #include "AICarrier.hxx"
  45 #include "AIStatic.hxx"
  46 #include "AIMultiplayer.hxx"
  47 #include "AITanker.hxx"
  48 #include "AIWingman.hxx"
  49 #include "AIGroundVehicle.hxx"
  50 #include "AIEscort.hxx"
  51
  52 class FGAIManager::Scenario
  53 {
  54 public:
  55     Scenario(FGAIManager* man, const std::string& nm, SGPropertyNode* scenarios) :
  56         _internalName(nm)
  57     {
  58         BOOST_FOREACH(SGPropertyNode* scEntry, scenarios->getChildren("entry")) {
  59             FGAIBasePtr ai = man->addObject(scEntry);
  60             if (ai) {
  61                 _objects.push_back(ai);
  62             }
  63         } // of scenario entry iteration
  64
  65         SGPropertyNode* nasalScripts = scenarios->getChild("nasal");
  66         if (!nasalScripts) {
  67             return;
  68         }
  69
  70         _unloadScript = nasalScripts->getStringValue("unload");
  71         std::string loadScript = nasalScripts->getStringValue("load");
  72         if (!loadScript.empty()) {
  73             FGNasalSys* nasalSys = (FGNasalSys*) globals->get_subsystem("nasal");
  74             std::string moduleName = "scenario_" + _internalName;
  75             nasalSys->createModule(moduleName.c_str(), moduleName.c_str(),
  76                                    loadScript.c_str(), loadScript.size(),
  77                                    0);
  78         }
  79     }
  80
  81     ~Scenario()
  82     {
  83         BOOST_FOREACH(FGAIBasePtr ai, _objects) {
  84             ai->setDie(true);
  85         }
  86
  87         FGNasalSys* nasalSys = (FGNasalSys*) globals->get_subsystem("nasal");
  88         std::string moduleName = "scenario_" + _internalName;
  89         if (!_unloadScript.empty()) {
  90             nasalSys->createModule(moduleName.c_str(), moduleName.c_str(),
  91                                    _unloadScript.c_str(), _unloadScript.size(),
  92                                    0);
  93         }
  94
  95         nasalSys->deleteModule(moduleName.c_str());
  96     }
  97 private:
  98     std::vector<FGAIBasePtr> _objects;
  99     std::string _internalName;
 100     std::string _unloadScript;
 101 };
 102
 103 ///////////////////////////////////////////////////////////////////////////////
 104
 105 FGAIManager::FGAIManager() :
 106     cb_ai_bare(SGPropertyChangeCallback<FGAIManager>(this,&FGAIManager::updateLOD,
 107                fgGetNode("/sim/rendering/static-lod/ai-bare", true))),
 108     cb_ai_detailed(SGPropertyChangeCallback<FGAIManager>(this,&FGAIManager::updateLOD,
 109                    fgGetNode("/sim/rendering/static-lod/ai-detailed", true)))
 110 {
 111
 112 }
 113
 114 FGAIManager::~FGAIManager()
 115 {
 116     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::unbind));
 117 }
 118
 119 void
 120 FGAIManager::init() {
 121     root = fgGetNode("sim/ai", true);
 122
 123     enabled = root->getNode("enabled", true);
 124
 125     thermal_lift_node = fgGetNode("/environment/thermal-lift-fps", true);
 126     wind_from_east_node  = fgGetNode("/environment/wind-from-east-fps",true);
 127     wind_from_north_node = fgGetNode("/environment/wind-from-north-fps",true);
 128
 129     user_altitude_agl_node  = fgGetNode("/position/altitude-agl-ft", true);
 130     user_speed_node     = fgGetNode("/velocities/uBody-fps", true);
 131
 132     globals->get_commands()->addCommand("load-scenario", this, &FGAIManager::loadScenarioCommand);
 133     globals->get_commands()->addCommand("unload-scenario", this, &FGAIManager::unloadScenarioCommand);
 134 }
 135
 136 void
 137 FGAIManager::postinit()
 138 {
 139     // postinit, so that it can access the Nasal subsystem
 140
 141     // scenarios enabled, AI subsystem required
 142     if (!enabled->getBoolValue())
 143         enabled->setBoolValue(true);
 144
 145     // process all scenarios
 146     BOOST_FOREACH(SGPropertyNode* n, root->getChildren("scenario")) {
 147         const string& name = n->getStringValue();
 148         if (name.empty())
 149             continue;
 150
 151         if (_scenarios.find(name) != _scenarios.end()) {
 152             SG_LOG(SG_AI, SG_WARN, "won't load scenario '" << name << "' twice");
 153             continue;
 154         }
 155
 156         SG_LOG(SG_AI, SG_INFO, "loading scenario '" << name << '\'');
 157         loadScenario(name);
 158     }
 159 }
 160
 161 void
 162 FGAIManager::reinit()
 163 {
 164     // shutdown scenarios
 165     unloadAllScenarios();
 166
 167     update(0.0);
 168     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::reinit));
 169
 170     // (re-)load scenarios
 171     postinit();
 172 }
 173
 174 void
 175 FGAIManager::shutdown()
 176 {
 177     unloadAllScenarios();
 178
 179     BOOST_FOREACH(FGAIBase* ai, ai_list) {
 180         ai->unbind();
 181     }
 182
 183     ai_list.clear();
 184 }
 185
 186 void
 187 FGAIManager::bind() {
 188     root = globals->get_props()->getNode("ai/models", true);
 189     root->tie("count", SGRawValueMethods<FGAIManager, int>(*this,
 190         &FGAIManager::getNumAiObjects));
 191 }
 192
 193 void
 194 FGAIManager::unbind() {
 195     root->untie("count");
 196 }
 197
 198 void FGAIManager::removeDeadItem(FGAIBase* base)
 199 {
 200     SGPropertyNode *props = base->_getProps();
 201
 202     props->setBoolValue("valid", false);
 203     base->unbind();
 204
 205     // for backward compatibility reset properties, so that aircraft,
 206     // which don't know the <valid> property, keep working
 207     // TODO: remove after a while
 208     props->setIntValue("id", -1);
 209     props->setBoolValue("radar/in-range", false);
 210     props->setIntValue("refuel/tanker", false);
 211 }
 212
 213 void
 214 FGAIManager::update(double dt) {
 215     // initialize these for finding nearest thermals
 216     range_nearest = 10000.0;
 217     strength = 0.0;
 218
 219     if (!enabled->getBoolValue())
 220         return;
 221
 222     fetchUserState();
 223
 224     // partition the list into dead followed by alive
 225     ai_list_iterator firstAlive =
 226       std::stable_partition(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::getDie));
 227
 228     // clean up each item and finally remove from the container
 229     for (ai_list_iterator it=ai_list.begin(); it != firstAlive; ++it) {
 230         removeDeadItem(*it);
 231     }
 232
 233     ai_list.erase(ai_list.begin(), firstAlive);
 234
 235     // every remaining item is alive. update them in turn, but guard for
 236     // exceptions, so a single misbehaving AI object doesn't bring down the
 237     // entire subsystem.
 238     BOOST_FOREACH(FGAIBase* base, ai_list) {
 239         try {
 240             if (base->isa(FGAIBase::otThermal)) {
 241                 processThermal(dt, (FGAIThermal*)base);
 242             } else {
 243                 base->update(dt);
 244             }
 245         } catch (sg_exception& e) {
 246             SG_LOG(SG_AI, SG_WARN, "caught exception updating AI model:" << base->_getName()<< ", which will be killed."
 247                    "\n\tError:" << e.getFormattedMessage());
 248             base->setDie(true);
 249         }
 250     } // of live AI objects iteration
 251
 252     thermal_lift_node->setDoubleValue( strength );  // for thermals
 253 }
 254
 255 /** update LOD settings of all AI/MP models */
 256 void
 257 FGAIManager::updateLOD(SGPropertyNode* node)
 258 {
 259     SG_UNUSED(node);
 260     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::updateLOD));
 261 }
 262
 263 void
 264 FGAIManager::attach(FGAIBase *model)
 265 {
 266     const char* typeString = model->getTypeString();
 267     SGPropertyNode* root = globals->get_props()->getNode("ai/models", true);
 268     SGPropertyNode* p;
 269     int i;
 270
 271     // find free index in the property tree, if we have
 272     // more than 10000 mp-aircrafts in the property tree we should optimize the mp-server
 273     for (i = 0; i < 10000; i++) {
 274         p = root->getNode(typeString, i, false);
 275
 276         if (!p || !p->getBoolValue("valid", false))
 277             break;
 278
 279         if (p->getIntValue("id",-1)==model->getID()) {
 280             p->setStringValue("callsign","***invalid node***"); //debug only, should never set!
 281         }
 282     }
 283
 284     p = root->getNode(typeString, i, true);
 285     model->setManager(this, p);
 286     ai_list.push_back(model);
 287
 288     model->init(model->getType()==FGAIBase::otAircraft
 289         || model->getType()==FGAIBase::otMultiplayer
 290         || model->getType()==FGAIBase::otStatic);
 291     model->bind();
 292     p->setBoolValue("valid", true);
 293 }
 294
 295 int
 296 FGAIManager::getNumAiObjects() const
 297 {
 298     return ai_list.size();
 299 }
 300
 301 void
 302 FGAIManager::fetchUserState( void ) {
 303
 304     globals->get_aircraft_orientation(user_heading, user_pitch, user_roll);
 305     user_speed     = user_speed_node->getDoubleValue() * 0.592484;
 306     wind_from_east = wind_from_east_node->getDoubleValue();
 307     wind_from_north   = wind_from_north_node->getDoubleValue();
 308     user_altitude_agl = user_altitude_agl_node->getDoubleValue();
 309
 310 }
 311
 312 // only keep the results from the nearest thermal
 313 void
 314 FGAIManager::processThermal( double dt, FGAIThermal* thermal ) {
 315     thermal->update(dt);
 316
 317     if ( thermal->_getRange() < range_nearest ) {
 318         range_nearest = thermal->_getRange();
 319         strength = thermal->getStrength();
 320     }
 321
 322 }
 323
 324 bool FGAIManager::loadScenarioCommand(const SGPropertyNode* args)
 325 {
 326     std::string name = args->getStringValue("name");
 327     if (args->hasChild("load-property")) {
 328         // slightly ugly, to simplify life in the dialogs, make load allow
 329         // loading or unloading based on a bool property.
 330         bool loadIt = fgGetBool(args->getStringValue("load-property"));
 331         if (!loadIt) {
 332             // user actually wants to unload, fine.
 333             return unloadScenario(name);
 334         }
 335     }
 336
 337     if (_scenarios.find(name) != _scenarios.end()) {
 338         SG_LOG(SG_AI, SG_WARN, "scenario '" << name << "' already loaded");
 339         return false;
 340     }
 341
 342     bool ok = loadScenario(name);
 343     if (ok) {
 344         // create /sim/ai node for consistency
 345         int index = 0;
 346         for (; root->hasChild("scenario", index); ++index) {}
 347
 348         SGPropertyNode* scenarioNode = root->getChild("scenario", index, true);
 349         scenarioNode->setStringValue(name);
 350     }
 351
 352     return ok;
 353 }
 354
 355 bool FGAIManager::unloadScenarioCommand(const SGPropertyNode* args)
 356 {
 357     std::string name = args->getStringValue("name");
 358     return unloadScenario(name);
 359 }
 360
 361 bool FGAIManager::addObjectCommand(const SGPropertyNode* definition)
 362 {
 363     addObject(definition);
 364     return true;
 365 }
 366
 367 FGAIBasePtr FGAIManager::addObject(const SGPropertyNode* definition)
 368 {
 369     const std::string& type = definition->getStringValue("type", "aircraft");
 370
 371     FGAIBase* ai = NULL;
 372     if (type == "tanker") { // refueling scenarios
 373         ai = new FGAITanker;
 374     } else if (type == "wingman") {
 375         ai = new FGAIWingman;
 376     } else if (type == "aircraft") {
 377         ai = new FGAIAircraft;
 378     } else if (type == "ship") {
 379         ai = new FGAIShip;
 380     } else if (type == "carrier") {
 381         ai = new FGAICarrier;
 382     } else if (type == "groundvehicle") {
 383         ai = new FGAIGroundVehicle;
 384     } else if (type == "escort") {
 385         ai = new FGAIEscort;
 386     } else if (type == "thunderstorm") {
 387         ai = new FGAIStorm;
 388     } else if (type == "thermal") {
 389         ai = new FGAIThermal;
 390     } else if (type == "ballistic") {
 391         ai = new FGAIBallistic;
 392     } else if (type == "static") {
 393         ai = new FGAIStatic;
 394     }
 395
 396     ai->readFromScenario(const_cast<SGPropertyNode*>(definition));
 397     attach(ai);
 398     return ai;
 399 }
 400
 401 bool FGAIManager::removeObject(const SGPropertyNode* args)
 402 {
 403     int id = args->getIntValue("id");
 404     BOOST_FOREACH(FGAIBase* ai, get_ai_list()) {
 405         if (ai->getID() == id) {
 406             ai->setDie(true);
 407             break;
 408         }
 409     }
 410
 411     return false;
 412 }
 413
 414 FGAIBasePtr FGAIManager::getObjectFromProperty(const SGPropertyNode* aProp) const
 415 {
 416     BOOST_FOREACH(FGAIBase* ai, get_ai_list()) {
 417         if (ai->_getProps() == aProp) {
 418             return ai;
 419         }
 420     } // of AI objects iteration
 421
 422     return NULL;
 423 }
 424
 425 bool
 426 FGAIManager::loadScenario( const string &filename )
 427 {
 428     SGPropertyNode_ptr file = loadScenarioFile(filename);
 429     if (!file) {
 430         return false;
 431     }
 432
 433     SGPropertyNode_ptr scNode = file->getChild("scenario");
 434     if (!scNode) {
 435         return false;
 436     }
 437
 438     _scenarios[filename] = new Scenario(this, filename, scNode);
 439     return true;
 440 }
 441
 442
 443 bool
 444 FGAIManager::unloadScenario( const string &filename)
 445 {
 446     ScenarioDict::iterator it = _scenarios.find(filename);
 447     if (it == _scenarios.end()) {
 448         SG_LOG(SG_AI, SG_WARN, "unload scenario: not found:" << filename);
 449         return false;
 450     }
 451
 452 // remove /sim/ai node
 453     unsigned int index = 0;
 454     for (SGPropertyNode* n = NULL; (n = root->getChild("scenario", index)) != NULL; ++index) {
 455         if (n->getStringValue() == filename) {
 456             root->removeChild("scenario", index);
 457             break;
 458         }
 459     }
 460
 461     delete it->second;
 462     _scenarios.erase(it);
 463     return true;
 464 }
 465
 466 void
 467 FGAIManager::unloadAllScenarios()
 468 {
 469     ScenarioDict::iterator it = _scenarios.begin();
 470     for (; it != _scenarios.end(); ++it) {
 471         delete it->second;
 472     } // of scenarios iteration
 473
 474
 475     // remove /sim/ai node
 476     root->removeChildren("scenario");
 477     _scenarios.clear();
 478 }
 479
 480
 481 SGPropertyNode_ptr
 482 FGAIManager::loadScenarioFile(const std::string& filename)
 483 {
 484     SGPath path(globals->get_fg_root());
 485     path.append("AI/" + filename + ".xml");
 486     try {
 487         SGPropertyNode_ptr root = new SGPropertyNode;
 488         readProperties(path.str(), root);
 489         return root;
 490     } catch (const sg_exception &t) {
 491         SG_LOG(SG_AI, SG_ALERT, "Failed to load scenario '"
 492             << path.str() << "': " << t.getFormattedMessage());
 493     }
 494     return 0;
 495 }
 496
 497 bool
 498 FGAIManager::getStartPosition(const string& id, const string& pid,
 499                               SGGeod& geodPos, double& hdng, SGVec3d& uvw)
 500 {
 501     bool found = false;
 502     SGPropertyNode* root = fgGetNode("sim/ai", true);
 503     if (!root->getNode("enabled", true)->getBoolValue())
 504         return found;
 505
 506     for (int i = 0 ; (!found) && i < root->nChildren() ; i++) {
 507         SGPropertyNode *aiEntry = root->getChild( i );
 508         if ( !strcmp( aiEntry->getName(), "scenario" ) ) {
 509             const string& filename = aiEntry->getStringValue();
 510             SGPropertyNode_ptr scenarioTop = loadScenarioFile(filename);
 511             if (scenarioTop) {
 512                 SGPropertyNode* scenarios = scenarioTop->getChild("scenario");
 513                 if (scenarios) {
 514                     for (int i = 0; i < scenarios->nChildren(); i++) {
 515                         SGPropertyNode* scEntry = scenarios->getChild(i);
 516                         const std::string& type = scEntry->getStringValue("type");
 517                         const std::string& pnumber = scEntry->getStringValue("pennant-number");
 518                         const std::string& name = scEntry->getStringValue("name");
 519                         if (type == "carrier" && (pnumber == id || name == id)) {
 520                             SGSharedPtr<FGAICarrier> carrier = new FGAICarrier;
 521                             carrier->readFromScenario(scEntry);
 522
 523                             if (carrier->getParkPosition(pid, geodPos, hdng, uvw)) {
 524                                 found = true;
 525                                 break;
 526                             }
 527                         }
 528                     }
 529                 }
 530             }
 531         }
 532     }
 533     return found;
 534 }
 535
 536 const FGAIBase *
 537 FGAIManager::calcCollision(double alt, double lat, double lon, double fuse_range)
 538 {
 539     // we specify tgt extent (ft) according to the AIObject type
 540     double tgt_ht[]     = {0,  50, 100, 250, 0, 100, 0, 0,  50,  50, 20, 100,  50};
 541     double tgt_length[] = {0, 100, 200, 750, 0,  50, 0, 0, 200, 100, 40, 200, 100};
 542     ai_list_iterator ai_list_itr = ai_list.begin();
 543     ai_list_iterator end = ai_list.end();
 544
 545     SGGeod pos(SGGeod::fromDegFt(lon, lat, alt));
 546     SGVec3d cartPos(SGVec3d::fromGeod(pos));
 547
 548     while (ai_list_itr != end) {
 549         double tgt_alt = (*ai_list_itr)->_getAltitude();
 550         int type       = (*ai_list_itr)->getType();
 551         tgt_ht[type] += fuse_range;
 552
 553         if (fabs(tgt_alt - alt) > tgt_ht[type] || type == FGAIBase::otBallistic
 554             || type == FGAIBase::otStorm || type == FGAIBase::otThermal ) {
 555                 //SG_LOG(SG_AI, SG_DEBUG, "AIManager: skipping "
 556                 //    << fabs(tgt_alt - alt)
 557                 //    << " "
 558                 //    << type
 559                 //    );
 560                 ++ai_list_itr;
 561                 continue;
 562         }
 563
 564         int id         = (*ai_list_itr)->getID();
 565
 566         double range = calcRangeFt(cartPos, (*ai_list_itr));
 567
 568         //SG_LOG(SG_AI, SG_DEBUG, "AIManager:  AI list size "
 569         //    << ai_list.size()
 570         //    << " type " << type
 571         //    << " ID " << id
 572         //    << " range " << range
 573         //    //<< " bearing " << bearing
 574         //    << " alt " << tgt_alt
 575         //    );
 576
 577         tgt_length[type] += fuse_range;
 578
 579         if (range < tgt_length[type]){
 580             SG_LOG(SG_AI, SG_DEBUG, "AIManager: HIT! "
 581                 << " type " << type
 582                 << " ID " << id
 583                 << " range " << range
 584                 << " alt " << tgt_alt
 585                 );
 586             return (*ai_list_itr).get();
 587         }
 588         ++ai_list_itr;
 589     }
 590     return 0;
 591 }
 592
 593 double
 594 FGAIManager::calcRangeFt(const SGVec3d& aCartPos, FGAIBase* aObject) const
 595 {
 596     double distM = dist(aCartPos, aObject->getCartPos());
 597     return distM * SG_METER_TO_FEET;
 598 }
 599
 600 //end AIManager.cxx