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 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License as
   8 // published by the Free Software Foundation; either version 2 of the
   9 // License, or (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <simgear/compiler.h>
  26
  27 #include STL_STRING
  28
  29 #include <osg/ref_ptr>
  30 #include <osg/Node>
  31
  32 #include <simgear/math/point3d.hxx>
  33 #include <simgear/math/polar3d.hxx>
  34 #include <simgear/math/sg_geodesy.hxx>
  35 #include <simgear/misc/sg_path.hxx>
  36 #include <simgear/scene/model/location.hxx>
  37 #include <simgear/scene/model/model.hxx>
  38 #include <simgear/debug/logstream.hxx>
  39 #include <simgear/props/props.hxx>
  40
  41 #include <Main/globals.hxx>
  42 #include <Scenery/scenery.hxx>
  43
  44
  45 #include "AIBase.hxx"
  46 #include "AIManager.hxx"
  47
  48
  49 const double FGAIBase::e = 2.71828183;
  50 const double FGAIBase::lbs_to_slugs = 0.031080950172;   //conversion factor
  51
  52
  53 FGAIBase::FGAIBase(object_type ot) :
  54     props( NULL ),
  55     model_removed( fgGetNode("/ai/models/model-removed", true) ),
  56     manager( NULL ),
  57     fp( NULL ),
  58     _refID( _newAIModelID() ),
  59     _otype(ot)
  60 {
  61     tgt_heading = hdg = tgt_altitude_ft = tgt_speed = 0.0;
  62     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
  63     bearing = elevation = range = rdot = 0.0;
  64     x_shift = y_shift = rotation = 0.0;
  65     in_range = false;
  66     invisible = true;
  67     no_roll = true;
  68     life = 900;
  69     delete_me = false;
  70 }
  71
  72 FGAIBase::~FGAIBase() {
  73     // Unregister that one at the scenery manager
  74     if (globals->get_scenery()) {
  75         globals->get_scenery()->unregister_placement_transform(aip.getTransform());
  76         globals->get_scenery()->get_scene_graph()->removeChild(aip.getSceneGraph());
  77     }
  78     if (props) {
  79         SGPropertyNode* parent = props->getParent();
  80         if (parent) {
  81             model_removed->setStringValue(props->getPath());
  82             parent->removeChild(props->getName(), props->getIndex(), false);
  83         }
  84     }
  85     delete fp;
  86     fp = 0;
  87 }
  88
  89
  90 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
  91 {
  92     if (!scFileNode)
  93         return;
  94
  95     setPath(scFileNode->getStringValue("model", "Models/Geometry/glider.ac"));
  96
  97     setHeading(scFileNode->getDoubleValue("heading", 0.0));
  98     setSpeed(scFileNode->getDoubleValue("speed", 0.0));
  99     setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
 100     setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
 101     setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
 102     setBank(scFileNode->getDoubleValue("roll", 0.0));
 103 }
 104
 105 void FGAIBase::update(double dt) {
 106     if (_otype == otStatic)
 107         return;
 108     if (_otype == otBallistic)
 109         CalculateMach();
 110
 111     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.getLatitudeRad());
 112     ft_per_deg_lon = 365228.16 * cos(pos.getLatitudeRad());
 113 }
 114
 115 void FGAIBase::Transform() {
 116     if (!invisible) {
 117       aip.setPosition(pos);
 118       if (no_roll) {
 119          aip.setOrientation(0.0, pitch, hdg);
 120       } else {
 121          aip.setOrientation(roll, pitch, hdg);
 122       }
 123       aip.update();
 124     }
 125 }
 126
 127
 128 bool FGAIBase::init() {
 129
 130    if (!model_path.empty()) {
 131      try {
 132        model = load3DModel( globals->get_fg_root(), model_path, props,
 133                             globals->get_sim_time_sec() );
 134      } catch (const sg_exception &e) {
 135        model = NULL;
 136      }
 137    }
 138    if (model.get()) {
 139      aip.init( model.get() );
 140      aip.setVisible(true);
 141      invisible = false;
 142      globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
 143      // Register that one at the scenery manager
 144      globals->get_scenery()->register_placement_transform(aip.getTransform());
 145      fgSetString("/ai/models/model-added", props->getPath());
 146    } else {
 147      if (!model_path.empty()) {
 148        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
 149      }
 150    }
 151
 152    setDie(false);
 153
 154    return true;
 155 }
 156
 157
 158 osg::Node*
 159 FGAIBase::load3DModel(const string& fg_root,
 160                       const string &path,
 161                       SGPropertyNode *prop_root,
 162                       double sim_time_sec)
 163 {
 164   // some more code here to check whether a model with this name has already been loaded
 165   // if not load it, otherwise, get the memory pointer and do something like
 166   // SetModel as in ATC/AIEntity.cxx
 167   osg::Group* personality_branch = new osg::Group;
 168
 169   //model = manager->getModel(path);
 170   //if (!(model)) {
 171       model = sgLoad3DModel(fg_root,
 172                             path,
 173                             prop_root,
 174                             sim_time_sec);
 175       //        manager->setModel(path, model.get());
 176       //}
 177   personality_branch->addChild( model.get() );
 178
 179   return personality_branch;
 180   //return model;
 181 }
 182
 183 bool FGAIBase::isa( object_type otype ) {
 184  if ( otype == _otype )
 185    return true;
 186  else
 187    return false;
 188 }
 189
 190
 191 void FGAIBase::bind() {
 192    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 193                                          &FGAIBase::getID));
 194    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 195    props->tie("velocities/vertical-speed-fps",
 196                SGRawValueMethods<FGAIBase,double>(*this,
 197                                          &FGAIBase::_getVS_fps,
 198                                          &FGAIBase::_setVS_fps));
 199
 200    props->tie("position/altitude-ft",
 201                SGRawValueMethods<FGAIBase,double>(*this,
 202                                          &FGAIBase::_getAltitude,
 203                                          &FGAIBase::_setAltitude));
 204    props->tie("position/latitude-deg",
 205                SGRawValueMethods<FGAIBase,double>(*this,
 206                                          &FGAIBase::_getLatitude,
 207                                          &FGAIBase::_setLatitude));
 208    props->tie("position/longitude-deg",
 209                SGRawValueMethods<FGAIBase,double>(*this,
 210                                          &FGAIBase::_getLongitude,
 211                                          &FGAIBase::_setLongitude));
 212
 213    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 214    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 215    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 216
 217    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 218    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 219    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 220    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 221    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 222    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 223    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 224    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 225    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 226    props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
 227
 228    props->tie("controls/lighting/nav-lights",
 229                SGRawValueFunctions<bool>(_isNight));
 230    props->setBoolValue("controls/lighting/beacon", true);
 231    props->setBoolValue("controls/lighting/strobe", true);
 232    props->setBoolValue("controls/glide-path", true);
 233
 234    props->setStringValue("controls/flight/lateral-mode", "roll");
 235    props->setDoubleValue("controls/flight/target-hdg", hdg);
 236    props->setDoubleValue("controls/flight/target-roll", roll);
 237
 238    props->setStringValue("controls/flight/longitude-mode", "alt");
 239    props->setDoubleValue("controls/flight/target-alt", altitude_ft);
 240    props->setDoubleValue("controls/flight/target-pitch", pitch);
 241
 242    props->setDoubleValue("controls/flight/target-spd", speed);
 243
 244 }
 245
 246 void FGAIBase::unbind() {
 247     props->untie("id");
 248     props->untie("velocities/true-airspeed-kt");
 249     props->untie("velocities/vertical-speed-fps");
 250
 251     props->untie("position/altitude-ft");
 252     props->untie("position/latitude-deg");
 253     props->untie("position/longitude-deg");
 254
 255     props->untie("orientation/pitch-deg");
 256     props->untie("orientation/roll-deg");
 257     props->untie("orientation/true-heading-deg");
 258
 259     props->untie("radar/in-range");
 260     props->untie("radar/bearing-deg");
 261     props->untie("radar/elevation-deg");
 262     props->untie("radar/range-nm");
 263     props->untie("radar/h-offset");
 264     props->untie("radar/v-offset");
 265     props->untie("radar/x-shift");
 266     props->untie("radar/y-shift");
 267     props->untie("radar/rotation");
 268     props->untie("radar/ht-diff-ft");
 269
 270     props->untie("controls/lighting/nav-lights");
 271 }
 272
 273 double FGAIBase::UpdateRadar(FGAIManager* manager)
 274 {
 275    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 276    bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
 277    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 278    radar_range_ft2 *= radar_range_ft2;
 279
 280    double user_latitude  = manager->get_user_latitude();
 281    double user_longitude = manager->get_user_longitude();
 282    double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
 283    double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
 284    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 285
 286    //
 287    // Test whether the target is within radar range.
 288    //
 289    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 290    if ( in_range || force_on )
 291    {
 292      props->setBoolValue("radar/in-range", true);
 293
 294      // copy values from the AIManager
 295      double user_altitude  = manager->get_user_altitude();
 296      double user_heading   = manager->get_user_heading();
 297      double user_pitch     = manager->get_user_pitch();
 298      //double user_yaw       = manager->get_user_yaw();
 299      //double user_speed     = manager->get_user_speed();
 300
 301      // calculate range to target in feet and nautical miles
 302      double range_ft = sqrt( range_ft2 );
 303      range = range_ft / 6076.11549;
 304
 305      // calculate bearing to target
 306      if (pos.getLatitudeDeg() >= user_latitude) {
 307         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 308         if (pos.getLongitudeDeg() >= user_longitude) {
 309            bearing = 90.0 - bearing;
 310         } else {
 311            bearing = 270.0 + bearing;
 312         }
 313      } else {
 314         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 315         if (pos.getLongitudeDeg() >= user_longitude) {
 316            bearing = 180.0 - bearing;
 317         } else {
 318            bearing = 180.0 + bearing;
 319         }
 320      }
 321
 322      // This is an alternate way to compute bearing and distance which
 323      // agrees with the original scheme within about 0.1 degrees.
 324      //
 325      // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
 326      //                user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
 327      // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
 328      // double gc_bearing, gc_range;
 329      // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
 330      // gc_range *= SG_METER_TO_NM;
 331      // gc_bearing *= SGD_RADIANS_TO_DEGREES;
 332      // printf("orig b = %.3f %.2f  gc b= %.3f, %.2f\n",
 333      //        bearing, range, gc_bearing, gc_range);
 334
 335      // calculate look left/right to target, without yaw correction
 336      horiz_offset = bearing - user_heading;
 337      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 338      if (horiz_offset < -180.0) horiz_offset += 360.0;
 339
 340      // calculate elevation to target
 341      elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
 342
 343      // calculate look up/down to target
 344      vert_offset = elevation - user_pitch;
 345
 346      /* this calculation needs to be fixed, but it isn't important anyway
 347      // calculate range rate
 348      double recip_bearing = bearing + 180.0;
 349      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 350      double my_horiz_offset = recip_bearing - hdg;
 351      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 352      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 353      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 354              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 355 */
 356
 357      // now correct look left/right for yaw
 358      // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
 359
 360      // calculate values for radar display
 361      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 362      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 363      rotation = hdg - user_heading;
 364      if (rotation < 0.0) rotation += 360.0;
 365      ht_diff = altitude_ft - user_altitude;
 366
 367    }
 368
 369    return range_ft2;
 370 }
 371
 372 SGVec3d
 373 FGAIBase::getCartPosAt(const SGVec3d& _off) const
 374 {
 375   // Transform that one to the horizontal local coordinate system.
 376
 377   SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
 378   // and postrotate the orientation of the AIModel wrt the horizontal
 379   // local frame
 380   hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 381
 382   // The offset converted to the usual body fixed coordinate system
 383   // rotated to the earth fiexed coordinates axis
 384   SGVec3d off = hlTrans.backTransform(_off);
 385
 386   // Add the position offset of the AIModel to gain the earth centered position
 387   SGVec3d cartPos = SGVec3d::fromGeod(pos);
 388
 389   return cartPos + off;
 390 }
 391
 392 /*
 393  * getters and Setters
 394  */
 395 void FGAIBase::_setLongitude( double longitude ) {
 396     pos.setLongitudeDeg(longitude);
 397 }
 398 void FGAIBase::_setLatitude ( double latitude )  {
 399     pos.setLatitudeDeg(latitude);
 400 }
 401
 402 double FGAIBase::_getLongitude() const {
 403     return pos.getLongitudeDeg();
 404 }
 405 double FGAIBase::_getLatitude () const {
 406     return pos.getLatitudeDeg();
 407 }
 408 double FGAIBase::_getRdot() const {
 409     return rdot;
 410 }
 411 double FGAIBase::_getVS_fps() const {
 412     return vs*60.0;
 413 }
 414 void FGAIBase::_setVS_fps( double _vs ) {
 415     vs = _vs/60.0;
 416 }
 417
 418 double FGAIBase::_getAltitude() const {
 419     return altitude_ft;
 420 }
 421 void FGAIBase::_setAltitude( double _alt ) {
 422     setAltitude( _alt );
 423 }
 424
 425 bool FGAIBase::_isNight() {
 426     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 427 }
 428
 429 int FGAIBase::getID() const {
 430     return  _refID;
 431 }
 432
 433 void FGAIBase::CalculateMach() {
 434     // Calculate rho at altitude, using standard atmosphere
 435     // For the temperature T and the pressure p,
 436
 437     double altitude = altitude_ft;
 438
 439     if (altitude < 36152) {             // curve fits for the troposphere
 440       T = 59 - 0.00356 * altitude;
 441       p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
 442
 443     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
 444       T = -70;
 445       p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
 446
 447     } else {                                    //  upper stratosphere
 448       T = -205.05 + (0.00164 * altitude);
 449       p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
 450     }
 451
 452     rho = p / (1718 * (T + 459.7));
 453
 454     // calculate the speed of sound at altitude
 455     // a = sqrt ( g * R * (T + 459.7))
 456     // where:
 457     // a = speed of sound [ft/s]
 458     // g = specific heat ratio, which is usually equal to 1.4
 459     // R = specific gas constant, which equals 1716 ft-lb/slug/°R
 460
 461     a = sqrt ( 1.4 * 1716 * (T + 459.7));
 462
 463     // calculate Mach number
 464
 465     Mach = speed/a;
 466
 467     // cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach;
 468 }
 469
 470 int FGAIBase::_newAIModelID() {
 471     static int id = 0;
 472    if (!++id)
 473       id++;     // id = 0 is not allowed.
 474    return id;
 475 }
 476