]> git.mxchange.org Git - flightgear.git/blobdiff - src/AIModel/AIManager.cxx
commradio: improvements for atis speech
[flightgear.git] / src / AIModel / AIManager.cxx
index 6718593344f8c7cad6d25d8f44203f00b35f53d6..27582d9ca708a2fb52a236acce96d99989006886 100644 (file)
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 #include <cstring>
+#include <algorithm>
 
 #include <simgear/sg_inlines.h>
 #include <simgear/math/sg_geodesy.hxx>
 #include <simgear/props/props_io.hxx>
 #include <simgear/structure/exception.hxx>
+#include <simgear/structure/commands.hxx>
+#include <simgear/structure/SGBinding.hxx>
+
 #include <boost/mem_fn.hpp>
 #include <boost/foreach.hpp>
 
 #include <Main/globals.hxx>
-
-#include <Airports/simple.hxx>
-#include <Traffic/TrafficMgr.hxx>
+#include <Airports/airport.hxx>
+#include <Scripting/NasalSys.hxx>
 
 #include "AIManager.hxx"
 #include "AIAircraft.hxx"
 #include "AIGroundVehicle.hxx"
 #include "AIEscort.hxx"
 
+class FGAIManager::Scenario
+{
+public:
+    Scenario(FGAIManager* man, const std::string& nm, SGPropertyNode* scenarios) :
+        _internalName(nm)
+    {
+        BOOST_FOREACH(SGPropertyNode* scEntry, scenarios->getChildren("entry")) {
+            FGAIBasePtr ai = man->addObject(scEntry);
+            if (ai) {
+                _objects.push_back(ai);
+            }
+        } // of scenario entry iteration
+        
+        SGPropertyNode* nasalScripts = scenarios->getChild("nasal");
+        if (!nasalScripts) {
+            return;
+        }
+        
+        _unloadScript = nasalScripts->getStringValue("unload");
+        std::string loadScript = nasalScripts->getStringValue("load");
+        if (!loadScript.empty()) {
+            FGNasalSys* nasalSys = (FGNasalSys*) globals->get_subsystem("nasal");
+            std::string moduleName = "scenario_" + _internalName;
+            nasalSys->createModule(moduleName.c_str(), moduleName.c_str(),
+                                   loadScript.c_str(), loadScript.size(),
+                                   0);
+        }
+    }
+    
+    ~Scenario()
+    {
+        BOOST_FOREACH(FGAIBasePtr ai, _objects) {
+            ai->setDie(true);
+        }
+        
+        FGNasalSys* nasalSys = (FGNasalSys*) globals->get_subsystem("nasal");
+        if (!nasalSys)
+            return;
+        
+        std::string moduleName = "scenario_" + _internalName;
+        if (!_unloadScript.empty()) {
+            nasalSys->createModule(moduleName.c_str(), moduleName.c_str(),
+                                   _unloadScript.c_str(), _unloadScript.size(),
+                                   0);
+        }
+        
+        nasalSys->deleteModule(moduleName.c_str());
+    }
+private:
+    std::vector<FGAIBasePtr> _objects;
+    std::string _internalName;
+    std::string _unloadScript;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
 FGAIManager::FGAIManager() :
     cb_ai_bare(SGPropertyChangeCallback<FGAIManager>(this,&FGAIManager::updateLOD,
                fgGetNode("/sim/rendering/static-lod/ai-bare", true))),
@@ -70,55 +129,66 @@ FGAIManager::init() {
     wind_from_east_node  = fgGetNode("/environment/wind-from-east-fps",true);
     wind_from_north_node = fgGetNode("/environment/wind-from-north-fps",true);
 
-    user_latitude_node  = fgGetNode("/position/latitude-deg", true);
-    user_longitude_node = fgGetNode("/position/longitude-deg", true);
-    user_altitude_node  = fgGetNode("/position/altitude-ft", true);
     user_altitude_agl_node  = fgGetNode("/position/altitude-agl-ft", true);
-    user_heading_node   = fgGetNode("/orientation/heading-deg", true);
-    user_pitch_node     = fgGetNode("/orientation/pitch-deg", true);
-    user_yaw_node       = fgGetNode("/orientation/side-slip-deg", true);
-    user_roll_node      = fgGetNode("/orientation/roll-deg", true);
     user_speed_node     = fgGetNode("/velocities/uBody-fps", true);
+    
+    globals->get_commands()->addCommand("load-scenario", this, &FGAIManager::loadScenarioCommand);
+    globals->get_commands()->addCommand("unload-scenario", this, &FGAIManager::unloadScenarioCommand);
+    _environmentVisiblity = fgGetNode("/environment/visibility-m");
 }
 
 void
-FGAIManager::postinit() {
+FGAIManager::postinit()
+{
     // postinit, so that it can access the Nasal subsystem
 
-    if (!root->getBoolValue("scenarios-enabled", true))
-        return;
-
     // scenarios enabled, AI subsystem required
     if (!enabled->getBoolValue())
         enabled->setBoolValue(true);
 
     // process all scenarios
-    map<string, bool> scenarios;
-    for (int i = 0 ; i < root->nChildren() ; i++) {
-        SGPropertyNode *n = root->getChild(i);
-        if (strcmp(n->getName(), "scenario"))
-            continue;
-
-        string name = n->getStringValue();
+    BOOST_FOREACH(SGPropertyNode* n, root->getChildren("scenario")) {
+        const string& name = n->getStringValue();
         if (name.empty())
             continue;
 
-        if (scenarios.find(name) != scenarios.end()) {
-            SG_LOG(SG_AI, SG_DEBUG, "won't load scenario '" << name << "' twice");
+        if (_scenarios.find(name) != _scenarios.end()) {
+            SG_LOG(SG_AI, SG_WARN, "won't load scenario '" << name << "' twice");
             continue;
         }
 
-        SG_LOG(SG_AI, SG_ALERT, "loading scenario '" << name << '\'');
-        processScenario(name);
-        scenarios[name] = true;
+        SG_LOG(SG_AI, SG_INFO, "loading scenario '" << name << '\'');
+        loadScenario(name);
     }
 }
 
 void
 FGAIManager::reinit()
 {
+    // shutdown scenarios
+    unloadAllScenarios();
+    
     update(0.0);
     std::for_each(ai_list.begin(), ai_list.end(), boost::mem_fn(&FGAIBase::reinit));
+    
+    // (re-)load scenarios
+    postinit();
+}
+
+void
+FGAIManager::shutdown()
+{
+    unloadAllScenarios();
+    
+    BOOST_FOREACH(FGAIBase* ai, ai_list) {
+        ai->unbind();
+    }
+    
+    ai_list.clear();
+    _environmentVisiblity.clear();
+    
+    globals->get_commands()->removeCommand("load-scenario");
+    globals->get_commands()->removeCommand("unload-scenario");
 }
 
 void
@@ -135,11 +205,6 @@ FGAIManager::unbind() {
 
 void FGAIManager::removeDeadItem(FGAIBase* base)
 {
-    FGTrafficManager *tmgr = (FGTrafficManager*) globals->get_subsystem("traffic-manager");
-    if (tmgr) {
-        tmgr->release(base->getID());
-    }
-    
     SGPropertyNode *props = base->_getProps();
     
     props->setBoolValue("valid", false);
@@ -175,12 +240,20 @@ FGAIManager::update(double dt) {
   
     ai_list.erase(ai_list.begin(), firstAlive);
   
-    // every remaining item is alive
+    // every remaining item is alive. update them in turn, but guard for
+    // exceptions, so a single misbehaving AI object doesn't bring down the
+    // entire subsystem.
     BOOST_FOREACH(FGAIBase* base, ai_list) {
-        if (base->isa(FGAIBase::otThermal)) {
-            processThermal(dt, (FGAIThermal*)base);
-        } else {
-            base->update(dt);
+        try {
+            if (base->isa(FGAIBase::otThermal)) {
+                processThermal(dt, (FGAIThermal*)base);
+            } else {
+                base->update(dt);
+            }
+        } catch (sg_exception& e) {
+            SG_LOG(SG_AI, SG_WARN, "caught exception updating AI model:" << base->_getName()<< ", which will be killed."
+                   "\n\tError:" << e.getFormattedMessage());
+            base->setDie(true);
         }
     } // of live AI objects iteration
 
@@ -227,23 +300,14 @@ FGAIManager::attach(FGAIBase *model)
     p->setBoolValue("valid", true);
 }
 
-void
-FGAIManager::destroyObject( int ID ) {
-    ai_list_iterator ai_list_itr = ai_list.begin();
-
-    while(ai_list_itr != ai_list.end()) {
-
-        if ((*ai_list_itr)->getID() == ID) {
-            (*ai_list_itr)->unbind();
-            ai_list_itr = ai_list.erase(ai_list_itr);
-        } else
-            ++ai_list_itr;
-    }
-
+bool FGAIManager::isVisible(const SGGeod& pos) const
+{
+  double visibility_meters = _environmentVisiblity->getDoubleValue();
+  return ( dist(globals->get_view_position_cart(), SGVec3d::fromGeod(pos)) ) <= visibility_meters;
 }
 
 int
-FGAIManager::getNumAiObjects(void) const
+FGAIManager::getNumAiObjects() const
 {
     return ai_list.size();
 }
@@ -251,14 +315,8 @@ FGAIManager::getNumAiObjects(void) const
 void
 FGAIManager::fetchUserState( void ) {
 
-    user_latitude  = user_latitude_node->getDoubleValue();
-    user_longitude = user_longitude_node->getDoubleValue();
-    user_altitude  = user_altitude_node->getDoubleValue();
-    user_heading   = user_heading_node->getDoubleValue();
-    user_pitch     = user_pitch_node->getDoubleValue();
-    user_yaw       = user_yaw_node->getDoubleValue();
+    globals->get_aircraft_orientation(user_heading, user_pitch, user_roll);
     user_speed     = user_speed_node->getDoubleValue() * 0.592484;
-    user_roll      = user_roll_node->getDoubleValue();
     wind_from_east = wind_from_east_node->getDoubleValue();
     wind_from_north   = wind_from_north_node->getDoubleValue();
     user_altitude_agl = user_altitude_agl_node->getDoubleValue();
@@ -277,88 +335,163 @@ FGAIManager::processThermal( double dt, FGAIThermal* thermal ) {
 
 }
 
+bool FGAIManager::loadScenarioCommand(const SGPropertyNode* args)
+{
+    std::string name = args->getStringValue("name");
+    if (args->hasChild("load-property")) {
+        // slightly ugly, to simplify life in the dialogs, make load allow
+        // loading or unloading based on a bool property.
+        bool loadIt = fgGetBool(args->getStringValue("load-property"));
+        if (!loadIt) {
+            // user actually wants to unload, fine.
+            return unloadScenario(name);
+        }
+    }
+    
+    if (_scenarios.find(name) != _scenarios.end()) {
+        SG_LOG(SG_AI, SG_WARN, "scenario '" << name << "' already loaded");
+        return false;
+    }
+    
+    bool ok = loadScenario(name);
+    if (ok) {
+        // create /sim/ai node for consistency
+        int index = 0;
+        for (; root->hasChild("scenario", index); ++index) {}
+        
+        SGPropertyNode* scenarioNode = root->getChild("scenario", index, true);
+        scenarioNode->setStringValue(name);
+    }
+    
+    return ok;
+}
+
+bool FGAIManager::unloadScenarioCommand(const SGPropertyNode* args)
+{
+    std::string name = args->getStringValue("name");
+    return unloadScenario(name);
+}
 
+bool FGAIManager::addObjectCommand(const SGPropertyNode* definition)
+{
+    addObject(definition);
+    return true;
+}
 
-void
-FGAIManager::processScenario( const string &filename ) {
+FGAIBasePtr FGAIManager::addObject(const SGPropertyNode* definition)
+{
+    const std::string& type = definition->getStringValue("type", "aircraft");
+    
+    FGAIBase* ai = NULL;
+    if (type == "tanker") { // refueling scenarios
+        ai = new FGAITanker; 
+    } else if (type == "wingman") {
+        ai = new FGAIWingman;
+    } else if (type == "aircraft") {
+        ai = new FGAIAircraft;
+    } else if (type == "ship") {
+        ai = new FGAIShip;
+    } else if (type == "carrier") {
+        ai = new FGAICarrier;
+    } else if (type == "groundvehicle") {
+        ai = new FGAIGroundVehicle;
+    } else if (type == "escort") {
+        ai = new FGAIEscort;
+    } else if (type == "thunderstorm") {
+        ai = new FGAIStorm;
+    } else if (type == "thermal") {
+        ai = new FGAIThermal;
+    } else if (type == "ballistic") {
+        ai = new FGAIBallistic;
+    } else if (type == "static") {
+        ai = new FGAIStatic;
+    }
 
-    SGPropertyNode_ptr scenarioTop = loadScenarioFile(filename);
+    ai->readFromScenario(const_cast<SGPropertyNode*>(definition));
+    attach(ai);
+    return ai;
+}
 
-    if (!scenarioTop)
-        return;
+bool FGAIManager::removeObject(const SGPropertyNode* args)
+{
+    int id = args->getIntValue("id");
+    BOOST_FOREACH(FGAIBase* ai, get_ai_list()) {
+        if (ai->getID() == id) {
+            ai->setDie(true);
+            break;
+        }
+    }
+    
+    return false;
+}
 
-    SGPropertyNode* scenarios = scenarioTop->getChild("scenario");
+FGAIBasePtr FGAIManager::getObjectFromProperty(const SGPropertyNode* aProp) const
+{
+    BOOST_FOREACH(FGAIBase* ai, get_ai_list()) {
+        if (ai->_getProps() == aProp) {
+            return ai;
+        }
+    } // of AI objects iteration
+    
+    return NULL;
+}
 
-    if (!scenarios)
-        return;
+bool
+FGAIManager::loadScenario( const string &filename )
+{
+    SGPropertyNode_ptr file = loadScenarioFile(filename);
+    if (!file) {
+        return false;
+    }
+    
+    SGPropertyNode_ptr scNode = file->getChild("scenario");
+    if (!scNode) {
+        return false;
+    }
+    
+    _scenarios[filename] = new Scenario(this, filename, scNode);
+    return true;
+}
 
-    for (int i = 0; i < scenarios->nChildren(); i++) {
-        SGPropertyNode* scEntry = scenarios->getChild(i);
 
-        if (strcmp(scEntry->getName(), "entry"))
-            continue;
-        std::string type = scEntry->getStringValue("type", "aircraft");
-
-        if (type == "tanker") { // refueling scenarios
-            FGAITanker* tanker = new FGAITanker;
-            tanker->readFromScenario(scEntry);
-            attach(tanker);
-
-        } else if (type == "wingman") {
-            FGAIWingman* wingman = new FGAIWingman;
-            wingman->readFromScenario(scEntry);
-            attach(wingman);
-
-        } else if (type == "aircraft") {
-            FGAIAircraft* aircraft = new FGAIAircraft;
-            aircraft->readFromScenario(scEntry);
-            attach(aircraft);
-
-        } else if (type == "ship") {
-            FGAIShip* ship = new FGAIShip;
-            ship->readFromScenario(scEntry);
-            attach(ship);
-
-        } else if (type == "carrier") {
-            FGAICarrier* carrier = new FGAICarrier;
-            carrier->readFromScenario(scEntry);
-            attach(carrier);
-
-        } else if (type == "groundvehicle") {
-            FGAIGroundVehicle* groundvehicle = new FGAIGroundVehicle;
-            groundvehicle->readFromScenario(scEntry);
-            attach(groundvehicle);
-
-        } else if (type == "escort") {
-            FGAIEscort* escort = new FGAIEscort;
-            escort->readFromScenario(scEntry);
-            attach(escort);
-
-        } else if (type == "thunderstorm") {
-            FGAIStorm* storm = new FGAIStorm;
-            storm->readFromScenario(scEntry);
-            attach(storm);
-
-        } else if (type == "thermal") {
-            FGAIThermal* thermal = new FGAIThermal;
-            thermal->readFromScenario(scEntry);
-            attach(thermal);
-
-        } else if (type == "ballistic") {
-            FGAIBallistic* ballistic = new FGAIBallistic;
-            ballistic->readFromScenario(scEntry);
-            attach(ballistic);
-
-        } else if (type == "static") {
-            FGAIStatic* aistatic = new FGAIStatic;
-            aistatic->readFromScenario(scEntry);
-            attach(aistatic);
+bool
+FGAIManager::unloadScenario( const string &filename)
+{
+    ScenarioDict::iterator it = _scenarios.find(filename);
+    if (it == _scenarios.end()) {
+        SG_LOG(SG_AI, SG_WARN, "unload scenario: not found:" << filename);
+        return false;
+    }
+    
+// remove /sim/ai node
+    unsigned int index = 0;
+    for (SGPropertyNode* n = NULL; (n = root->getChild("scenario", index)) != NULL; ++index) {
+        if (n->getStringValue() == filename) {
+            root->removeChild("scenario", index);
+            break;
         }
-
     }
+    
+    delete it->second;
+    _scenarios.erase(it);
+    return true;
+}
 
+void
+FGAIManager::unloadAllScenarios()
+{
+    ScenarioDict::iterator it = _scenarios.begin();
+    for (; it != _scenarios.end(); ++it) {
+        delete it->second;
+    } // of scenarios iteration
+    
+    
+    // remove /sim/ai node
+    root->removeChildren("scenario");
+    _scenarios.clear();
 }
 
+
 SGPropertyNode_ptr
 FGAIManager::loadScenarioFile(const std::string& filename)
 {
@@ -371,8 +504,8 @@ FGAIManager::loadScenarioFile(const std::string& filename)
     } catch (const sg_exception &t) {
         SG_LOG(SG_AI, SG_ALERT, "Failed to load scenario '"
             << path.str() << "': " << t.getFormattedMessage());
-        return 0;
     }
+    return 0;
 }
 
 bool
@@ -387,16 +520,16 @@ FGAIManager::getStartPosition(const string& id, const string& pid,
     for (int i = 0 ; (!found) && i < root->nChildren() ; i++) {
         SGPropertyNode *aiEntry = root->getChild( i );
         if ( !strcmp( aiEntry->getName(), "scenario" ) ) {
-            string filename = aiEntry->getStringValue();
+            const string& filename = aiEntry->getStringValue();
             SGPropertyNode_ptr scenarioTop = loadScenarioFile(filename);
             if (scenarioTop) {
                 SGPropertyNode* scenarios = scenarioTop->getChild("scenario");
                 if (scenarios) {
                     for (int i = 0; i < scenarios->nChildren(); i++) {
                         SGPropertyNode* scEntry = scenarios->getChild(i);
-                        std::string type = scEntry->getStringValue("type");
-                        std::string pnumber = scEntry->getStringValue("pennant-number");
-                        std::string name = scEntry->getStringValue("name");
+                        const std::string& type = scEntry->getStringValue("type");
+                        const std::string& pnumber = scEntry->getStringValue("pennant-number");
+                        const std::string& name = scEntry->getStringValue("name");
                         if (type == "carrier" && (pnumber == id || name == id)) {
                             SGSharedPtr<FGAICarrier> carrier = new FGAICarrier;
                             carrier->readFromScenario(scEntry);
@@ -444,7 +577,7 @@ FGAIManager::calcCollision(double alt, double lat, double lon, double fuse_range
 
         int id         = (*ai_list_itr)->getID();
 
-        double range = calcRange(cartPos, (*ai_list_itr));
+        double range = calcRangeFt(cartPos, (*ai_list_itr));
 
         //SG_LOG(SG_AI, SG_DEBUG, "AIManager:  AI list size "
         //    << ai_list.size()
@@ -472,7 +605,7 @@ FGAIManager::calcCollision(double alt, double lat, double lon, double fuse_range
 }
 
 double
-FGAIManager::calcRange(const SGVec3d& aCartPos, FGAIBase* aObject) const
+FGAIManager::calcRangeFt(const SGVec3d& aCartPos, FGAIBase* aObject) const
 {
     double distM = dist(aCartPos, aObject->getCartPos());
     return distM * SG_METER_TO_FEET;