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      SGPath ai_path("AI");
 132      ai_path.append(model_path);
 133      try {
 134        model = load3DModel( globals->get_fg_root(), ai_path.str(), props,
 135                         globals->get_sim_time_sec() );
 136      } catch (const sg_exception &) {
 137        model = NULL;
 138      }
 139      if (!model) {
 140        try {
 141          model = load3DModel( globals->get_fg_root(), model_path, props,
 142                         globals->get_sim_time_sec() );
 143        } catch (const sg_exception &) {
 144          model = NULL;
 145        }
 146      }
 147    }
 148    if (model.get()) {
 149      aip.init( model.get() );
 150      aip.setVisible(true);
 151      invisible = false;
 152      globals->get_scenery()->get_scene_graph()->addChild(aip.getSceneGraph());
 153      // Register that one at the scenery manager
 154      globals->get_scenery()->register_placement_transform(aip.getTransform());
 155      fgSetString("/ai/models/model-added", props->getPath());
 156    } else {
 157      if (!model_path.empty()) {
 158        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
 159      }
 160    }
 161
 162    setDie(false);
 163
 164    return true;
 165 }
 166
 167
 168 osg::Node*
 169 FGAIBase::load3DModel(const string& fg_root,
 170                       const string &path,
 171                       SGPropertyNode *prop_root,
 172                       double sim_time_sec)
 173 {
 174   // some more code here to check whether a model with this name has already been loaded
 175   // if not load it, otherwise, get the memory pointer and do something like
 176   // SetModel as in ATC/AIEntity.cxx
 177   osg::Group* personality_branch = new osg::Group;
 178
 179   //model = manager->getModel(path);
 180   //if (!(model)) {
 181       model = sgLoad3DModel(fg_root,
 182                             path,
 183                             prop_root,
 184                             sim_time_sec);
 185       //        manager->setModel(path, model.get());
 186       //}
 187   personality_branch->addChild( model.get() );
 188
 189   return personality_branch;
 190   //return model;
 191 }
 192
 193 bool FGAIBase::isa( object_type otype ) {
 194  if ( otype == _otype )
 195    return true;
 196  else
 197    return false;
 198 }
 199
 200
 201 void FGAIBase::bind() {
 202    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 203                                          &FGAIBase::getID));
 204    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 205    props->tie("velocities/vertical-speed-fps",
 206                SGRawValueMethods<FGAIBase,double>(*this,
 207                                          &FGAIBase::_getVS_fps,
 208                                          &FGAIBase::_setVS_fps));
 209
 210    props->tie("position/altitude-ft",
 211                SGRawValueMethods<FGAIBase,double>(*this,
 212                                          &FGAIBase::_getAltitude,
 213                                          &FGAIBase::_setAltitude));
 214    props->tie("position/latitude-deg",
 215                SGRawValueMethods<FGAIBase,double>(*this,
 216                                          &FGAIBase::_getLatitude,
 217                                          &FGAIBase::_setLatitude));
 218    props->tie("position/longitude-deg",
 219                SGRawValueMethods<FGAIBase,double>(*this,
 220                                          &FGAIBase::_getLongitude,
 221                                          &FGAIBase::_setLongitude));
 222
 223    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 224    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 225    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 226
 227    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 228    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 229    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 230    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 231    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 232    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 233    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 234    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 235    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 236    props->tie("radar/ht-diff-ft", SGRawValuePointer<double>(&ht_diff));
 237
 238    props->tie("controls/lighting/nav-lights",
 239                SGRawValueFunctions<bool>(_isNight));
 240    props->setBoolValue("controls/lighting/beacon", true);
 241    props->setBoolValue("controls/lighting/strobe", true);
 242    props->setBoolValue("controls/glide-path", true);
 243
 244    props->setStringValue("controls/flight/lateral-mode", "roll");
 245    props->setDoubleValue("controls/flight/target-hdg", hdg);
 246    props->setDoubleValue("controls/flight/target-roll", roll);
 247
 248    props->setStringValue("controls/flight/longitude-mode", "alt");
 249    props->setDoubleValue("controls/flight/target-alt", altitude_ft);
 250    props->setDoubleValue("controls/flight/target-pitch", pitch);
 251
 252    props->setDoubleValue("controls/flight/target-spd", speed);
 253
 254 }
 255
 256 void FGAIBase::unbind() {
 257     props->untie("id");
 258     props->untie("velocities/true-airspeed-kt");
 259     props->untie("velocities/vertical-speed-fps");
 260
 261     props->untie("position/altitude-ft");
 262     props->untie("position/latitude-deg");
 263     props->untie("position/longitude-deg");
 264
 265     props->untie("orientation/pitch-deg");
 266     props->untie("orientation/roll-deg");
 267     props->untie("orientation/true-heading-deg");
 268
 269     props->untie("radar/in-range");
 270     props->untie("radar/bearing-deg");
 271     props->untie("radar/elevation-deg");
 272     props->untie("radar/range-nm");
 273     props->untie("radar/h-offset");
 274     props->untie("radar/v-offset");
 275     props->untie("radar/x-shift");
 276     props->untie("radar/y-shift");
 277     props->untie("radar/rotation");
 278     props->untie("radar/ht-diff-ft");
 279
 280     props->untie("controls/lighting/nav-lights");
 281 }
 282
 283 double FGAIBase::UpdateRadar(FGAIManager* manager)
 284 {
 285    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 286    bool force_on = fgGetBool("/instrumentation/radar/debug-mode", false);
 287    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 288    radar_range_ft2 *= radar_range_ft2;
 289
 290    double user_latitude  = manager->get_user_latitude();
 291    double user_longitude = manager->get_user_longitude();
 292    double lat_range = fabs(pos.getLatitudeDeg() - user_latitude) * ft_per_deg_lat;
 293    double lon_range = fabs(pos.getLongitudeDeg() - user_longitude) * ft_per_deg_lon;
 294    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 295
 296    //
 297    // Test whether the target is within radar range.
 298    //
 299    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 300    if ( in_range || force_on )
 301    {
 302      props->setBoolValue("radar/in-range", true);
 303
 304      // copy values from the AIManager
 305      double user_altitude  = manager->get_user_altitude();
 306      double user_heading   = manager->get_user_heading();
 307      double user_pitch     = manager->get_user_pitch();
 308      //double user_yaw       = manager->get_user_yaw();
 309      //double user_speed     = manager->get_user_speed();
 310
 311      // calculate range to target in feet and nautical miles
 312      double range_ft = sqrt( range_ft2 );
 313      range = range_ft / 6076.11549;
 314
 315      // calculate bearing to target
 316      if (pos.getLatitudeDeg() >= user_latitude) {
 317         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 318         if (pos.getLongitudeDeg() >= user_longitude) {
 319            bearing = 90.0 - bearing;
 320         } else {
 321            bearing = 270.0 + bearing;
 322         }
 323      } else {
 324         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 325         if (pos.getLongitudeDeg() >= user_longitude) {
 326            bearing = 180.0 - bearing;
 327         } else {
 328            bearing = 180.0 + bearing;
 329         }
 330      }
 331
 332      // This is an alternate way to compute bearing and distance which
 333      // agrees with the original scheme within about 0.1 degrees.
 334      //
 335      // Point3D start( user_longitude * SGD_DEGREES_TO_RADIANS,
 336      //                user_latitude * SGD_DEGREES_TO_RADIANS, 0 );
 337      // Point3D dest( pos.getLongitudeRad(), pos.getLatitudeRad(), 0 );
 338      // double gc_bearing, gc_range;
 339      // calc_gc_course_dist( start, dest, &gc_bearing, &gc_range );
 340      // gc_range *= SG_METER_TO_NM;
 341      // gc_bearing *= SGD_RADIANS_TO_DEGREES;
 342      // printf("orig b = %.3f %.2f  gc b= %.3f, %.2f\n",
 343      //        bearing, range, gc_bearing, gc_range);
 344
 345      // calculate look left/right to target, without yaw correction
 346      horiz_offset = bearing - user_heading;
 347      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 348      if (horiz_offset < -180.0) horiz_offset += 360.0;
 349
 350      // calculate elevation to target
 351      elevation = atan2( altitude_ft - user_altitude, range_ft ) * SG_RADIANS_TO_DEGREES;
 352
 353      // calculate look up/down to target
 354      vert_offset = elevation - user_pitch;
 355
 356      /* this calculation needs to be fixed, but it isn't important anyway
 357      // calculate range rate
 358      double recip_bearing = bearing + 180.0;
 359      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 360      double my_horiz_offset = recip_bearing - hdg;
 361      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 362      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 363      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 364              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 365 */
 366
 367      // now correct look left/right for yaw
 368      // horiz_offset += user_yaw; // FIXME: WHY WOULD WE WANT TO ADD IN SIDE-SLIP HERE?
 369
 370      // calculate values for radar display
 371      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 372      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 373      rotation = hdg - user_heading;
 374      if (rotation < 0.0) rotation += 360.0;
 375      ht_diff = altitude_ft - user_altitude;
 376
 377    }
 378
 379    return range_ft2;
 380 }
 381
 382 SGVec3d
 383 FGAIBase::getCartPosAt(const SGVec3d& _off) const
 384 {
 385   // Transform that one to the horizontal local coordinate system.
 386
 387   SGQuatd hlTrans = SGQuatd::fromLonLat(pos);
 388   // and postrotate the orientation of the AIModel wrt the horizontal
 389   // local frame
 390   hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 391
 392   // The offset converted to the usual body fixed coordinate system
 393   // rotated to the earth fiexed coordinates axis
 394   SGVec3d off = hlTrans.backTransform(_off);
 395
 396   // Add the position offset of the AIModel to gain the earth centered position
 397   SGVec3d cartPos = SGVec3d::fromGeod(pos);
 398
 399   return cartPos + off;
 400 }
 401
 402 /*
 403  * getters and Setters
 404  */
 405 void FGAIBase::_setLongitude( double longitude ) {
 406     pos.setLongitudeDeg(longitude);
 407 }
 408 void FGAIBase::_setLatitude ( double latitude )  {
 409     pos.setLatitudeDeg(latitude);
 410 }
 411
 412 double FGAIBase::_getLongitude() const {
 413     return pos.getLongitudeDeg();
 414 }
 415 double FGAIBase::_getLatitude () const {
 416     return pos.getLatitudeDeg();
 417 }
 418 double FGAIBase::_getRdot() const {
 419     return rdot;
 420 }
 421 double FGAIBase::_getVS_fps() const {
 422     return vs*60.0;
 423 }
 424 void FGAIBase::_setVS_fps( double _vs ) {
 425     vs = _vs/60.0;
 426 }
 427
 428 double FGAIBase::_getAltitude() const {
 429     return altitude_ft;
 430 }
 431 void FGAIBase::_setAltitude( double _alt ) {
 432     setAltitude( _alt );
 433 }
 434
 435 bool FGAIBase::_isNight() {
 436     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 437 }
 438
 439 int FGAIBase::getID() const {
 440     return  _refID;
 441 }
 442
 443 void FGAIBase::CalculateMach() {
 444     // Calculate rho at altitude, using standard atmosphere
 445     // For the temperature T and the pressure p,
 446
 447     double altitude = altitude_ft;
 448
 449     if (altitude < 36152) {             // curve fits for the troposphere
 450       T = 59 - 0.00356 * altitude;
 451       p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
 452
 453     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
 454       T = -70;
 455       p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
 456
 457     } else {                                    //  upper stratosphere
 458       T = -205.05 + (0.00164 * altitude);
 459       p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
 460     }
 461
 462     rho = p / (1718 * (T + 459.7));
 463
 464     // calculate the speed of sound at altitude
 465     // a = sqrt ( g * R * (T + 459.7))
 466     // where:
 467     // a = speed of sound [ft/s]
 468     // g = specific heat ratio, which is usually equal to 1.4
 469     // R = specific gas constant, which equals 1716 ft-lb/slug/°R
 470
 471     a = sqrt ( 1.4 * 1716 * (T + 459.7));
 472
 473     // calculate Mach number
 474
 475     Mach = speed/a;
 476
 477     // cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach;
 478 }
 479
 480 int FGAIBase::_newAIModelID() {
 481     static int id = 0;
 482    if (!++id)
 483       id++;     // id = 0 is not allowed.
 484    return id;
 485 }
 486