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