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_yaw_node       = fgGetNode("/orientation/side-slip-deg", true);
 131     user_speed_node     = fgGetNode("/velocities/uBody-fps", true);
 132
 133     globals->get_commands()->addCommand("load-scenario", this, &FGAIManager::loadScenarioCommand);
 134     globals->get_commands()->addCommand("unload-scenario", this, &FGAIManager::unloadScenarioCommand);
 135 }
 136
 137 void
 138 FGAIManager::postinit()
 139 {
 140     // postinit, so that it can access the Nasal subsystem
 141
 142     // scenarios enabled, AI subsystem required
 143     if (!enabled->getBoolValue())
 144         enabled->setBoolValue(true);
 145
 146     // process all scenarios
 147     BOOST_FOREACH(SGPropertyNode* n, root->getChildren("scenario")) {
 148         const string& name = n->getStringValue();
 149         if (name.empty())
 150             continue;
 151
 152         if (_scenarios.find(name) != _scenarios.end()) {
 153             SG_LOG(SG_AI, SG_WARN, "won't load scenario '" << name << "' twice");
 154             continue;
 155         }
 156
 157         SG_LOG(SG_AI, SG_INFO, "loading scenario '" << name << '\'');
 158         loadScenario(name);
 159     }
 160 }
 161
 162 void
 163 FGAIManager::reinit()
 164 {
 165     // shutdown scenarios
 166     unloadAllScenarios();
 167
 168     update(0.0);
 169     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::reinit));
 170
 171     // (re-)load scenarios
 172     postinit();
 173 }
 174
 175 void
 176 FGAIManager::shutdown()
 177 {
 178     unloadAllScenarios();
 179 }
 180
 181 void
 182 FGAIManager::bind() {
 183     root = globals->get_props()->getNode("ai/models", true);
 184     root->tie("count", SGRawValueMethods<FGAIManager, int>(*this,
 185         &FGAIManager::getNumAiObjects));
 186 }
 187
 188 void
 189 FGAIManager::unbind() {
 190     root->untie("count");
 191 }
 192
 193 void FGAIManager::removeDeadItem(FGAIBase* base)
 194 {
 195     SGPropertyNode *props = base->_getProps();
 196
 197     props->setBoolValue("valid", false);
 198     base->unbind();
 199
 200     // for backward compatibility reset properties, so that aircraft,
 201     // which don't know the <valid> property, keep working
 202     // TODO: remove after a while
 203     props->setIntValue("id", -1);
 204     props->setBoolValue("radar/in-range", false);
 205     props->setIntValue("refuel/tanker", false);
 206 }
 207
 208 void
 209 FGAIManager::update(double dt) {
 210     // initialize these for finding nearest thermals
 211     range_nearest = 10000.0;
 212     strength = 0.0;
 213
 214     if (!enabled->getBoolValue())
 215         return;
 216
 217     fetchUserState();
 218
 219     // partition the list into dead followed by alive
 220     ai_list_iterator firstAlive =
 221       std::stable_partition(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::getDie));
 222
 223     // clean up each item and finally remove from the container
 224     for (ai_list_iterator it=ai_list.begin(); it != firstAlive; ++it) {
 225         removeDeadItem(*it);
 226     }
 227
 228     ai_list.erase(ai_list.begin(), firstAlive);
 229
 230     // every remaining item is alive
 231     BOOST_FOREACH(FGAIBase* base, ai_list) {
 232         if (base->isa(FGAIBase::otThermal)) {
 233             processThermal(dt, (FGAIThermal*)base);
 234         } else {
 235             base->update(dt);
 236         }
 237     } // of live AI objects iteration
 238
 239     thermal_lift_node->setDoubleValue( strength );  // for thermals
 240 }
 241
 242 /** update LOD settings of all AI/MP models */
 243 void
 244 FGAIManager::updateLOD(SGPropertyNode* node)
 245 {
 246     SG_UNUSED(node);
 247     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::updateLOD));
 248 }
 249
 250 void
 251 FGAIManager::attach(FGAIBase *model)
 252 {
 253     const char* typeString = model->getTypeString();
 254     SGPropertyNode* root = globals->get_props()->getNode("ai/models", true);
 255     SGPropertyNode* p;
 256     int i;
 257
 258     // find free index in the property tree, if we have
 259     // more than 10000 mp-aircrafts in the property tree we should optimize the mp-server
 260     for (i = 0; i < 10000; i++) {
 261         p = root->getNode(typeString, i, false);
 262
 263         if (!p || !p->getBoolValue("valid", false))
 264             break;
 265
 266         if (p->getIntValue("id",-1)==model->getID()) {
 267             p->setStringValue("callsign","***invalid node***"); //debug only, should never set!
 268         }
 269     }
 270
 271     p = root->getNode(typeString, i, true);
 272     model->setManager(this, p);
 273     ai_list.push_back(model);
 274
 275     model->init(model->getType()==FGAIBase::otAircraft
 276         || model->getType()==FGAIBase::otMultiplayer
 277         || model->getType()==FGAIBase::otStatic);
 278     model->bind();
 279     p->setBoolValue("valid", true);
 280 }
 281
 282 int
 283 FGAIManager::getNumAiObjects(void) const
 284 {
 285     return ai_list.size();
 286 }
 287
 288 void
 289 FGAIManager::fetchUserState( void ) {
 290
 291     user_yaw       = user_yaw_node->getDoubleValue();
 292     globals->get_aircraft_orientation(user_heading, user_pitch, user_roll);
 293
 294     user_speed     = user_speed_node->getDoubleValue() * 0.592484;
 295     wind_from_east = wind_from_east_node->getDoubleValue();
 296     wind_from_north   = wind_from_north_node->getDoubleValue();
 297     user_altitude_agl = user_altitude_agl_node->getDoubleValue();
 298
 299 }
 300
 301 // only keep the results from the nearest thermal
 302 void
 303 FGAIManager::processThermal( double dt, FGAIThermal* thermal ) {
 304     thermal->update(dt);
 305
 306     if ( thermal->_getRange() < range_nearest ) {
 307         range_nearest = thermal->_getRange();
 308         strength = thermal->getStrength();
 309     }
 310
 311 }
 312
 313 bool FGAIManager::loadScenarioCommand(const SGPropertyNode* args)
 314 {
 315     std::string name = args->getStringValue("name");
 316     if (args->hasChild("load-property")) {
 317         // slightly ugly, to simplify life in the dialogs, make load allow
 318         // loading or unloading based on a bool property.
 319         bool loadIt = fgGetBool(args->getStringValue("load-property"));
 320         if (!loadIt) {
 321             // user actually wants to unload, fine.
 322             return unloadScenario(name);
 323         }
 324     }
 325
 326     if (_scenarios.find(name) != _scenarios.end()) {
 327         SG_LOG(SG_AI, SG_WARN, "scenario '" << name << "' already loaded");
 328         return false;
 329     }
 330
 331     bool ok = loadScenario(name);
 332     if (ok) {
 333         // create /sim/ai node for consistency
 334         int index = 0;
 335         for (; root->hasChild("scenario", index); ++index) {}
 336
 337         SGPropertyNode* scenarioNode = root->getChild("scenario", index, true);
 338         scenarioNode->setStringValue(name);
 339     }
 340
 341     return ok;
 342 }
 343
 344 bool FGAIManager::unloadScenarioCommand(const SGPropertyNode* args)
 345 {
 346     std::string name = args->getStringValue("name");
 347     return unloadScenario(name);
 348 }
 349
 350 bool FGAIManager::addObjectCommand(const SGPropertyNode* definition)
 351 {
 352     addObject(definition);
 353     return true;
 354 }
 355
 356 FGAIBasePtr FGAIManager::addObject(const SGPropertyNode* definition)
 357 {
 358     const std::string& type = definition->getStringValue("type", "aircraft");
 359
 360     FGAIBase* ai = NULL;
 361     if (type == "tanker") { // refueling scenarios
 362         ai = new FGAITanker;
 363     } else if (type == "wingman") {
 364         ai = new FGAIWingman;
 365     } else if (type == "aircraft") {
 366         ai = new FGAIAircraft;
 367     } else if (type == "ship") {
 368         ai = new FGAIShip;
 369     } else if (type == "carrier") {
 370         ai = new FGAICarrier;
 371     } else if (type == "groundvehicle") {
 372         ai = new FGAIGroundVehicle;
 373     } else if (type == "escort") {
 374         ai = new FGAIEscort;
 375     } else if (type == "thunderstorm") {
 376         ai = new FGAIStorm;
 377     } else if (type == "thermal") {
 378         ai = new FGAIThermal;
 379     } else if (type == "ballistic") {
 380         ai = new FGAIBallistic;
 381     } else if (type == "static") {
 382         ai = new FGAIStatic;
 383     }
 384
 385     ai->readFromScenario(const_cast<SGPropertyNode*>(definition));
 386     attach(ai);
 387     return ai;
 388 }
 389
 390 bool FGAIManager::removeObject(const SGPropertyNode* args)
 391 {
 392     int id = args->getIntValue("id");
 393     BOOST_FOREACH(FGAIBase* ai, get_ai_list()) {
 394         if (ai->getID() == id) {
 395             ai->setDie(true);
 396             break;
 397         }
 398     }
 399
 400     return false;
 401 }
 402
 403 bool
 404 FGAIManager::loadScenario( const string &filename )
 405 {
 406     SGPropertyNode_ptr file = loadScenarioFile(filename);
 407     if (!file) {
 408         return false;
 409     }
 410
 411     SGPropertyNode_ptr scNode = file->getChild("scenario");
 412     if (!scNode) {
 413         return false;
 414     }
 415
 416     _scenarios[filename] = new Scenario(this, filename, scNode);
 417     return true;
 418 }
 419
 420
 421 bool
 422 FGAIManager::unloadScenario( const string &filename)
 423 {
 424     ScenarioDict::iterator it = _scenarios.find(filename);
 425     if (it == _scenarios.end()) {
 426         SG_LOG(SG_AI, SG_WARN, "unload scenario: not found:" << filename);
 427         return false;
 428     }
 429
 430 // remove /sim/ai node
 431     unsigned int index = 0;
 432     for (SGPropertyNode* n = NULL; (n = root->getChild("scenario", index)) != NULL; ++index) {
 433         if (n->getStringValue() == filename) {
 434             root->removeChild("scenario", index);
 435             break;
 436         }
 437     }
 438
 439     delete it->second;
 440     _scenarios.erase(it);
 441     return true;
 442 }
 443
 444 void
 445 FGAIManager::unloadAllScenarios()
 446 {
 447     ScenarioDict::iterator it = _scenarios.begin();
 448     for (; it != _scenarios.end(); ++it) {
 449         delete it->second;
 450     } // of scenarios iteration
 451
 452
 453     // remove /sim/ai node
 454     root->removeChildren("scenario");
 455     _scenarios.clear();
 456 }
 457
 458
 459 SGPropertyNode_ptr
 460 FGAIManager::loadScenarioFile(const std::string& filename)
 461 {
 462     SGPath path(globals->get_fg_root());
 463     path.append("AI/" + filename + ".xml");
 464     try {
 465         SGPropertyNode_ptr root = new SGPropertyNode;
 466         readProperties(path.str(), root);
 467         return root;
 468     } catch (const sg_exception &t) {
 469         SG_LOG(SG_AI, SG_ALERT, "Failed to load scenario '"
 470             << path.str() << "': " << t.getFormattedMessage());
 471     }
 472     return 0;
 473 }
 474
 475 bool
 476 FGAIManager::getStartPosition(const string& id, const string& pid,
 477                               SGGeod& geodPos, double& hdng, SGVec3d& uvw)
 478 {
 479     bool found = false;
 480     SGPropertyNode* root = fgGetNode("sim/ai", true);
 481     if (!root->getNode("enabled", true)->getBoolValue())
 482         return found;
 483
 484     for (int i = 0 ; (!found) && i < root->nChildren() ; i++) {
 485         SGPropertyNode *aiEntry = root->getChild( i );
 486         if ( !strcmp( aiEntry->getName(), "scenario" ) ) {
 487             const string& filename = aiEntry->getStringValue();
 488             SGPropertyNode_ptr scenarioTop = loadScenarioFile(filename);
 489             if (scenarioTop) {
 490                 SGPropertyNode* scenarios = scenarioTop->getChild("scenario");
 491                 if (scenarios) {
 492                     for (int i = 0; i < scenarios->nChildren(); i++) {
 493                         SGPropertyNode* scEntry = scenarios->getChild(i);
 494                         const std::string& type = scEntry->getStringValue("type");
 495                         const std::string& pnumber = scEntry->getStringValue("pennant-number");
 496                         const std::string& name = scEntry->getStringValue("name");
 497                         if (type == "carrier" && (pnumber == id || name == id)) {
 498                             SGSharedPtr<FGAICarrier> carrier = new FGAICarrier;
 499                             carrier->readFromScenario(scEntry);
 500
 501                             if (carrier->getParkPosition(pid, geodPos, hdng, uvw)) {
 502                                 found = true;
 503                                 break;
 504                             }
 505                         }
 506                     }
 507                 }
 508             }
 509         }
 510     }
 511     return found;
 512 }
 513
 514 const FGAIBase *
 515 FGAIManager::calcCollision(double alt, double lat, double lon, double fuse_range)
 516 {
 517     // we specify tgt extent (ft) according to the AIObject type
 518     double tgt_ht[]     = {0,  50, 100, 250, 0, 100, 0, 0,  50,  50, 20, 100,  50};
 519     double tgt_length[] = {0, 100, 200, 750, 0,  50, 0, 0, 200, 100, 40, 200, 100};
 520     ai_list_iterator ai_list_itr = ai_list.begin();
 521     ai_list_iterator end = ai_list.end();
 522
 523     SGGeod pos(SGGeod::fromDegFt(lon, lat, alt));
 524     SGVec3d cartPos(SGVec3d::fromGeod(pos));
 525
 526     while (ai_list_itr != end) {
 527         double tgt_alt = (*ai_list_itr)->_getAltitude();
 528         int type       = (*ai_list_itr)->getType();
 529         tgt_ht[type] += fuse_range;
 530
 531         if (fabs(tgt_alt - alt) > tgt_ht[type] || type == FGAIBase::otBallistic
 532             || type == FGAIBase::otStorm || type == FGAIBase::otThermal ) {
 533                 //SG_LOG(SG_AI, SG_DEBUG, "AIManager: skipping "
 534                 //    << fabs(tgt_alt - alt)
 535                 //    << " "
 536                 //    << type
 537                 //    );
 538                 ++ai_list_itr;
 539                 continue;
 540         }
 541
 542         int id         = (*ai_list_itr)->getID();
 543
 544         double range = calcRangeFt(cartPos, (*ai_list_itr));
 545
 546         //SG_LOG(SG_AI, SG_DEBUG, "AIManager:  AI list size "
 547         //    << ai_list.size()
 548         //    << " type " << type
 549         //    << " ID " << id
 550         //    << " range " << range
 551         //    //<< " bearing " << bearing
 552         //    << " alt " << tgt_alt
 553         //    );
 554
 555         tgt_length[type] += fuse_range;
 556
 557         if (range < tgt_length[type]){
 558             SG_LOG(SG_AI, SG_DEBUG, "AIManager: HIT! "
 559                 << " type " << type
 560                 << " ID " << id
 561                 << " range " << range
 562                 << " alt " << tgt_alt
 563                 );
 564             return (*ai_list_itr).get();
 565         }
 566         ++ai_list_itr;
 567     }
 568     return 0;
 569 }
 570
 571 double
 572 FGAIManager::calcRangeFt(const SGVec3d& aCartPos, FGAIBase* aObject) const
 573 {
 574     double distM = dist(aCartPos, aObject->getCartPos());
 575     return distM * SG_METER_TO_FEET;
 576 }
 577
 578 //end AIManager.cxx