]> git.mxchange.org Git - flightgear.git/blob - src/AIModel/AIBase.cxx
commradio: improvements for atis speech
[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 <string.h>
28
29 #include <simgear/compiler.h>
30
31 #include <boost/foreach.hpp>
32 #include <string>
33
34 #include <osg/ref_ptr>
35 #include <osg/Node>
36 #include <osgDB/FileUtils>
37
38 #include <simgear/misc/sg_path.hxx>
39 #include <simgear/scene/model/modellib.hxx>
40 #include <simgear/scene/util/SGNodeMasks.hxx>
41 #include <simgear/debug/logstream.hxx>
42 #include <simgear/props/props.hxx>
43
44 #include <Main/globals.hxx>
45 #include <Scenery/scenery.hxx>
46 #include <Scripting/NasalSys.hxx>
47 #include <Scripting/NasalModelData.hxx>
48 #include <Sound/fg_fx.hxx>
49
50 #include "AIBase.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 std::string;
58 using namespace simgear;
59
60 class FGAIModelData : public simgear::SGModelData {
61 public:
62     FGAIModelData(SGPropertyNode *root = NULL)
63         : _nasal( new FGNasalModelDataProxy(root) ),
64         _ready(false),
65         _initialized(false)
66     {
67     }
68
69     
70     ~FGAIModelData()
71     {
72     }
73     
74     virtual FGAIModelData* clone() const { return new FGAIModelData(); }
75
76     /** osg callback, thread-safe */
77     void modelLoaded(const std::string& path, SGPropertyNode *prop, osg::Node *n)
78     {
79         // WARNING: Called in a separate OSG thread! Only use thread-safe stuff here...
80         if (_ready)
81             return;
82         
83         _fxpath = prop->getStringValue("sound/path");
84         _nasal->modelLoaded(path, prop, n);
85         
86         _ready = true;
87
88     }
89     
90     /** init hook to be called after model is loaded.
91      * Not thread-safe. Call from main thread only. */
92     void init(void) { _initialized = true; }
93     
94     bool needInitilization(void) { return _ready && !_initialized;}
95     bool isInitialized(void) { return _initialized;}
96     inline std::string& get_sound_path() { return _fxpath;}
97     
98 private:
99     std::auto_ptr<FGNasalModelDataProxy> _nasal;
100     std::string _fxpath;
101     bool _ready;
102     bool _initialized;
103 };
104
105 FGAIBase::FGAIBase(object_type ot, bool enableHot) :
106     _max_speed(300),
107     _name(""),
108     _parent(""),
109     props( NULL ),
110     model_removed( fgGetNode("/ai/models/model-removed", true) ),
111     manager( NULL ),
112     _installed(false),
113     fp( NULL ),
114     _impact_lat(0),
115     _impact_lon(0),
116     _impact_elev(0),
117     _impact_hdg(0),
118     _impact_pitch(0),
119     _impact_roll(0),
120     _impact_speed(0),
121     _refID( _newAIModelID() ),
122     _otype(ot),
123     _initialized(false),
124     _modeldata(0),
125     _fx(0)
126 {
127     tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
128     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
129     bearing = elevation = range = rdot = 0.0;
130     x_shift = y_shift = rotation = 0.0;
131     in_range = false;
132     invisible = false;
133     no_roll = true;
134     life = 900;
135     delete_me = false;
136     _impact_reported = false;
137     _collision_reported = false;
138     _expiry_reported = false;
139
140     _subID = 0;
141
142     _x_offset = 0;
143     _y_offset = 0;
144     _z_offset = 0;
145
146     _pitch_offset = 0;
147     _roll_offset = 0;
148     _yaw_offset = 0;
149
150     pos = SGGeod::fromDeg(0, 0);
151     speed = 0;
152     altitude_ft = 0;
153     speed_north_deg_sec = 0;
154     speed_east_deg_sec = 0;
155     turn_radius_ft = 0;
156
157     ft_per_deg_lon = 0;
158     ft_per_deg_lat = 0;
159
160     horiz_offset = 0;
161     vert_offset = 0;
162     ht_diff = 0;
163
164     serviceable = false;
165
166     fp = 0;
167
168     rho = 1;
169     T = 280;
170     p = 1e5;
171     a = 340;
172     Mach = 0;
173
174     // explicitly disable HOT for (most) AI models
175     if (!enableHot)
176         aip.getSceneGraph()->setNodeMask(~SG_NODEMASK_TERRAIN_BIT);
177 }
178
179 FGAIBase::~FGAIBase() {
180     // Unregister that one at the scenery manager
181     removeModel();
182
183     if (props) {
184         SGPropertyNode* parent = props->getParent();
185
186         if (parent)
187             model_removed->setStringValue(props->getPath());
188     }
189
190     removeSoundFx();
191
192     if (fp)
193         delete fp;
194     fp = 0;
195 }
196
197 /** Cleanly remove the model
198  * and let the scenery database pager do the clean-up work.
199  */
200 void
201 FGAIBase::removeModel()
202 {
203     if (!_model.valid())
204         return;
205
206     FGScenery* pSceneryManager = globals->get_scenery();
207     if (pSceneryManager)
208     {
209         osg::ref_ptr<osg::Object> temp = _model.get();
210         pSceneryManager->get_models_branch()->removeChild(aip.getSceneGraph());
211         // withdraw from SGModelPlacement and drop own reference (unref)
212         aip.clear();
213         _modeldata = 0;
214         _model = 0;
215         
216         // pass it on to the pager, to be be deleted in the pager thread
217         pSceneryManager->getPager()->queueDeleteRequest(temp);
218     }
219     else
220     {
221         SG_LOG(SG_AI, SG_ALERT, "AIBase: Could not unload model. Missing scenery manager!");
222     }
223 }
224
225 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
226 {
227     if (!scFileNode)
228         return;
229
230     setPath(scFileNode->getStringValue("model",
231             fgGetString("/sim/multiplay/default-model", default_model)));
232
233     setHeading(scFileNode->getDoubleValue("heading", 0.0));
234     setSpeed(scFileNode->getDoubleValue("speed", 0.0));
235     setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
236     setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
237     setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
238     setBank(scFileNode->getDoubleValue("roll", 0.0));
239
240     SGPropertyNode* submodels = scFileNode->getChild("submodels");
241
242     if (submodels) {
243         setServiceable(submodels->getBoolValue("serviceable", false));
244         setSMPath(submodels->getStringValue("path", ""));
245     }
246
247 }
248
249 void FGAIBase::update(double dt) {
250
251     if (_otype == otStatic)
252         return;
253
254     if (_otype == otBallistic)
255         CalculateMach();
256
257     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
258     ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
259
260     if ( _fx )
261     {
262         // update model's audio sample values
263         _fx->set_position_geod( pos );
264
265         SGQuatd orient = SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
266         _fx->set_orientation( orient );
267
268         SGVec3d velocity;
269         velocity = SGVec3d( speed_north_deg_sec, speed_east_deg_sec,
270                             pitch*speed );
271         _fx->set_velocity( velocity );
272     }
273     else if ((_modeldata)&&(_modeldata->needInitilization()))
274     {
275         // process deferred nasal initialization,
276         // which must be done in main thread
277         _modeldata->init();
278
279         // sound initialization
280         if (fgGetBool("/sim/sound/aimodels/enabled",false))
281         {
282             const string& fxpath = _modeldata->get_sound_path();
283             if (fxpath != "")
284             {
285                 props->setStringValue("sim/sound/path", fxpath.c_str());
286
287                 // initialize the sound configuration
288                 std::stringstream name;
289                 name <<  "aifx:";
290                 name << _refID;
291                 _fx = new FGFX(name.str(), props);
292                 _fx->init();
293             }
294         }
295     }
296 }
297
298 /** update LOD properties of the model */
299 void FGAIBase::updateLOD()
300 {
301     double maxRangeDetail = fgGetDouble("/sim/rendering/static-lod/ai-detailed", 10000.0);
302     double maxRangeBare   = fgGetDouble("/sim/rendering/static-lod/ai-bare", 20000.0);
303     if (_model.valid())
304     {
305         if( maxRangeDetail == 0.0 )
306         {
307             // disable LOD
308             _model->setRange(0, 0.0,     FLT_MAX);
309             _model->setRange(1, FLT_MAX, FLT_MAX);
310         }
311         else
312         {
313             _model->setRange(0, 0.0, maxRangeDetail);
314             _model->setRange(1, maxRangeDetail,maxRangeBare);
315         }
316     }
317 }
318
319 void FGAIBase::Transform() {
320
321     if (!invisible) {
322         aip.setVisible(true);
323         aip.setPosition(pos);
324
325         if (no_roll)
326             aip.setOrientation(0.0, pitch, hdg);
327         else
328             aip.setOrientation(roll, pitch, hdg);
329
330         aip.update();
331     } else {
332         aip.setVisible(false);
333         aip.update();
334     }
335
336 }
337
338 bool FGAIBase::init(bool search_in_AI_path)
339 {
340     if (_model.valid())
341     {
342         SG_LOG(SG_AI, SG_ALERT, "AIBase: Cannot initialize a model multiple times! " << model_path);
343         return false;
344     }
345
346     string f;
347     if(search_in_AI_path)
348     {
349         BOOST_FOREACH(SGPath p, globals->get_data_paths("AI")) {
350             p.append(model_path);
351             if (p.exists()) {
352                 f = p.str();
353                 break;
354             }
355         } // of AI data paths iteration
356     } // of search in AI path
357
358     if (f.empty()) {
359         f = simgear::SGModelLib::findDataFile(model_path);
360     }
361     
362     if(f.empty())
363         f = fgGetString("/sim/multiplay/default-model", default_model);
364     else
365         _installed = true;
366
367     _modeldata = new FGAIModelData(props);
368     _model= SGModelLib::loadPagedModel(f, props, _modeldata);
369
370     _model->setName("AI-model range animation node");
371
372   //  _model->setCenterMode(osg::LOD::USE_BOUNDING_SPHERE_CENTER);
373   //  _model->setRangeMode(osg::LOD::DISTANCE_FROM_EYE_POINT);
374   
375 //    We really need low-resolution versions of AI/MP aircraft.
376 //    Or at least dummy "stubs" with some default silhouette.
377 //        _model->addChild( SGModelLib::loadPagedModel(fgGetString("/sim/multiplay/default-model", default_model),
378 //                                                    props, new FGNasalModelData(props)), FLT_MAX, FLT_MAX);
379     updateLOD();
380     initModel();
381   
382     if (_model.valid() && _initialized == false) {
383         aip.init( _model.get() );
384         aip.setVisible(true);
385         invisible = false;
386         globals->get_scenery()->get_models_branch()->addChild(aip.getSceneGraph());
387         _initialized = true;
388
389         SG_LOG(SG_AI, SG_DEBUG, "AIBase: Loaded model " << model_path);
390
391     } else if (!model_path.empty()) {
392         SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path);
393         // not properly installed...
394         _installed = false;
395     }
396
397     setDie(false);
398     return true;
399 }
400
401 void FGAIBase::initModel()
402 {
403     if (_model.valid()) { 
404
405         if( _path != ""){
406             props->setStringValue("submodels/path", _path.c_str());
407             SG_LOG(SG_AI, SG_DEBUG, "AIBase: submodels/path " << _path);
408         }
409
410         if( _parent!= ""){
411             props->setStringValue("parent-name", _parent.c_str());
412         }
413
414         fgSetString("/ai/models/model-added", props->getPath().c_str());
415     } else if (!model_path.empty()) {
416         SG_LOG(SG_AI, SG_WARN, "AIBase: Could not load model " << model_path);
417     }
418
419     setDie(false);
420 }
421
422
423 bool FGAIBase::isa( object_type otype ) {
424     return otype == _otype;
425 }
426
427
428 void FGAIBase::bind() {
429     _tiedProperties.setRoot(props);
430     tie("id", SGRawValueMethods<FGAIBase,int>(*this,
431         &FGAIBase::getID));
432     tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
433     tie("velocities/vertical-speed-fps",
434         SGRawValueMethods<FGAIBase,double>(*this,
435         &FGAIBase::_getVS_fps,
436         &FGAIBase::_setVS_fps));
437
438     tie("position/altitude-ft",
439         SGRawValueMethods<FGAIBase,double>(*this,
440         &FGAIBase::_getAltitude,
441         &FGAIBase::_setAltitude));
442     tie("position/latitude-deg",
443         SGRawValueMethods<FGAIBase,double>(*this,
444         &FGAIBase::_getLatitude,
445         &FGAIBase::_setLatitude));
446     tie("position/longitude-deg",
447         SGRawValueMethods<FGAIBase,double>(*this,
448         &FGAIBase::_getLongitude,
449         &FGAIBase::_setLongitude));
450
451     tie("position/global-x",
452         SGRawValueMethods<FGAIBase,double>(*this,
453         &FGAIBase::_getCartPosX,
454         0));
455     tie("position/global-y",
456         SGRawValueMethods<FGAIBase,double>(*this,
457         &FGAIBase::_getCartPosY,
458         0));
459     tie("position/global-z",
460         SGRawValueMethods<FGAIBase,double>(*this,
461         &FGAIBase::_getCartPosZ,
462         0));
463     tie("callsign",
464         SGRawValueMethods<FGAIBase,const char*>(*this,
465         &FGAIBase::_getCallsign,
466         0));
467
468     tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
469     tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
470     tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
471
472     tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
473     tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
474     tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
475     tie("radar/range-nm", SGRawValuePointer<double>(&range));
476     tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
477     tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
478     tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
479     tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
480     tie("radar/rotation", SGRawValuePointer<double>(&rotation));
481     tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
482     tie("subID", SGRawValuePointer<int>(&_subID));
483     tie("controls/lighting/nav-lights", SGRawValueFunctions<bool>(_isNight));
484
485     props->setBoolValue("controls/lighting/beacon", true);
486     props->setBoolValue("controls/lighting/strobe", true);
487     props->setBoolValue("controls/glide-path", true);
488
489     props->setStringValue("controls/flight/lateral-mode", "roll");
490     props->setDoubleValue("controls/flight/target-hdg", hdg);
491     props->setDoubleValue("controls/flight/target-roll", roll);
492
493     props->setStringValue("controls/flight/longitude-mode", "alt");
494     props->setDoubleValue("controls/flight/target-alt", altitude_ft);
495     props->setDoubleValue("controls/flight/target-pitch", pitch);
496
497     props->setDoubleValue("controls/flight/target-spd", speed);
498
499     props->setBoolValue("sim/sound/avionics/enabled", false);
500     props->setDoubleValue("sim/sound/avionics/volume", 0.0);
501     props->setBoolValue("sim/sound/avionics/external-view", false);
502     props->setBoolValue("sim/current-view/internal", false);
503 }
504
505 void FGAIBase::unbind() {
506     _tiedProperties.Untie();
507
508     props->setBoolValue("/sim/controls/radar", true);
509
510     removeSoundFx();
511 }
512
513 void FGAIBase::removeSoundFx() {
514     // drop reference to sound effects now
515     if (_fx)
516     {
517         // must remove explicitly - since the sound manager also keeps a reference
518         _fx->unbind();
519         // now drop last reference - kill the object
520         _fx = 0;
521     }
522 }
523
524 double FGAIBase::UpdateRadar(FGAIManager* manager)
525 {
526     bool control = fgGetBool("/sim/controls/radar", true);
527
528     if(!control) return 0;
529
530     double radar_range_m = fgGetDouble("/instrumentation/radar/range");
531     bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
532     radar_range_m *= SG_NM_TO_METER  * 1.1; // + 10%
533     radar_range_m *= radar_range_m; // squared
534     
535     double d2 = distSqr(SGVec3d::fromGeod(pos), globals->get_aircraft_position_cart());
536     double range_ft = sqrt(d2) * SG_METER_TO_FEET;
537     
538     if (!force_on && (d2 > radar_range_m)) {
539         return range_ft * range_ft;
540     }
541     
542     props->setBoolValue("radar/in-range", true);
543
544     // copy values from the AIManager
545     double user_heading   = manager->get_user_heading();
546     double user_pitch     = manager->get_user_pitch();
547   
548     range = range_ft * SG_FEET_TO_METER * SG_METER_TO_NM;
549
550     // calculate bearing to target
551     bearing = SGGeodesy::courseDeg(globals->get_aircraft_position(), pos);
552
553     // calculate look left/right to target, without yaw correction
554     horiz_offset = bearing - user_heading;
555     SG_NORMALIZE_RANGE(horiz_offset, -180.0, 180.0);
556    
557     // calculate elevation to target
558     ht_diff = altitude_ft - globals->get_aircraft_position().getElevationFt();
559     elevation = atan2( ht_diff, range_ft ) * SG_RADIANS_TO_DEGREES;
560
561     // calculate look up/down to target
562     vert_offset = elevation - user_pitch;
563
564     /* this calculation needs to be fixed, but it isn't important anyway
565     // calculate range rate
566     double recip_bearing = bearing + 180.0;
567     if (recip_bearing > 360.0) recip_bearing -= 360.0;
568     double my_horiz_offset = recip_bearing - hdg;
569     if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
570     if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
571     rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
572     +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
573     */
574
575     // now correct look left/right for yaw
576     // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
577
578     // calculate values for radar display
579     y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
580     x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
581     
582     rotation = hdg - user_heading;
583     SG_NORMALIZE_RANGE(rotation, 0.0, 360.0);
584
585     return range_ft * range_ft;
586 }
587
588 /*
589 * Getters and Setters
590 */
591
592 SGVec3d FGAIBase::getCartPosAt(const SGVec3d& _off) const {
593     // Transform that one to the horizontal local coordinate system.
594     SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
595
596     // and postrotate the orientation of the AIModel wrt the horizontal
597     // local frame
598     hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
599
600     // The offset converted to the usual body fixed coordinate system
601     // rotated to the earth fixed coordinates axis
602     SGVec3d off = hlTrans.backTransform(_off);
603
604     // Add the position offset of the AIModel to gain the earth centered position
605     SGVec3d cartPos = SGVec3d::fromGeod(pos);
606
607     return cartPos + off;
608 }
609
610 SGVec3d FGAIBase::getCartPos() const {
611     SGVec3d cartPos = SGVec3d::fromGeod(pos);
612     return cartPos;
613 }
614
615 bool FGAIBase::getGroundElevationM(const SGGeod& pos, double& elev,
616                                    const simgear::BVHMaterial** material) const {
617     return globals->get_scenery()->get_elevation_m(pos, elev, material,
618                                                    _model.get());
619 }
620
621 double FGAIBase::_getCartPosX() const {
622     SGVec3d cartPos = getCartPos();
623     return cartPos.x();
624 }
625
626 double FGAIBase::_getCartPosY() const {
627     SGVec3d cartPos = getCartPos();
628     return cartPos.y();
629 }
630
631 double FGAIBase::_getCartPosZ() const {
632     SGVec3d cartPos = getCartPos();
633     return cartPos.z();
634 }
635
636 void FGAIBase::_setLongitude( double longitude ) {
637     pos.setLongitudeDeg(longitude);
638 }
639
640 void FGAIBase::_setLatitude ( double latitude )  {
641     pos.setLatitudeDeg(latitude);
642 }
643
644 void FGAIBase::_setSubID( int s ) {
645     _subID = s;
646 }
647
648 bool FGAIBase::setParentNode() {
649
650     if (_parent == ""){
651        SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name
652             << " parent not set ");
653        return false;
654     }
655
656     const SGPropertyNode_ptr ai = fgGetNode("/ai/models", true);
657
658     for (int i = ai->nChildren() - 1; i >= -1; i--) {
659         SGPropertyNode_ptr model;
660
661         if (i < 0) { // last iteration: selected model
662             model = _selected_ac;
663         } else {
664             model = ai->getChild(i);
665             //const string& path = ai->getPath();
666             const string name = model->getStringValue("name");
667
668             if (!model->nChildren()){
669                 continue;
670             }
671             if (name == _parent) {
672                 _selected_ac = model;  // save selected model for last iteration
673                 break;
674             }
675
676         }
677         if (!model)
678             continue;
679
680     }// end for loop
681
682     if (_selected_ac != 0){
683         const string name = _selected_ac->getStringValue("name");
684         return true;
685     } else {
686         SG_LOG(SG_AI, SG_ALERT, "AIBase: " << _name
687             << " parent not found: dying ");
688         setDie(true);
689         return false;
690     }
691
692 }
693
694 double FGAIBase::_getLongitude() const {
695     return pos.getLongitudeDeg();
696 }
697
698 double FGAIBase::_getLatitude() const {
699     return pos.getLatitudeDeg();
700 }
701
702 double FGAIBase::_getElevationFt() const {
703     return pos.getElevationFt();
704 }
705
706 double FGAIBase::_getRdot() const {
707     return rdot;
708 }
709
710 double FGAIBase::_getVS_fps() const {
711     return vs/60.0;
712 }
713
714 double FGAIBase::_get_speed_east_fps() const {
715     return speed_east_deg_sec * ft_per_deg_lon;
716 }
717
718 double FGAIBase::_get_speed_north_fps() const {
719     return speed_north_deg_sec * ft_per_deg_lat;
720 }
721
722 void FGAIBase::_setVS_fps( double _vs ) {
723     vs = _vs*60.0;
724 }
725
726 double FGAIBase::_getAltitude() const {
727     return altitude_ft;
728 }
729
730 double FGAIBase::_getAltitudeAGL(SGGeod inpos, double start){
731     getGroundElevationM(SGGeod::fromGeodM(inpos, start),
732         _elevation_m, NULL);
733     return inpos.getElevationFt() - _elevation_m * SG_METER_TO_FEET;
734 }
735
736 bool FGAIBase::_getServiceable() const {
737     return serviceable;
738 }
739
740 SGPropertyNode* FGAIBase::_getProps() const {
741     return props;
742 }
743
744 void FGAIBase::_setAltitude( double _alt ) {
745     setAltitude( _alt );
746 }
747
748 bool FGAIBase::_isNight() {
749     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
750 }
751
752 bool FGAIBase::_getCollisionData() {
753     return _collision_reported;
754 }
755
756 bool FGAIBase::_getExpiryData() {
757     return _expiry_reported;
758 }
759
760 bool FGAIBase::_getImpactData() {
761     return _impact_reported;
762 }
763
764 double FGAIBase::_getImpactLat() const {
765     return _impact_lat;
766 }
767
768 double FGAIBase::_getImpactLon() const {
769     return _impact_lon;
770 }
771
772 double FGAIBase::_getImpactElevFt() const {
773     return _impact_elev * SG_METER_TO_FEET;
774 }
775
776 double FGAIBase::_getImpactPitch() const {
777     return _impact_pitch;
778 }
779
780 double FGAIBase::_getImpactRoll() const {
781     return _impact_roll;
782 }
783
784 double FGAIBase::_getImpactHdg() const {
785     return _impact_hdg;
786 }
787
788 double FGAIBase::_getImpactSpeed() const {
789     return _impact_speed;
790 }
791
792 int FGAIBase::getID() const {
793     return  _refID;
794 }
795
796 int FGAIBase::_getSubID() const {
797     return  _subID;
798 }
799
800 double FGAIBase::_getSpeed() const {
801     return speed;
802 }
803
804 double FGAIBase::_getRoll() const {
805     return roll;
806 }
807
808 double FGAIBase::_getPitch() const {
809     return pitch;
810 }
811
812 double FGAIBase::_getHeading() const {
813     return hdg;
814 }
815
816 double  FGAIBase::_getXOffset() const {
817     return _x_offset;
818 }
819
820 double  FGAIBase::_getYOffset() const {
821     return _y_offset;
822 }
823
824 double  FGAIBase::_getZOffset() const {
825     return _z_offset;
826 }
827
828 const char* FGAIBase::_getPath() const {
829     return model_path.c_str();
830 }
831
832 const char* FGAIBase::_getSMPath() const {
833     return _path.c_str();
834 }
835
836 const char* FGAIBase::_getName() const {
837     return _name.c_str();
838 }
839
840 const char* FGAIBase::_getCallsign() const {
841     return _callsign.c_str();
842 }
843
844 const char* FGAIBase::_getSubmodel() const {
845     return _submodel.c_str();
846 }
847
848 void FGAIBase::CalculateMach() {
849     // Calculate rho at altitude, using standard atmosphere
850     // For the temperature T and the pressure p,
851     double altitude = altitude_ft;
852
853     if (altitude < 36152) {             // curve fits for the troposphere
854         T = 59 - 0.00356 * altitude;
855         p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
856     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
857         T = -70;
858         p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
859     } else {                                    //  upper stratosphere
860         T = -205.05 + (0.00164 * altitude);
861         p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
862     }
863
864     rho = p / (1718 * (T + 459.7));
865
866     // calculate the speed of sound at altitude
867     // a = sqrt ( g * R * (T + 459.7))
868     // where:
869     // a = speed of sound [ft/s]
870     // g = specific heat ratio, which is usually equal to 1.4
871     // R = specific gas constant, which equals 1716 ft-lb/slug/R
872     a = sqrt ( 1.4 * 1716 * (T + 459.7));
873
874     // calculate Mach number
875     Mach = speed/a;
876
877     // cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach << endl;
878 }
879
880 int FGAIBase::_newAIModelID() {
881     static int id = 0;
882
883     if (!++id)
884         id++;   // id = 0 is not allowed.
885
886     return id;
887 }
888
889
890