// FGAIBase - abstract base class for AI objects // Written by David Culp, started Nov 2003, based on // David Luff's FGAIEntity class. // - davidculp2@comcast.net // // With additions by Mathias Froehlich & Vivian Meazza 2004 -2007 // // This program is free software; you can redistribute it and/or // modify it under the terms of the GNU General Public License as // published by the Free Software Foundation; either version 2 of the // License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. #ifdef HAVE_CONFIG_H # include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include
#include #include #include #include #include "AIBase.hxx" #include "AIManager.hxx" const char *default_model = "Models/Geometry/glider.ac"; const double FGAIBase::e = 2.71828183; const double FGAIBase::lbs_to_slugs = 0.031080950172; //conversion factor using std::string; using namespace simgear; class FGAIModelData : public simgear::SGModelData { public: FGAIModelData(SGPropertyNode *root = NULL) : _nasal( new FGNasalModelDataProxy(root) ), _ready(false), _initialized(false), _hasInteriorPath(false), _interiorLoaded(false) { } ~FGAIModelData() { } virtual FGAIModelData* clone() const { return new FGAIModelData(); } /** osg callback, thread-safe */ void modelLoaded(const std::string& path, SGPropertyNode *prop, osg::Node *n) { // WARNING: Called in a separate OSG thread! Only use thread-safe stuff here... if (_ready) return; if(prop->hasChild("interior-path")){ _interiorPath = prop->getStringValue("interior-path"); _hasInteriorPath = true; } _fxpath = prop->getStringValue("sound/path"); _nasal->modelLoaded(path, prop, n); _ready = true; } /** init hook to be called after model is loaded. * Not thread-safe. Call from main thread only. */ void init(void) { _initialized = true; } bool needInitilization(void) { return _ready && !_initialized;} bool isInitialized(void) { return _initialized;} inline std::string& get_sound_path() { return _fxpath;} void setInteriorLoaded(const bool state) { _interiorLoaded = state;} bool getInteriorLoaded(void) { return _interiorLoaded;} bool hasInteriorPath(void) { return _hasInteriorPath;} inline std::string& getInteriorPath() { return _interiorPath; } private: std::auto_ptr _nasal; std::string _fxpath; bool _ready; bool _initialized; std::string _interiorPath; bool _hasInteriorPath; bool _interiorLoaded; }; FGAIBase::FGAIBase(object_type ot, bool enableHot) : _max_speed(300), _name(""), _parent(""), props( NULL ), model_removed( fgGetNode("/ai/models/model-removed", true) ), manager( NULL ), _installed(false), fp( NULL ), _impact_lat(0), _impact_lon(0), _impact_elev(0), _impact_hdg(0), _impact_pitch(0), _impact_roll(0), _impact_speed(0), _refID( _newAIModelID() ), _otype(ot), _initialized(false), _modeldata(0), _fx(0) { tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0; tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0; bearing = elevation = range = rdot = 0.0; x_shift = y_shift = rotation = 0.0; in_range = false; invisible = false; no_roll = true; life = 900; delete_me = false; _impact_reported = false; _collision_reported = false; _expiry_reported = false; _subID = 0; _x_offset = 0; _y_offset = 0; _z_offset = 0; _pitch_offset = 0; _roll_offset = 0; _yaw_offset = 0; pos = SGGeod::fromDeg(0, 0); speed = 0; altitude_ft = 0; speed_north_deg_sec = 0; speed_east_deg_sec = 0; turn_radius_ft = 0; ft_per_deg_lon = 0; ft_per_deg_lat = 0; horiz_offset = 0; vert_offset = 0; ht_diff = 0; serviceable = false; fp = 0; rho = 1; T = 280; p = 1e5; a = 340; Mach = 0; // explicitly disable HOT for (most) AI models if (!enableHot) aip.getSceneGraph()->setNodeMask(~SG_NODEMASK_TERRAIN_BIT); } FGAIBase::~FGAIBase() { // Unregister that one at the scenery manager removeModel(); if (props) { SGPropertyNode* parent = props->getParent(); if (parent) model_removed->setStringValue(props->getPath()); } removeSoundFx(); if (fp) delete fp; fp = 0; } /** Cleanly remove the model * and let the scenery database pager do the clean-up work. */ void FGAIBase::removeModel() { if (!_model.valid()) return; FGScenery* pSceneryManager = globals->get_scenery(); if (pSceneryManager) { osg::ref_ptr temp = _model.get(); pSceneryManager->get_models_branch()->removeChild(aip.getSceneGraph()); // withdraw from SGModelPlacement and drop own reference (unref) aip.clear(); _modeldata = 0; _model = 0; // pass it on to the pager, to be be deleted in the pager thread pSceneryManager->getPager()->queueDeleteRequest(temp); } else { SG_LOG(SG_AI, SG_ALERT, "AIBase: Could not unload model. Missing scenery manager!"); } } void FGAIBase::readFromScenario(SGPropertyNode* scFileNode) { if (!scFileNode) return; setPath(scFileNode->getStringValue("model", fgGetString("/sim/multiplay/default-model", default_model))); setHeading(scFileNode->getDoubleValue("heading", 0.0)); setSpeed(scFileNode->getDoubleValue("speed", 0.0)); setAltitude(scFileNode->getDoubleValue("altitude", 0.0)); setLongitude(scFileNode->getDoubleValue("longitude", 0.0)); setLatitude(scFileNode->getDoubleValue("latitude", 0.0)); setBank(scFileNode->getDoubleValue("roll", 0.0)); SGPropertyNode* submodels = scFileNode->getChild("submodels"); if (submodels) { setServiceable(submodels->getBoolValue("serviceable", false)); setSMPath(submodels->getStringValue("path", "")); } } void FGAIBase::update(double dt) { if (_otype == otStatic) return; if (_otype == otBallistic) CalculateMach(); ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad()); ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad()); if ( _fx ) { // update model's audio sample values _fx->set_position_geod( pos ); SGQuatd orient = SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll); _fx->set_orientation( orient ); SGVec3d velocity; velocity = SGVec3d( speed_north_deg_sec, speed_east_deg_sec, pitch*speed ); _fx->set_velocity( velocity ); } else if ((_modeldata)&&(_modeldata->needInitilization())) { // process deferred nasal initialization, // which must be done in main thread _modeldata->init(); // sound initialization if (fgGetBool("/sim/sound/aimodels/enabled",false)) { const string& fxpath = _modeldata->get_sound_path(); if (fxpath != "") { props->setStringValue("sim/sound/path", fxpath.c_str()); // initialize the sound configuration std::stringstream name; name << "aifx:"; name << _refID; _fx = new FGFX(name.str(), props); _fx->init(); } } } updateInterior(); } void FGAIBase::updateInterior() { if(!_modeldata || !_modeldata->hasInteriorPath()) return; if(!_modeldata->getInteriorLoaded()){ // interior is not yet load double d2 = dist(SGVec3d::fromGeod(pos), globals->get_aircraft_position_cart()); if(d2 <= _maxRangeInterior){ // if the AI is in-range we load the interior _interior = SGModelLib::loadPagedModel(_modeldata->getInteriorPath(), props, _modeldata); if(_interior.valid()){ _interior->setRange(0, 0.0, _maxRangeInterior); aip.add(_interior.get()); _modeldata->setInteriorLoaded(true); SG_LOG(SG_AI, SG_INFO, "AIBase: Loaded interior model " << _interior->getName()); } } } } /** update LOD properties of the model */ void FGAIBase::updateLOD() { double maxRangeDetail = fgGetDouble("/sim/rendering/static-lod/ai-detailed", 10000.0); // double maxRangeBare = fgGetDouble("/sim/rendering/static-lod/ai-bare", 20000.0); _maxRangeInterior = fgGetDouble("/sim/rendering/static-lod/ai-interior", 50.0); if (_model.valid()) { if( maxRangeDetail == 0.0 ) { // disable LOD _model->setRange(0, 0.0, FLT_MAX); _model->setRange(1, FLT_MAX, FLT_MAX); } else { if( fgGetBool("/sim/rendering/static-lod/ai-range-mode-pixel", false ) ) { _model->setRangeMode( osg::LOD::PIXEL_SIZE_ON_SCREEN ); _model->setRange(0, maxRangeDetail, 100000 ); } else { _model->setRangeMode( osg::LOD:: DISTANCE_FROM_EYE_POINT); _model->setRange(0, 0.0, maxRangeDetail); } } } } void FGAIBase::Transform() { if (!invisible) { aip.setVisible(true); aip.setPosition(pos); if (no_roll) aip.setOrientation(0.0, pitch, hdg); else aip.setOrientation(roll, pitch, hdg); aip.update(); } else { aip.setVisible(false); aip.update(); } } bool FGAIBase::init(bool search_in_AI_path) { if (_model.valid()) { SG_LOG(SG_AI, SG_ALERT, "AIBase: Cannot initialize a model multiple times! " << model_path); return false; } string f; if(search_in_AI_path) { BOOST_FOREACH(SGPath p, globals->get_data_paths("AI")) { p.append(model_path); if (p.exists()) { f = p.str(); break; } } // of AI data paths iteration } // of search in AI path if (f.empty()) { f = simgear::SGModelLib::findDataFile(model_path); } if(f.empty()) f = fgGetString("/sim/multiplay/default-model", default_model); else _installed = true; props->addChild("type")->setStringValue("AI"); _modeldata = new FGAIModelData(props); _model= SGModelLib::loadPagedModel(f, props, _modeldata); _model->setName("AI-model range animation node"); // _model->setCenterMode(osg::LOD::USE_BOUNDING_SPHERE_CENTER); // _model->setRangeMode(osg::LOD::DISTANCE_FROM_EYE_POINT); // We really need low-resolution versions of AI/MP aircraft. // Or at least dummy "stubs" with some default silhouette. // _model->addChild( SGModelLib::loadPagedModel(fgGetString("/sim/multiplay/default-model", default_model), // props, new FGNasalModelData(props)), FLT_MAX, FLT_MAX); updateLOD(); initModel(); if (_model.valid() && _initialized == false) { aip.init( _model.get() ); aip.setVisible(true); invisible = false; globals->get_scenery()->get_models_branch()->addChild(aip.getSceneGraph()); _initialized = true; SG_LOG(SG_AI, SG_DEBUG, "AIBase: Loaded model " << model_path); } else if (!model_path.empty()) { SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path); // not properly installed... _installed = false; } setDie(false); return true; } void FGAIBase::initModel() { if (_model.valid()) { if( _path != ""){ props->setStringValue("submodels/path", _path.c_str()); SG_LOG(SG_AI, SG_DEBUG, "AIBase: submodels/path " << _path); } if( _parent!= ""){ props->setStringValue("parent-name", _parent.c_str()); } fgSetString("/ai/models/model-added", props->getPath().c_str()); } else if (!model_path.empty()) { SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path); } setDie(false); } bool FGAIBase::isa( object_type otype ) { return otype == _otype; } void FGAIBase::bind() { _tiedProperties.setRoot(props); tie("id", SGRawValueMethods(*this, &FGAIBase::getID)); tie("velocities/true-airspeed-kt", SGRawValuePointer(&speed)); tie("velocities/vertical-speed-fps", SGRawValueMethods(*this, &FGAIBase::_getVS_fps, &FGAIBase::_setVS_fps)); tie("position/altitude-ft", SGRawValueMethods(*this, &FGAIBase::_getAltitude, &FGAIBase::_setAltitude)); tie("position/latitude-deg", SGRawValueMethods(*this, &FGAIBase::_getLatitude, &FGAIBase::_setLatitude)); tie("position/longitude-deg", SGRawValueMethods(*this, &FGAIBase::_getLongitude, &FGAIBase::_setLongitude)); tie("position/global-x", SGRawValueMethods(*this, &FGAIBase::_getCartPosX, 0)); tie("position/global-y", SGRawValueMethods(*this, &FGAIBase::_getCartPosY, 0)); tie("position/global-z", SGRawValueMethods(*this, &FGAIBase::_getCartPosZ, 0)); tie("callsign", SGRawValueMethods(*this, &FGAIBase::_getCallsign, 0)); tie("orientation/pitch-deg", SGRawValuePointer(&pitch)); tie("orientation/roll-deg", SGRawValuePointer(&roll)); tie("orientation/true-heading-deg", SGRawValuePointer(&hdg)); tie("radar/in-range", SGRawValuePointer(&in_range)); tie("radar/bearing-deg", SGRawValuePointer(&bearing)); tie("radar/elevation-deg", SGRawValuePointer(&elevation)); tie("radar/range-nm", SGRawValuePointer(&range)); tie("radar/h-offset", SGRawValuePointer(&horiz_offset)); tie("radar/v-offset", SGRawValuePointer(&vert_offset)); tie("radar/x-shift", SGRawValuePointer(&x_shift)); tie("radar/y-shift", SGRawValuePointer(&y_shift)); tie("radar/rotation", SGRawValuePointer(&rotation)); tie("radar/ht-diff-ft", SGRawValuePointer(&ht_diff)); tie("subID", SGRawValuePointer(&_subID)); tie("controls/lighting/nav-lights", SGRawValueFunctions(_isNight)); props->setBoolValue("controls/lighting/beacon", true); props->setBoolValue("controls/lighting/strobe", true); props->setBoolValue("controls/glide-path", true); props->setStringValue("controls/flight/lateral-mode", "roll"); props->setDoubleValue("controls/flight/target-hdg", hdg); props->setDoubleValue("controls/flight/target-roll", roll); props->setStringValue("controls/flight/longitude-mode", "alt"); props->setDoubleValue("controls/flight/target-alt", altitude_ft); props->setDoubleValue("controls/flight/target-pitch", pitch); props->setDoubleValue("controls/flight/target-spd", speed); props->setBoolValue("sim/sound/avionics/enabled", false); props->setDoubleValue("sim/sound/avionics/volume", 0.0); props->setBoolValue("sim/sound/avionics/external-view", false); props->setBoolValue("sim/current-view/internal", false); } void FGAIBase::unbind() { _tiedProperties.Untie(); props->setBoolValue("/sim/controls/radar", true); removeSoundFx(); } void FGAIBase::removeSoundFx() { // drop reference to sound effects now if (_fx) { // must remove explicitly - since the sound manager also keeps a reference _fx->unbind(); // now drop last reference - kill the object _fx = 0; } } double FGAIBase::UpdateRadar(FGAIManager* manager) { bool control = fgGetBool("/sim/controls/radar", true); if(!control) return 0; double radar_range_m = fgGetDouble("/instrumentation/radar/range"); bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false); radar_range_m *= SG_NM_TO_METER * 1.1; // + 10% radar_range_m *= radar_range_m; // squared double d2 = distSqr(SGVec3d::fromGeod(pos), globals->get_aircraft_position_cart()); double range_ft = sqrt(d2) * SG_METER_TO_FEET; if (!force_on && (d2 > radar_range_m)) { return range_ft * range_ft; } props->setBoolValue("radar/in-range", true); // copy values from the AIManager double user_heading = manager->get_user_heading(); double user_pitch = manager->get_user_pitch(); range = range_ft * SG_FEET_TO_METER * SG_METER_TO_NM; // calculate bearing to target bearing = SGGeodesy::courseDeg(globals->get_aircraft_position(), pos); // calculate look left/right to target, without yaw correction horiz_offset = bearing - user_heading; SG_NORMALIZE_RANGE(horiz_offset, -180.0, 180.0); // calculate elevation to target ht_diff = altitude_ft - globals->get_aircraft_position().getElevationFt(); elevation = atan2( ht_diff, range_ft ) * SG_RADIANS_TO_DEGREES; // calculate look up/down to target vert_offset = elevation - user_pitch; /* this calculation needs to be fixed, but it isn't important anyway // calculate range rate double recip_bearing = bearing + 180.0; if (recip_bearing > 360.0) recip_bearing -= 360.0; double my_horiz_offset = recip_bearing - hdg; if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0; if (my_horiz_offset < -180.0) my_horiz_offset += 360.0; rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS )) +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS )); */ // now correct look left/right for yaw // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE? // calculate values for radar display y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS); x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS); rotation = hdg - user_heading; SG_NORMALIZE_RANGE(rotation, 0.0, 360.0); return range_ft * range_ft; } /* * Getters and Setters */ SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const { // Transform that one to the horizontal local coordinate system. SGQuatd hlTrans = SGQuatd::fromLonLat(pos); // and postrotate the orientation of the AIModel wrt the horizontal // local frame hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll); // The offset converted to the usual body fixed coordinate system // rotated to the earth fixed coordinates axis SGVec3d off = hlTrans.backTransform(_off); // Add the position offset of the AIModel to gain the earth centered position SGVec3d cartPos = SGVec3d::fromGeod(pos); return cartPos + off; } SGVec3d FGAIBase::getCartPos() const { SGVec3d cartPos = SGVec3d::fromGeod(pos); return cartPos; } bool FGAIBase::getGroundElevationM(const SGGeod& pos, double& elev, const simgear::BVHMaterial** material) const { return globals->get_scenery()->get_elevation_m(pos, elev, material, _model.get()); } double FGAIBase::_getCartPosX() const { SGVec3d cartPos = getCartPos(); return cartPos.x(); } double FGAIBase::_getCartPosY() const { SGVec3d cartPos = getCartPos(); return cartPos.y(); } double FGAIBase::_getCartPosZ() const { SGVec3d cartPos = getCartPos(); return cartPos.z(); } void FGAIBase::_setLongitude( double longitude ) { pos.setLongitudeDeg(longitude); } void FGAIBase::_setLatitude ( double latitude ) { pos.setLatitudeDeg(latitude); } void FGAIBase::_setSubID( int s ) { _subID = s; } bool FGAIBase::setParentNode() { if (_parent == ""){ SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name << " parent not set "); return false; } const SGPropertyNode_ptr ai = fgGetNode("/ai/models", true); for (int i = ai->nChildren() - 1; i >= -1; i--) { SGPropertyNode_ptr model; if (i < 0) { // last iteration: selected model model = _selected_ac; } else { model = ai->getChild(i); //const string& path = ai->getPath(); const string name = model->getStringValue("name"); if (!model->nChildren()){ continue; } if (name == _parent) { _selected_ac = model; // save selected model for last iteration break; } } if (!model) continue; }// end for loop if (_selected_ac != 0){ const string name = _selected_ac->getStringValue("name"); return true; } else { SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name << " parent not found: dying "); setDie(true); return false; } } double FGAIBase::_getLongitude() const { return pos.getLongitudeDeg(); } double FGAIBase::_getLatitude() const { return pos.getLatitudeDeg(); } double FGAIBase::_getElevationFt() const { return pos.getElevationFt(); } double FGAIBase::_getRdot() const { return rdot; } double FGAIBase::_getVS_fps() const { return vs/60.0; } double FGAIBase::_get_speed_east_fps() const { return speed_east_deg_sec * ft_per_deg_lon; } double FGAIBase::_get_speed_north_fps() const { return speed_north_deg_sec * ft_per_deg_lat; } void FGAIBase::_setVS_fps( double _vs ) { vs = _vs*60.0; } double FGAIBase::_getAltitude() const { return altitude_ft; } double FGAIBase::_getAltitudeAGL(SGGeod inpos, double start){ getGroundElevationM(SGGeod::fromGeodM(inpos, start), _elevation_m, NULL); return inpos.getElevationFt() - _elevation_m * SG_METER_TO_FEET; } bool FGAIBase::_getServiceable() const { return serviceable; } SGPropertyNode* FGAIBase::_getProps() const { return props; } void FGAIBase::_setAltitude( double _alt ) { setAltitude( _alt ); } bool FGAIBase::_isNight() { return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57); } bool FGAIBase::_getCollisionData() { return _collision_reported; } bool FGAIBase::_getExpiryData() { return _expiry_reported; } bool FGAIBase::_getImpactData() { return _impact_reported; } double FGAIBase::_getImpactLat() const { return _impact_lat; } double FGAIBase::_getImpactLon() const { return _impact_lon; } double FGAIBase::_getImpactElevFt() const { return _impact_elev * SG_METER_TO_FEET; } double FGAIBase::_getImpactPitch() const { return _impact_pitch; } double FGAIBase::_getImpactRoll() const { return _impact_roll; } double FGAIBase::_getImpactHdg() const { return _impact_hdg; } double FGAIBase::_getImpactSpeed() const { return _impact_speed; } int FGAIBase::getID() const { return _refID; } int FGAIBase::_getSubID() const { return _subID; } double FGAIBase::_getSpeed() const { return speed; } double FGAIBase::_getRoll() const { return roll; } double FGAIBase::_getPitch() const { return pitch; } double FGAIBase::_getHeading() const { return hdg; } double FGAIBase::_getXOffset() const { return _x_offset; } double FGAIBase::_getYOffset() const { return _y_offset; } double FGAIBase::_getZOffset() const { return _z_offset; } const char* FGAIBase::_getPath() const { return model_path.c_str(); } const char* FGAIBase::_getSMPath() const { return _path.c_str(); } const char* FGAIBase::_getName() const { return _name.c_str(); } const char* FGAIBase::_getCallsign() const { return _callsign.c_str(); } const char* FGAIBase::_getSubmodel() const { return _submodel.c_str(); } void FGAIBase::CalculateMach() { // Calculate rho at altitude, using standard atmosphere // For the temperature T and the pressure p, double altitude = altitude_ft; if (altitude < 36152) { // curve fits for the troposphere T = 59 - 0.00356 * altitude; p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256); } else if ( 36152 < altitude && altitude < 82345 ) { // lower stratosphere T = -70; p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) ); } else { // upper stratosphere T = -205.05 + (0.00164 * altitude); p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388); } rho = p / (1718 * (T + 459.7)); // calculate the speed of sound at altitude // a = sqrt ( g * R * (T + 459.7)) // where: // a = speed of sound [ft/s] // g = specific heat ratio, which is usually equal to 1.4 // R = specific gas constant, which equals 1716 ft-lb/slug/R a = sqrt ( 1.4 * 1716 * (T + 459.7)); // calculate Mach number Mach = speed/a; // cout << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl; } int FGAIBase::_newAIModelID() { static int id = 0; if (!++id) id++; // id = 0 is not allowed. return id; } bool FGAIBase::isValid() { //Either no flightplan or it is valid return !fp || fp->isValidPlan(); }