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