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.
28 #include <simgear/compiler.h>
32 #include <osg/ref_ptr>
35 #include <simgear/math/point3d.hxx>
36 #include <simgear/math/polar3d.hxx>
37 #include <simgear/math/sg_geodesy.hxx>
38 #include <simgear/misc/sg_path.hxx>
39 #include <simgear/scene/model/location.hxx>
40 #include <simgear/scene/model/model.hxx>
41 #include <simgear/scene/util/SGNodeMasks.hxx>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/props/props.hxx>
45 #include <Main/globals.hxx>
46 #include <Scenery/scenery.hxx>
47 #include <Scripting/NasalSys.hxx>
50 #include "AIManager.hxx"
52 const double FGAIBase::e = 2.71828183;
53 const double FGAIBase::lbs_to_slugs = 0.031080950172; //conversion factor
56 FGAIBase::FGAIBase(object_type ot) :
58 model_removed( fgGetNode("/ai/models/model-removed", true) ),
70 _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;
87 FGAIBase::~FGAIBase() {
88 // Unregister that one at the scenery manager
89 if (globals->get_scenery()) {
90 globals->get_scenery()->get_scene_graph()->removeChild(aip.getSceneGraph());
94 SGPropertyNode* parent = props->getParent();
97 model_removed->setStringValue(props->getPath());
103 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
108 setPath(scFileNode->getStringValue("model", "Models/Geometry/glider.ac"));
110 setHeading(scFileNode->getDoubleValue("heading", 0.0));
111 setSpeed(scFileNode->getDoubleValue("speed", 0.0));
112 setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
113 setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
114 setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
115 setBank(scFileNode->getDoubleValue("roll", 0.0));
117 SGPropertyNode* submodels = scFileNode->getChild("submodels");
120 setServiceable(submodels->getBoolValue("serviceable", false));
121 setSMPath(submodels->getStringValue("path", ""));
126 void FGAIBase::update(double dt) {
128 if (_otype == otStatic)
131 if (_otype == otBallistic)
134 ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
135 ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
138 void FGAIBase::Transform() {
141 aip.setPosition(pos);
144 aip.setOrientation(0.0, pitch, hdg);
146 aip.setOrientation(roll, pitch, hdg);
153 bool FGAIBase::init(bool search_in_AI_path) {
155 if (!model_path.empty()) {
157 if ( search_in_AI_path
158 && (model_path.substr(model_path.size() - 4, 4) == ".xml")) {
159 SGPath ai_path("AI");
160 ai_path.append(model_path);
162 model = load3DModel( globals->get_fg_root(), ai_path.str(), props,
163 globals->get_sim_time_sec() );
164 } catch (const sg_exception &e) {
172 model = load3DModel( globals->get_fg_root(), model_path, props,
173 globals->get_sim_time_sec() );
174 } catch (const sg_exception &e) {
182 aip.init( model.get() );
183 aip.setVisible(true);
185 globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
186 fgSetString("/ai/models/model-added", props->getPath());
188 } else if (!model_path.empty()) {
189 SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
192 props->setStringValue("submodels/path", _path.c_str());
198 osg::Node* FGAIBase::load3DModel(const string& fg_root,
200 SGPropertyNode *prop_root,
203 model = sgLoad3DModel(fg_root, path, prop_root, sim_time_sec, 0,
204 new FGNasalModelData(prop_root));
205 model->setNodeMask(model->getNodeMask() & ~SG_NODEMASK_TERRAIN_BIT);
209 bool FGAIBase::isa( object_type otype ) {
210 return otype == _otype;
214 void FGAIBase::bind() {
215 props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
217 props->tie("velocities/true-airspeed-kt", SGRawValuePointer<double>(&speed));
218 props->tie("velocities/vertical-speed-fps",
219 SGRawValueMethods<FGAIBase,double>(*this,
220 &FGAIBase::_getVS_fps,
221 &FGAIBase::_setVS_fps));
223 props->tie("position/altitude-ft",
224 SGRawValueMethods<FGAIBase,double>(*this,
225 &FGAIBase::_getAltitude,
226 &FGAIBase::_setAltitude));
227 props->tie("position/latitude-deg",
228 SGRawValueMethods<FGAIBase,double>(*this,
229 &FGAIBase::_getLatitude,
230 &FGAIBase::_setLatitude));
231 props->tie("position/longitude-deg",
232 SGRawValueMethods<FGAIBase,double>(*this,
233 &FGAIBase::_getLongitude,
234 &FGAIBase::_setLongitude));
236 props->tie("position/global-x",
237 SGRawValueMethods<FGAIBase,double>(*this,
238 &FGAIBase::_getCartPosX,
240 props->tie("position/global-y",
241 SGRawValueMethods<FGAIBase,double>(*this,
242 &FGAIBase::_getCartPosY,
244 props->tie("position/global-z",
245 SGRawValueMethods<FGAIBase,double>(*this,
246 &FGAIBase::_getCartPosZ,
248 props->tie("callsign",
249 SGRawValueMethods<FGAIBase,const char*>(*this,
250 &FGAIBase::_getCallsign,
253 props->tie("orientation/pitch-deg", SGRawValuePointer<double>(&pitch));
254 props->tie("orientation/roll-deg", SGRawValuePointer<double>(&roll));
255 props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
257 props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
258 props->tie("radar/bearing-deg", SGRawValuePointer<double>(&bearing));
259 props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
260 props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
261 props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
262 props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
263 props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
264 props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
265 props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
266 props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
267 props->tie("subID", SGRawValuePointer<int>(&_subID));
268 props->tie("controls/lighting/nav-lights",
269 SGRawValueFunctions<bool>(_isNight));
270 props->setBoolValue("controls/lighting/beacon", true);
271 props->setBoolValue("controls/lighting/strobe", true);
272 props->setBoolValue("controls/glide-path", true);
274 props->setStringValue("controls/flight/lateral-mode", "roll");
275 props->setDoubleValue("controls/flight/target-hdg", hdg);
276 props->setDoubleValue("controls/flight/target-roll", roll);
278 props->setStringValue("controls/flight/longitude-mode", "alt");
279 props->setDoubleValue("controls/flight/target-alt", altitude_ft);
280 props->setDoubleValue("controls/flight/target-pitch", pitch);
282 props->setDoubleValue("controls/flight/target-spd", speed);
286 void FGAIBase::unbind() {
288 props->untie("velocities/true-airspeed-kt");
289 props->untie("velocities/vertical-speed-fps");
291 props->untie("position/altitude-ft");
292 props->untie("position/latitude-deg");
293 props->untie("position/longitude-deg");
294 props->untie("position/global-x");
295 props->untie("position/global-y");
296 props->untie("position/global-z");
297 props->untie("callsign");
299 props->untie("orientation/pitch-deg");
300 props->untie("orientation/roll-deg");
301 props->untie("orientation/true-heading-deg");
303 props->untie("radar/in-range");
304 props->untie("radar/bearing-deg");
305 props->untie("radar/elevation-deg");
306 props->untie("radar/range-nm");
307 props->untie("radar/h-offset");
308 props->untie("radar/v-offset");
309 props->untie("radar/x-shift");
310 props->untie("radar/y-shift");
311 props->untie("radar/rotation");
312 props->untie("radar/ht-diff-ft");
314 props->untie("controls/lighting/nav-lights");
317 double FGAIBase::UpdateRadar(FGAIManager* manager) {
318 double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
319 bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
320 radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
321 radar_range_ft2 *= radar_range_ft2;
323 double user_latitude = manager->get_user_latitude();
324 double user_longitude = manager->get_user_longitude();
325 double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
326 double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
327 double range_ft2 = lat_range*lat_range + lon_range*lon_range;
330 // Test whether the target is within radar range.
332 in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
334 if ( in_range || force_on ) {
335 props->setBoolValue("radar/in-range", true);
337 // copy values from the AIManager
338 double user_altitude = manager->get_user_altitude();
339 double user_heading = manager->get_user_heading();
340 double user_pitch = manager->get_user_pitch();
341 //double user_yaw = manager->get_user_yaw();
342 //double user_speed = manager->get_user_speed();
344 // calculate range to target in feet and nautical miles
345 double range_ft = sqrt( range_ft2 );
346 range = range_ft / 6076.11549;
348 // calculate bearing to target
349 if (pos.getLatitudeDeg() >= user_latitude) {
350 bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
351 if (pos.getLongitudeDeg() >= user_longitude) {
352 bearing = 90.0 - bearing;
354 bearing = 270.0 + bearing;
357 bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
358 if (pos.getLongitudeDeg() >= user_longitude) {
359 bearing = 180.0 - bearing;
361 bearing = 180.0 + bearing;
365 // This is an alternate way to compute bearing and distance which
366 // agrees with the original scheme within about 0.1 degrees.
368 // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
369 // user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
370 // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
371 // double gc_bearing, gc_range;
372 // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
373 // gc_range *= SG_METER_TO_NM;
374 // gc_bearing *= SGD_RADIANS_TO_DEGREES;
375 // printf("orig b = %.3f %.2f gc b= %.3f, %.2f\n",
376 // bearing, range, gc_bearing, gc_range);
378 // calculate look left/right to target, without yaw correction
379 horiz_offset = bearing - user_heading;
380 if (horiz_offset > 180.0) horiz_offset -= 360.0;
381 if (horiz_offset < -180.0) horiz_offset += 360.0;
383 // calculate elevation to target
384 elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
386 // calculate look up/down to target
387 vert_offset = elevation - user_pitch;
389 /* this calculation needs to be fixed, but it isn't important anyway
390 // calculate range rate
391 double recip_bearing = bearing + 180.0;
392 if (recip_bearing > 360.0) recip_bearing -= 360.0;
393 double my_horiz_offset = recip_bearing - hdg;
394 if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
395 if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
396 rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
397 +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
400 // now correct look left/right for yaw
401 // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
403 // calculate values for radar display
404 y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
405 x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
406 rotation = hdg - user_heading;
407 if (rotation < 0.0) rotation += 360.0;
408 ht_diff = altitude_ft - user_altitude;
416 * Getters and Setters
419 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
420 // Transform that one to the horizontal local coordinate system.
421 SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
423 // and postrotate the orientation of the AIModel wrt the horizontal
425 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
427 // The offset converted to the usual body fixed coordinate system
428 // rotated to the earth fiexed coordinates axis
429 SGVec3d off = hlTrans.backTransform(_off);
431 // Add the position offset of the AIModel to gain the earth centered position
432 SGVec3d cartPos = SGVec3d::fromGeod(pos);
434 return cartPos + off;
437 SGVec3d FGAIBase::getCartPos() const {
438 // Transform that one to the horizontal local coordinate system.
439 SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
441 // and postrotate the orientation of the AIModel wrt the horizontal
443 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
445 SGVec3d cartPos = SGVec3d::fromGeod(pos);
450 double FGAIBase::_getCartPosX() const {
451 SGVec3d cartPos = getCartPos();
455 double FGAIBase::_getCartPosY() const {
456 SGVec3d cartPos = getCartPos();
460 double FGAIBase::_getCartPosZ() const {
461 SGVec3d cartPos = getCartPos();
465 void FGAIBase::_setLongitude( double longitude ) {
466 pos.setLongitudeDeg(longitude);
469 void FGAIBase::_setLatitude ( double latitude ) {
470 pos.setLatitudeDeg(latitude);
473 void FGAIBase::_setSubID( int s ) {
477 double FGAIBase::_getLongitude() const {
478 return pos.getLongitudeDeg();
481 double FGAIBase::_getLatitude() const {
482 return pos.getLatitudeDeg();
485 double FGAIBase::_getElevationFt () const {
486 return pos.getElevationFt();
489 double FGAIBase::_getRdot() const {
493 double FGAIBase::_getVS_fps() const {
497 double FGAIBase::_get_speed_east_fps() const {
498 return speed_east_deg_sec * ft_per_deg_lon;
501 double FGAIBase::_get_speed_north_fps() const {
502 return speed_north_deg_sec * ft_per_deg_lat;
505 void FGAIBase::_setVS_fps( double _vs ) {
509 double FGAIBase::_getAltitude() const {
513 bool FGAIBase::_getServiceable() const {
517 SGPropertyNode* FGAIBase::_getProps() const {
521 void FGAIBase::_setAltitude( double _alt ) {
525 bool FGAIBase::_isNight() {
526 return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
529 bool FGAIBase::_getCollisionData() {
530 return _collision_reported;
533 bool FGAIBase::_getImpactData() {
534 return _impact_reported;
537 double FGAIBase::_getImpactLat() const {
541 double FGAIBase::_getImpactLon() const {
545 double FGAIBase::_getImpactElevFt() const {
546 return _impact_elev * SG_METER_TO_FEET;
549 double FGAIBase::_getImpactPitch() const {
550 return _impact_pitch;
553 double FGAIBase::_getImpactRoll() const {
557 double FGAIBase::_getImpactHdg() const {
561 double FGAIBase::_getImpactSpeed() const {
562 return _impact_speed;
565 int FGAIBase::getID() const {
569 int FGAIBase::_getSubID() const {
573 double FGAIBase::_getSpeed() const {
577 double FGAIBase::_getRoll() const {
581 double FGAIBase::_getPitch() const {
585 double FGAIBase::_getHeading() const {
589 const char* FGAIBase::_getPath() const {
590 return model_path.c_str();
593 const char* FGAIBase::_getSMPath() const {
594 return _path.c_str();
597 const char* FGAIBase::_getName() const {
598 return _name.c_str();
601 const char* FGAIBase::_getCallsign() const {
602 return _callsign.c_str();
605 const char* FGAIBase::_getSubmodel() const {
606 return _submodel.c_str();
610 void FGAIBase::CalculateMach() {
611 // Calculate rho at altitude, using standard atmosphere
612 // For the temperature T and the pressure p,
613 double altitude = altitude_ft;
615 if (altitude < 36152) { // curve fits for the troposphere
616 T = 59 - 0.00356 * altitude;
617 p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
618 } else if ( 36152 < altitude && altitude < 82345 ) { // lower stratosphere
620 p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
621 } else { // upper stratosphere
622 T = -205.05 + (0.00164 * altitude);
623 p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
626 rho = p / (1718 * (T + 459.7));
628 // calculate the speed of sound at altitude
629 // a = sqrt ( g * R * (T + 459.7))
631 // a = speed of sound [ft/s]
632 // g = specific heat ratio, which is usually equal to 1.4
633 // R = specific gas constant, which equals 1716 ft-lb/slug/R
634 a = sqrt ( 1.4 * 1716 * (T + 459.7));
636 // calculate Mach number
639 // cout << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
642 int FGAIBase::_newAIModelID() {
646 id++; // id = 0 is not allowed.