1 // FGAIBase - abstract base class for AI objects
2 // Written by David Culp, started Nov 2003, based on
3 // David Luff's FGAIEntity class.
4 // - davidculp2@comcast.net
6 // With additions by Mathias Froehlich & Vivian Meazza 2004 -2007
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
31 #include <osg/ref_ptr>
33 #include <osgDB/FileUtils>
35 #include <simgear/math/SGMath.hxx>
36 #include <simgear/misc/sg_path.hxx>
37 #include <simgear/scene/model/modellib.hxx>
38 #include <simgear/scene/util/SGNodeMasks.hxx>
39 #include <simgear/debug/logstream.hxx>
40 #include <simgear/props/props.hxx>
42 #include <Main/globals.hxx>
43 #include <Scenery/scenery.hxx>
44 #include <Scripting/NasalSys.hxx>
47 #include "AIManager.hxx"
49 const char *default_model = "Models/Geometry/glider.ac";
50 const double FGAIBase::e = 2.71828183;
51 const double FGAIBase::lbs_to_slugs = 0.031080950172; //conversion factor
53 using namespace simgear;
55 FGAIBase::FGAIBase(object_type ot) :
57 model_removed( fgGetNode("/ai/models/model-removed", true) ),
69 _refID( _newAIModelID() ),
73 tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
74 tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
75 bearing = elevation = range = rdot = 0.0;
76 x_shift = y_shift = rotation = 0.0;
82 _impact_reported = false;
83 _collision_reported = false;
84 _expiry_reported = false;
96 userpos = SGGeod::fromDeg(0, 0);
98 pos = SGGeod::fromDeg(0, 0);
101 speed_north_deg_sec = 0;
102 speed_east_deg_sec = 0;
123 FGAIBase::~FGAIBase() {
124 // Unregister that one at the scenery manager
125 if (globals->get_scenery()) {
126 globals->get_scenery()->get_scene_graph()->removeChild(aip.getSceneGraph());
130 SGPropertyNode* parent = props->getParent();
133 model_removed->setStringValue(props->getPath());
139 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
144 setPath(scFileNode->getStringValue("model",
145 fgGetString("/sim/multiplay/default-model", default_model)));
147 setHeading(scFileNode->getDoubleValue("heading", 0.0));
148 setSpeed(scFileNode->getDoubleValue("speed", 0.0));
149 setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
150 setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
151 setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
152 setBank(scFileNode->getDoubleValue("roll", 0.0));
154 SGPropertyNode* submodels = scFileNode->getChild("submodels");
157 setServiceable(submodels->getBoolValue("serviceable", false));
158 setSMPath(submodels->getStringValue("path", ""));
163 void FGAIBase::update(double dt) {
165 if (_otype == otStatic)
168 if (_otype == otBallistic)
171 ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
172 ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
175 void FGAIBase::Transform() {
178 aip.setVisible(true);
179 aip.setPosition(pos);
182 aip.setOrientation(0.0, pitch, hdg);
184 aip.setOrientation(roll, pitch, hdg);
188 aip.setVisible(false);
194 bool FGAIBase::init(bool search_in_AI_path) {
195 osg::ref_ptr<osgDB::ReaderWriter::Options> opt=
196 new osgDB::ReaderWriter::Options(*osgDB::Registry::instance()->getOptions());
198 if(search_in_AI_path)
200 SGPath ai_path(globals->get_fg_root());
201 ai_path.append("AI");
202 opt->getDatabasePathList().push_front(ai_path.str());
205 string f = osgDB::findDataFile(model_path, opt.get());
208 f = fgGetString("/sim/multiplay/default-model", default_model);
210 model = load3DModel(f, props);
212 if (model.valid() && _initialized == false) {
213 aip.init( model.get() );
214 aip.setVisible(true);
216 globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
219 } else if (!model_path.empty()) {
220 SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
227 void FGAIBase::initModel(osg::Node *node)
231 props->setStringValue("submodels/path", _path.c_str());
232 SG_LOG(SG_INPUT, SG_DEBUG, "AIBase: submodels/path " << _path);
234 fgSetString("/ai/models/model-added", props->getPath().c_str());
235 } else if (!model_path.empty()) {
236 SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
239 //props->setStringValue("submodels/path", _path.c_str());
244 osg::Node* FGAIBase::load3DModel(const string &path, SGPropertyNode *prop_root)
246 model = SGModelLib::loadPagedModel(path, prop_root, new FGNasalModelData(prop_root));
247 initModel(model.get());
251 bool FGAIBase::isa( object_type otype ) {
252 return otype == _otype;
256 void FGAIBase::bind() {
257 props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
259 props->tie("velocities/true-airspeed-kt", SGRawValuePointer<double>(&speed));
260 props->tie("velocities/vertical-speed-fps",
261 SGRawValueMethods<FGAIBase,double>(*this,
262 &FGAIBase::_getVS_fps,
263 &FGAIBase::_setVS_fps));
265 props->tie("position/altitude-ft",
266 SGRawValueMethods<FGAIBase,double>(*this,
267 &FGAIBase::_getAltitude,
268 &FGAIBase::_setAltitude));
269 props->tie("position/latitude-deg",
270 SGRawValueMethods<FGAIBase,double>(*this,
271 &FGAIBase::_getLatitude,
272 &FGAIBase::_setLatitude));
273 props->tie("position/longitude-deg",
274 SGRawValueMethods<FGAIBase,double>(*this,
275 &FGAIBase::_getLongitude,
276 &FGAIBase::_setLongitude));
278 props->tie("position/global-x",
279 SGRawValueMethods<FGAIBase,double>(*this,
280 &FGAIBase::_getCartPosX,
282 props->tie("position/global-y",
283 SGRawValueMethods<FGAIBase,double>(*this,
284 &FGAIBase::_getCartPosY,
286 props->tie("position/global-z",
287 SGRawValueMethods<FGAIBase,double>(*this,
288 &FGAIBase::_getCartPosZ,
290 props->tie("callsign",
291 SGRawValueMethods<FGAIBase,const char*>(*this,
292 &FGAIBase::_getCallsign,
295 props->tie("orientation/pitch-deg", SGRawValuePointer<double>(&pitch));
296 props->tie("orientation/roll-deg", SGRawValuePointer<double>(&roll));
297 props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
299 props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
300 props->tie("radar/bearing-deg", SGRawValuePointer<double>(&bearing));
301 props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
302 props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
303 props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
304 props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
305 props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
306 props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
307 props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
308 props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
309 props->tie("subID", SGRawValuePointer<int>(&_subID));
310 props->tie("controls/lighting/nav-lights",
311 SGRawValueFunctions<bool>(_isNight));
312 props->setBoolValue("controls/lighting/beacon", true);
313 props->setBoolValue("controls/lighting/strobe", true);
314 props->setBoolValue("controls/glide-path", true);
316 props->setStringValue("controls/flight/lateral-mode", "roll");
317 props->setDoubleValue("controls/flight/target-hdg", hdg);
318 props->setDoubleValue("controls/flight/target-roll", roll);
320 props->setStringValue("controls/flight/longitude-mode", "alt");
321 props->setDoubleValue("controls/flight/target-alt", altitude_ft);
322 props->setDoubleValue("controls/flight/target-pitch", pitch);
324 props->setDoubleValue("controls/flight/target-spd", speed);
328 void FGAIBase::unbind() {
330 props->untie("velocities/true-airspeed-kt");
331 props->untie("velocities/vertical-speed-fps");
333 props->untie("position/altitude-ft");
334 props->untie("position/latitude-deg");
335 props->untie("position/longitude-deg");
336 props->untie("position/global-x");
337 props->untie("position/global-y");
338 props->untie("position/global-z");
339 props->untie("callsign");
341 props->untie("orientation/pitch-deg");
342 props->untie("orientation/roll-deg");
343 props->untie("orientation/true-heading-deg");
345 props->untie("radar/in-range");
346 props->untie("radar/bearing-deg");
347 props->untie("radar/elevation-deg");
348 props->untie("radar/range-nm");
349 props->untie("radar/h-offset");
350 props->untie("radar/v-offset");
351 props->untie("radar/x-shift");
352 props->untie("radar/y-shift");
353 props->untie("radar/rotation");
354 props->untie("radar/ht-diff-ft");
356 props->untie("controls/lighting/nav-lights");
358 props->setBoolValue("/sim/controls/radar/", true);
362 double FGAIBase::UpdateRadar(FGAIManager* manager) {
363 bool control = fgGetBool("/sim/controls/radar", true);
365 if(!control) return 0;
367 double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
368 bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
369 radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
370 radar_range_ft2 *= radar_range_ft2;
372 double user_latitude = manager->get_user_latitude();
373 double user_longitude = manager->get_user_longitude();
374 double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
375 double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
376 double range_ft2 = lat_range*lat_range + lon_range*lon_range;
379 // Test whether the target is within radar range.
381 in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
383 if ( in_range || force_on ) {
384 props->setBoolValue("radar/in-range", true);
386 // copy values from the AIManager
387 double user_altitude = manager->get_user_altitude();
388 double user_heading = manager->get_user_heading();
389 double user_pitch = manager->get_user_pitch();
390 //double user_yaw = manager->get_user_yaw();
391 //double user_speed = manager->get_user_speed();
393 // calculate range to target in feet and nautical miles
394 double range_ft = sqrt( range_ft2 );
395 range = range_ft / 6076.11549;
397 // calculate bearing to target
398 if (pos.getLatitudeDeg() >= user_latitude) {
399 bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
400 if (pos.getLongitudeDeg() >= user_longitude) {
401 bearing = 90.0 - bearing;
403 bearing = 270.0 + bearing;
406 bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
407 if (pos.getLongitudeDeg() >= user_longitude) {
408 bearing = 180.0 - bearing;
410 bearing = 180.0 + bearing;
414 // This is an alternate way to compute bearing and distance which
415 // agrees with the original scheme within about 0.1 degrees.
417 // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
418 // user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
419 // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
420 // double gc_bearing, gc_range;
421 // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
422 // gc_range *= SG_METER_TO_NM;
423 // gc_bearing *= SGD_RADIANS_TO_DEGREES;
424 // printf("orig b = %.3f %.2f gc b= %.3f, %.2f\n",
425 // bearing, range, gc_bearing, gc_range);
427 // calculate look left/right to target, without yaw correction
428 horiz_offset = bearing - user_heading;
429 if (horiz_offset > 180.0) horiz_offset -= 360.0;
430 if (horiz_offset < -180.0) horiz_offset += 360.0;
432 // calculate elevation to target
433 elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
435 // calculate look up/down to target
436 vert_offset = elevation - user_pitch;
438 /* this calculation needs to be fixed, but it isn't important anyway
439 // calculate range rate
440 double recip_bearing = bearing + 180.0;
441 if (recip_bearing > 360.0) recip_bearing -= 360.0;
442 double my_horiz_offset = recip_bearing - hdg;
443 if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
444 if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
445 rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
446 +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
449 // now correct look left/right for yaw
450 // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
452 // calculate values for radar display
453 y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
454 x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
455 rotation = hdg - user_heading;
456 if (rotation < 0.0) rotation += 360.0;
457 ht_diff = altitude_ft - user_altitude;
465 * Getters and Setters
468 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
469 // Transform that one to the horizontal local coordinate system.
470 SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
472 // and postrotate the orientation of the AIModel wrt the horizontal
474 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
476 // The offset converted to the usual body fixed coordinate system
477 // rotated to the earth fixed coordinates axis
478 SGVec3d off = hlTrans.backTransform(_off);
480 // Add the position offset of the AIModel to gain the earth centered position
481 SGVec3d cartPos = SGVec3d::fromGeod(pos);
483 return cartPos + off;
486 SGVec3d FGAIBase::getCartPos() const {
487 SGVec3d cartPos = SGVec3d::fromGeod(pos);
491 bool FGAIBase::getGroundElevationM(const SGGeod& pos, double& elev,
492 const SGMaterial** material) const {
493 return globals->get_scenery()->get_elevation_m(pos, elev, material,
497 double FGAIBase::_getCartPosX() const {
498 SGVec3d cartPos = getCartPos();
502 double FGAIBase::_getCartPosY() const {
503 SGVec3d cartPos = getCartPos();
507 double FGAIBase::_getCartPosZ() const {
508 SGVec3d cartPos = getCartPos();
512 void FGAIBase::_setLongitude( double longitude ) {
513 pos.setLongitudeDeg(longitude);
516 void FGAIBase::_setLatitude ( double latitude ) {
517 pos.setLatitudeDeg(latitude);
520 void FGAIBase::_setUserPos(){
521 userpos.setLatitudeDeg(manager->get_user_latitude());
522 userpos.setLongitudeDeg(manager->get_user_longitude());
523 userpos.setElevationM(manager->get_user_altitude() * SG_FEET_TO_METER);
526 void FGAIBase::_setSubID( int s ) {
530 double FGAIBase::_getLongitude() const {
531 return pos.getLongitudeDeg();
534 double FGAIBase::_getLatitude() const {
535 return pos.getLatitudeDeg();
538 double FGAIBase::_getElevationFt() const {
539 return pos.getElevationFt();
542 double FGAIBase::_getRdot() const {
546 double FGAIBase::_getVS_fps() const {
550 double FGAIBase::_get_speed_east_fps() const {
551 return speed_east_deg_sec * ft_per_deg_lon;
554 double FGAIBase::_get_speed_north_fps() const {
555 return speed_north_deg_sec * ft_per_deg_lat;
558 void FGAIBase::_setVS_fps( double _vs ) {
562 double FGAIBase::_getAltitude() const {
566 bool FGAIBase::_getServiceable() const {
570 SGPropertyNode* FGAIBase::_getProps() const {
574 void FGAIBase::_setAltitude( double _alt ) {
578 bool FGAIBase::_isNight() {
579 return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
582 bool FGAIBase::_getCollisionData() {
583 return _collision_reported;
586 bool FGAIBase::_getExpiryData() {
587 return _expiry_reported;
590 bool FGAIBase::_getImpactData() {
591 return _impact_reported;
594 double FGAIBase::_getImpactLat() const {
598 double FGAIBase::_getImpactLon() const {
602 double FGAIBase::_getImpactElevFt() const {
603 return _impact_elev * SG_METER_TO_FEET;
606 double FGAIBase::_getImpactPitch() const {
607 return _impact_pitch;
610 double FGAIBase::_getImpactRoll() const {
614 double FGAIBase::_getImpactHdg() const {
618 double FGAIBase::_getImpactSpeed() const {
619 return _impact_speed;
622 int FGAIBase::getID() const {
626 int FGAIBase::_getSubID() const {
630 double FGAIBase::_getSpeed() const {
634 double FGAIBase::_getRoll() const {
638 double FGAIBase::_getPitch() const {
642 double FGAIBase::_getHeading() const {
646 double FGAIBase::_getXOffset() const {
650 double FGAIBase::_getYOffset() const {
654 double FGAIBase::_getZOffset() const {
658 const char* FGAIBase::_getPath() const {
659 return model_path.c_str();
662 const char* FGAIBase::_getSMPath() const {
663 return _path.c_str();
666 const char* FGAIBase::_getName() const {
667 return _name.c_str();
670 const char* FGAIBase::_getCallsign() const {
671 return _callsign.c_str();
674 const char* FGAIBase::_getSubmodel() const {
675 return _submodel.c_str();
678 void FGAIBase::CalculateMach() {
679 // Calculate rho at altitude, using standard atmosphere
680 // For the temperature T and the pressure p,
681 double altitude = altitude_ft;
683 if (altitude < 36152) { // curve fits for the troposphere
684 T = 59 - 0.00356 * altitude;
685 p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
686 } else if ( 36152 < altitude && altitude < 82345 ) { // lower stratosphere
688 p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
689 } else { // upper stratosphere
690 T = -205.05 + (0.00164 * altitude);
691 p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
694 rho = p / (1718 * (T + 459.7));
696 // calculate the speed of sound at altitude
697 // a = sqrt ( g * R * (T + 459.7))
699 // a = speed of sound [ft/s]
700 // g = specific heat ratio, which is usually equal to 1.4
701 // R = specific gas constant, which equals 1716 ft-lb/slug/R
702 a = sqrt ( 1.4 * 1716 * (T + 459.7));
704 // calculate Mach number
707 // cout << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
710 int FGAIBase::_newAIModelID() {
714 id++; // id = 0 is not allowed.