]> git.mxchange.org Git - flightgear.git/blob - src/AIModel/AIBase.cxx
make default model configurable (default: Models/Geometry/glider.ac)
[flightgear.git] / src / AIModel / AIBase.cxx
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
5 //
6 // With additions by Mathias Froehlich & Vivian Meazza 2004 -2007
7 //
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.
12 //
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.
17 //
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.
21
22
23 #ifdef HAVE_CONFIG_H
24 #  include <config.h>
25 #endif
26
27 #include <simgear/compiler.h>
28
29 #include <string>
30
31 #include <osg/ref_ptr>
32 #include <osg/Node>
33 #include <osgDB/FileUtils>
34
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/modellib.hxx>
41 #include <simgear/scene/util/SGNodeMasks.hxx>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/props/props.hxx>
44
45 #include <Main/globals.hxx>
46 #include <Scenery/scenery.hxx>
47 #include <Scripting/NasalSys.hxx>
48
49 #include "AIBase.hxx"
50 #include "AIModelData.hxx"
51 #include "AIManager.hxx"
52
53 const char *default_model = "Models/Geometry/glider.ac";
54 const double FGAIBase::e = 2.71828183;
55 const double FGAIBase::lbs_to_slugs = 0.031080950172;   //conversion factor
56
57 using namespace simgear;
58
59 FGAIBase::FGAIBase(object_type ot) :
60     props( NULL ),
61     model_removed( fgGetNode("/ai/models/model-removed", true) ),
62     manager( NULL ),
63     fp( NULL ),
64
65     _impact_lat(0),
66     _impact_lon(0),
67     _impact_elev(0),
68     _impact_hdg(0),
69     _impact_pitch(0),
70     _impact_roll(0),
71     _impact_speed(0),
72
73     _refID( _newAIModelID() ),
74     _otype(ot),
75     _initialized(false)
76 {
77     tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
78     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
79     bearing = elevation = range = rdot = 0.0;
80     x_shift = y_shift = rotation = 0.0;
81     in_range = false;
82     invisible = false;
83     no_roll = true;
84     life = 900;
85     delete_me = false;
86     _impact_reported = false;
87     _collision_reported = false;
88     _subID = 0;
89 }
90
91 FGAIBase::~FGAIBase() {
92     // Unregister that one at the scenery manager
93     if (globals->get_scenery()) {
94         globals->get_scenery()->get_scene_graph()->removeChild(aip.getSceneGraph());
95     }
96
97     if (props) {
98         SGPropertyNode* parent = props->getParent();
99
100         if (parent)
101             model_removed->setStringValue(props->getPath());
102     }
103     delete fp;
104     fp = 0;
105 }
106
107 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
108 {
109     if (!scFileNode)
110         return;
111
112     setPath(scFileNode->getStringValue("model",
113             fgGetString("/sim/multiplay/default-model", default_model)));
114
115     setHeading(scFileNode->getDoubleValue("heading", 0.0));
116     setSpeed(scFileNode->getDoubleValue("speed", 0.0));
117     setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
118     setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
119     setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
120     setBank(scFileNode->getDoubleValue("roll", 0.0));
121
122     SGPropertyNode* submodels = scFileNode->getChild("submodels");
123
124     if (submodels) {
125         setServiceable(submodels->getBoolValue("serviceable", false));
126         setSMPath(submodels->getStringValue("path", ""));
127     }
128
129 }
130
131 void FGAIBase::update(double dt) {
132
133     if (_otype == otStatic)
134         return;
135
136     if (_otype == otBallistic)
137         CalculateMach();
138
139     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
140     ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
141 }
142
143 void FGAIBase::Transform() {
144
145     if (!invisible) {
146         aip.setVisible(true);
147         aip.setPosition(pos);
148
149         if (no_roll)
150             aip.setOrientation(0.0, pitch, hdg);
151         else
152             aip.setOrientation(roll, pitch, hdg);
153
154         aip.update();
155     } else {
156         aip.setVisible(false);
157         aip.update();
158     }
159
160 }
161
162 bool FGAIBase::init(bool search_in_AI_path) {
163     osg::ref_ptr<osgDB::ReaderWriter::Options> opt=
164         new osgDB::ReaderWriter::Options(*osgDB::Registry::instance()->getOptions());
165
166     if(search_in_AI_path)
167     {
168         SGPath ai_path(globals->get_fg_root());
169         ai_path.append("AI");
170         opt->getDatabasePathList().push_front(ai_path.str());
171     }
172
173     string f = osgDB::findDataFile(model_path, opt.get());
174
175     if(f.empty())
176         f = fgGetString("/sim/multiplay/default-model", default_model);
177
178     model = load3DModel(f, props);
179
180     if (model.valid() && _initialized == false) {
181         model->setNodeMask(model->getNodeMask() & ~SG_NODEMASK_TERRAIN_BIT);
182         aip.init( model.get() );
183         aip.setVisible(true);
184         invisible = false;
185         globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
186         _initialized = true;
187
188     } else if (!model_path.empty()) {
189         SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
190     }
191
192     setDie(false);
193     return true;
194 }
195
196 void FGAIBase::initModel(osg::Node *node)
197 {
198     if (model.valid()) {
199         fgSetString("/ai/models/model-added", props->getPath());
200
201     } else if (!model_path.empty()) {
202         SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
203     }
204
205     props->setStringValue("submodels/path", _path.c_str());
206     setDie(false);
207 }
208
209
210 osg::Node* FGAIBase::load3DModel(const string &path, SGPropertyNode *prop_root)
211 {
212   model = SGModelLib::loadPagedModel(path, prop_root, new FGAIModelData(this, prop_root));
213   return model.get();
214 }
215
216 bool FGAIBase::isa( object_type otype ) {
217     return otype == _otype;
218 }
219
220
221 void FGAIBase::bind() {
222     props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
223         &FGAIBase::getID));
224     props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
225     props->tie("velocities/vertical-speed-fps",
226         SGRawValueMethods<FGAIBase,double>(*this,
227         &FGAIBase::_getVS_fps,
228         &FGAIBase::_setVS_fps));
229
230     props->tie("position/altitude-ft",
231         SGRawValueMethods<FGAIBase,double>(*this,
232         &FGAIBase::_getAltitude,
233         &FGAIBase::_setAltitude));
234     props->tie("position/latitude-deg",
235         SGRawValueMethods<FGAIBase,double>(*this,
236         &FGAIBase::_getLatitude,
237         &FGAIBase::_setLatitude));
238     props->tie("position/longitude-deg",
239         SGRawValueMethods<FGAIBase,double>(*this,
240         &FGAIBase::_getLongitude,
241         &FGAIBase::_setLongitude));
242
243     props->tie("position/global-x",
244         SGRawValueMethods<FGAIBase,double>(*this,
245         &FGAIBase::_getCartPosX,
246         0));
247     props->tie("position/global-y",
248         SGRawValueMethods<FGAIBase,double>(*this,
249         &FGAIBase::_getCartPosY,
250         0));
251     props->tie("position/global-z",
252         SGRawValueMethods<FGAIBase,double>(*this,
253         &FGAIBase::_getCartPosZ,
254         0));
255     props->tie("callsign",
256         SGRawValueMethods<FGAIBase,const char*>(*this,
257         &FGAIBase::_getCallsign,
258         0));
259
260     props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
261     props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
262     props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
263
264     props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
265     props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
266     props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
267     props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
268     props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
269     props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
270     props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
271     props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
272     props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
273     props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
274     props->tie("subID", SGRawValuePointer<int>(&_subID));
275     props->tie("controls/lighting/nav-lights",
276         SGRawValueFunctions<bool>(_isNight));
277     props->setBoolValue("controls/lighting/beacon", true);
278     props->setBoolValue("controls/lighting/strobe", true);
279     props->setBoolValue("controls/glide-path", true);
280
281     props->setStringValue("controls/flight/lateral-mode", "roll");
282     props->setDoubleValue("controls/flight/target-hdg", hdg);
283     props->setDoubleValue("controls/flight/target-roll", roll);
284
285     props->setStringValue("controls/flight/longitude-mode", "alt");
286     props->setDoubleValue("controls/flight/target-alt", altitude_ft);
287     props->setDoubleValue("controls/flight/target-pitch", pitch);
288
289    props->setDoubleValue("controls/flight/target-spd", speed);
290
291 }
292
293 void FGAIBase::unbind() {
294     props->untie("id");
295     props->untie("velocities/true-airspeed-kt");
296     props->untie("velocities/vertical-speed-fps");
297
298     props->untie("position/altitude-ft");
299     props->untie("position/latitude-deg");
300     props->untie("position/longitude-deg");
301     props->untie("position/global-x");
302     props->untie("position/global-y");
303     props->untie("position/global-z");
304     props->untie("callsign");
305
306     props->untie("orientation/pitch-deg");
307     props->untie("orientation/roll-deg");
308     props->untie("orientation/true-heading-deg");
309
310     props->untie("radar/in-range");
311     props->untie("radar/bearing-deg");
312     props->untie("radar/elevation-deg");
313     props->untie("radar/range-nm");
314     props->untie("radar/h-offset");
315     props->untie("radar/v-offset");
316     props->untie("radar/x-shift");
317     props->untie("radar/y-shift");
318     props->untie("radar/rotation");
319     props->untie("radar/ht-diff-ft");
320
321     props->untie("controls/lighting/nav-lights");
322 }
323
324 double FGAIBase::UpdateRadar(FGAIManager* manager) {
325     double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
326     bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
327     radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
328     radar_range_ft2 *= radar_range_ft2;
329
330     double user_latitude  = manager->get_user_latitude();
331     double user_longitude = manager->get_user_longitude();
332     double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
333     double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
334     double range_ft2 = lat_range*lat_range + lon_range*lon_range;
335
336     //
337     // Test whether the target is within radar range.
338     //
339     in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
340
341     if ( in_range || force_on ) {
342         props->setBoolValue("radar/in-range", true);
343
344         // copy values from the AIManager
345         double user_altitude  = manager->get_user_altitude();
346         double user_heading   = manager->get_user_heading();
347         double user_pitch     = manager->get_user_pitch();
348         //double user_yaw       = manager->get_user_yaw();
349         //double user_speed     = manager->get_user_speed();
350
351         // calculate range to target in feet and nautical miles
352         double range_ft = sqrt( range_ft2 );
353         range = range_ft / 6076.11549;
354
355         // calculate bearing to target
356         if (pos.getLatitudeDeg() >= user_latitude) {
357             bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
358             if (pos.getLongitudeDeg() >= user_longitude) {
359                 bearing = 90.0 - bearing;
360             } else {
361                 bearing = 270.0 + bearing;
362             }
363         } else {
364             bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
365             if (pos.getLongitudeDeg() >= user_longitude) {
366                 bearing = 180.0 - bearing;
367             } else {
368                 bearing = 180.0 + bearing;
369             }
370         }
371
372         // This is an alternate way to compute bearing and distance which
373         // agrees with the original scheme within about 0.1 degrees.
374         //
375         // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
376         //                user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
377         // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
378         // double gc_bearing, gc_range;
379         // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
380         // gc_range *= SG_METER_TO_NM;
381         // gc_bearing *= SGD_RADIANS_TO_DEGREES;
382         // printf("orig b = %.3f %.2f  gc b= %.3f, %.2f\n",
383         //        bearing, range, gc_bearing, gc_range);
384
385         // calculate look left/right to target, without yaw correction
386         horiz_offset = bearing - user_heading;
387         if (horiz_offset > 180.0) horiz_offset -= 360.0;
388         if (horiz_offset < -180.0) horiz_offset += 360.0;
389
390         // calculate elevation to target
391         elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
392
393         // calculate look up/down to target
394         vert_offset = elevation - user_pitch;
395
396         /* this calculation needs to be fixed, but it isn't important anyway
397         // calculate range rate
398         double recip_bearing = bearing + 180.0;
399         if (recip_bearing > 360.0) recip_bearing -= 360.0;
400         double my_horiz_offset = recip_bearing - hdg;
401         if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
402         if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
403         rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
404         +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
405         */
406
407         // now correct look left/right for yaw
408         // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
409
410         // calculate values for radar display
411         y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
412         x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
413         rotation = hdg - user_heading;
414         if (rotation < 0.0) rotation += 360.0;
415         ht_diff = altitude_ft - user_altitude;
416
417     }
418
419     return range_ft2;
420 }
421
422 /*
423 * Getters and Setters
424 */
425
426 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
427     // Transform that one to the horizontal local coordinate system.
428     SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
429
430     // and postrotate the orientation of the AIModel wrt the horizontal
431     // local frame
432     hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
433
434     // The offset converted to the usual body fixed coordinate system
435     // rotated to the earth fiexed coordinates axis
436     SGVec3d off = hlTrans.backTransform(_off);
437
438     // Add the position offset of the AIModel to gain the earth centered position
439     SGVec3d cartPos = SGVec3d::fromGeod(pos);
440
441     return cartPos + off;
442 }
443
444 SGVec3d FGAIBase::getCartPos() const {
445     SGVec3d cartPos = SGVec3d::fromGeod(pos);
446     return cartPos;
447 }
448
449 double FGAIBase::_getCartPosX() const {
450     SGVec3d cartPos = getCartPos();
451     return cartPos.x();
452 }
453
454 double FGAIBase::_getCartPosY() const {
455     SGVec3d cartPos = getCartPos();
456     return cartPos.y();
457 }
458
459 double FGAIBase::_getCartPosZ() const {
460     SGVec3d cartPos = getCartPos();
461     return cartPos.z();
462 }
463
464 void FGAIBase::_setLongitude( double longitude ) {
465     pos.setLongitudeDeg(longitude);
466 }
467
468 void FGAIBase::_setLatitude ( double latitude )  {
469     pos.setLatitudeDeg(latitude);
470 }
471
472 void FGAIBase::_setUserPos(){
473     userpos.setLatitudeDeg(manager->get_user_latitude());
474     userpos.setLongitudeDeg(manager->get_user_longitude());
475     userpos.setElevationM(manager->get_user_altitude() * SG_FEET_TO_METER);
476 }
477
478 void FGAIBase::_setSubID( int s ) {
479     _subID = s;
480 }
481
482 double FGAIBase::_getLongitude() const {
483     return pos.getLongitudeDeg();
484 }
485
486 double FGAIBase::_getLatitude() const {
487     return pos.getLatitudeDeg();
488 }
489
490 double FGAIBase::_getElevationFt () const {
491     return pos.getElevationFt();
492 }
493
494 double FGAIBase::_getRdot() const {
495     return rdot;
496 }
497
498 double FGAIBase::_getVS_fps() const {
499     return vs*60.0;
500 }
501
502 double FGAIBase::_get_speed_east_fps() const {
503     return speed_east_deg_sec * ft_per_deg_lon;
504 }
505
506 double FGAIBase::_get_speed_north_fps() const {
507     return speed_north_deg_sec * ft_per_deg_lat;
508 }
509
510 void FGAIBase::_setVS_fps( double _vs ) {
511     vs = _vs/60.0;
512 }
513
514 double FGAIBase::_getAltitude() const {
515     return altitude_ft;
516 }
517
518 bool FGAIBase::_getServiceable() const {
519     return serviceable;
520 }
521
522 SGPropertyNode* FGAIBase::_getProps() const {
523     return props;
524 }
525
526 void FGAIBase::_setAltitude( double _alt ) {
527     setAltitude( _alt );
528 }
529
530 bool FGAIBase::_isNight() {
531     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
532 }
533
534 bool FGAIBase::_getCollisionData() {
535     return _collision_reported;
536 }
537
538 bool FGAIBase::_getImpactData() {
539     return _impact_reported;
540 }
541
542 double FGAIBase::_getImpactLat() const {
543     return _impact_lat;
544 }
545
546 double FGAIBase::_getImpactLon() const {
547     return _impact_lon;
548 }
549
550 double FGAIBase::_getImpactElevFt() const {
551     return _impact_elev * SG_METER_TO_FEET;
552 }
553
554 double FGAIBase::_getImpactPitch() const {
555     return _impact_pitch;
556 }
557
558 double FGAIBase::_getImpactRoll() const {
559     return _impact_roll;
560 }
561
562 double FGAIBase::_getImpactHdg() const {
563     return _impact_hdg;
564 }
565
566 double FGAIBase::_getImpactSpeed() const {
567     return _impact_speed;
568 }
569
570 int FGAIBase::getID() const {
571     return  _refID;
572 }
573
574 int FGAIBase::_getSubID() const {
575     return  _subID;
576 }
577
578 double FGAIBase::_getSpeed() const {
579     return speed;
580 }
581
582 double FGAIBase::_getRoll() const {
583     return roll;
584 }
585
586 double FGAIBase::_getPitch() const {
587     return pitch;
588 }
589
590 double FGAIBase::_getHeading() const {
591     return hdg;
592 }
593
594 double  FGAIBase::_getXOffset() const {
595     return _x_offset;
596 }
597
598 double  FGAIBase::_getYOffset() const {
599     return _y_offset;
600 }
601
602 double  FGAIBase::_getZOffset() const {
603     return _z_offset;
604 }
605
606 const char* FGAIBase::_getPath() const {
607     return model_path.c_str();
608 }
609
610 const char* FGAIBase::_getSMPath() const {
611     return _path.c_str();
612 }
613
614 const char* FGAIBase::_getName() const {
615     return _name.c_str();
616 }
617
618 const char* FGAIBase::_getCallsign() const {
619     return _callsign.c_str();
620 }
621
622 const char* FGAIBase::_getSubmodel() const {
623     return _submodel.c_str();
624 }
625
626 void FGAIBase::CalculateMach() {
627     // Calculate rho at altitude, using standard atmosphere
628     // For the temperature T and the pressure p,
629     double altitude = altitude_ft;
630
631     if (altitude < 36152) {             // curve fits for the troposphere
632         T = 59 - 0.00356 * altitude;
633         p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
634     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
635         T = -70;
636         p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
637     } else {                                    //  upper stratosphere
638         T = -205.05 + (0.00164 * altitude);
639         p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
640     }
641
642     rho = p / (1718 * (T + 459.7));
643
644     // calculate the speed of sound at altitude
645     // a = sqrt ( g * R * (T + 459.7))
646     // where:
647     // a = speed of sound [ft/s]
648     // g = specific heat ratio, which is usually equal to 1.4
649     // R = specific gas constant, which equals 1716 ft-lb/slug/R
650     a = sqrt ( 1.4 * 1716 * (T + 459.7));
651
652     // calculate Mach number
653     Mach = speed/a;
654
655     // cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
656 }
657
658 int FGAIBase::_newAIModelID() {
659     static int id = 0;
660
661     if (!++id)
662         id++;   // id = 0 is not allowed.
663
664     return id;
665 }
666