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