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., 675 Mass Ave, Cambridge, MA 02139, 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 <plib/sg.h>
  30 #include <plib/ssg.h>
  31
  32 #include <simgear/math/point3d.hxx>
  33 #include <simgear/math/sg_geodesy.hxx>
  34 #include <simgear/misc/sg_path.hxx>
  35 #include <simgear/scene/model/location.hxx>
  36 #include <simgear/scene/model/model.hxx>
  37 #include <simgear/debug/logstream.hxx>
  38 #include <simgear/props/props.hxx>
  39
  40 #include <Main/globals.hxx>
  41 #include <Scenery/scenery.hxx>
  42
  43
  44 #include "AIBase.hxx"
  45 #include "AIManager.hxx"
  46
  47
  48 const double FGAIBase::e = 2.71828183;
  49 const double FGAIBase::lbs_to_slugs = 0.031080950172;   //conversion factor
  50
  51
  52 FGAIBase::FGAIBase(object_type ot)
  53   : fp( NULL ),
  54     props( NULL ),
  55     manager( NULL ),
  56     _refID( _newAIModelID() ),
  57     _otype(ot)
  58 {
  59     tgt_heading = hdg = tgt_altitude = tgt_speed = 0.0;
  60     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
  61     bearing = elevation = range = rdot = 0.0;
  62     x_shift = y_shift = rotation = 0.0;
  63     in_range = false;
  64     invisible = true;
  65     no_roll = true;
  66     life = 900;
  67     index = 0;
  68     delete_me = false;
  69 }
  70
  71 FGAIBase::~FGAIBase() {
  72     // Unregister that one at the scenery manager
  73     if (globals->get_scenery()) {
  74         globals->get_scenery()->unregister_placement_transform(aip.getTransform());
  75         globals->get_scenery()->get_scene_graph()->removeKid(aip.getSceneGraph());
  76     }
  77     SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
  78     root->removeChild(getTypeString(), index);
  79     delete fp;
  80     fp = NULL;
  81 }
  82
  83
  84 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
  85 {
  86   if (!scFileNode)
  87     return;
  88
  89   setPath(scFileNode->getStringValue("model", "Models/Geometry/glider.ac"));
  90
  91   setHeading(scFileNode->getDoubleValue("heading", 0.0));
  92   setSpeed(scFileNode->getDoubleValue("speed", 0.0));
  93   setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
  94   setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
  95   setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
  96   setBank(scFileNode->getDoubleValue("roll", 0.0));
  97 }
  98
  99 void FGAIBase::update(double dt) {
 100     if (_otype == otStatic) return;
 101     if (_otype == otBallistic) CalculateMach();
 102
 103     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.lat()*SGD_DEGREES_TO_RADIANS);
 104     ft_per_deg_lon = 365228.16 * cos(pos.lat()*SGD_DEGREES_TO_RADIANS);
 105 }
 106
 107 void FGAIBase::Transform() {
 108     if (!invisible) {
 109       aip.setPosition(pos.lon(), pos.lat(), pos.elev() * SG_METER_TO_FEET);
 110       if (no_roll) {
 111          aip.setOrientation(0.0, pitch, hdg);
 112       } else {
 113          aip.setOrientation(roll, pitch, hdg);
 114       }
 115       aip.update();
 116     }
 117 }
 118
 119
 120 bool FGAIBase::init() {
 121
 122    SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
 123
 124    index = manager->getNum(_otype) - 1;
 125    props = root->getNode(getTypeString(), index, true);
 126
 127    if (!model_path.empty()) {
 128      try {
 129        model = load3DModel( globals->get_fg_root(), model_path, props,
 130                             globals->get_sim_time_sec() );
 131      } catch (const sg_exception &e) {
 132        model = NULL;
 133      }
 134    }
 135    if (model) {
 136      aip.init( model );
 137      aip.setVisible(true);
 138      invisible = false;
 139      globals->get_scenery()->get_scene_graph()->addKid(aip.getSceneGraph());
 140      // Register that one at the scenery manager
 141      globals->get_scenery()->register_placement_transform(aip.getTransform());
 142    } else {
 143      if (!model_path.empty()) {
 144        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
 145      }
 146    }
 147
 148    setDie(false);
 149
 150    return true;
 151 }
 152
 153
 154 ssgBranch * FGAIBase::load3DModel(const string& fg_root,
 155                                   const string &path,
 156                                   SGPropertyNode *prop_root,
 157                                   double sim_time_sec)
 158 {
 159   // some more code here to check whether a model with this name has already been loaded
 160   // if not load it, otherwise, get the memory pointer and do something like
 161   // SetModel as in ATC/AIEntity.cxx
 162   model = manager->getModel(path);
 163   if (!(model))
 164     {
 165       model = sgLoad3DModel(fg_root,
 166                             path,
 167                             prop_root,
 168                             sim_time_sec);
 169       manager->setModel(path, model);
 170     }
 171
 172   return model;
 173 }
 174
 175 bool FGAIBase::isa( object_type otype ) {
 176  if ( otype == _otype ) { return true; }
 177  else { return false; }
 178 }
 179
 180
 181 void FGAIBase::bind() {
 182    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 183                                          &FGAIBase::getID));
 184    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 185    props->tie("velocities/vertical-speed-fps",
 186                SGRawValueMethods<FGAIBase,double>(*this,
 187                                          &FGAIBase::_getVS_fps,
 188                                          &FGAIBase::_setVS_fps));
 189
 190    props->tie("position/altitude-ft",
 191                SGRawValueMethods<FGAIBase,double>(*this,
 192                                          &FGAIBase::_getAltitude,
 193                                          &FGAIBase::_setAltitude));
 194    props->tie("position/latitude-deg",
 195                SGRawValueMethods<FGAIBase,double>(*this,
 196                                          &FGAIBase::_getLatitude,
 197                                          &FGAIBase::_setLatitude));
 198    props->tie("position/longitude-deg",
 199                SGRawValueMethods<FGAIBase,double>(*this,
 200                                          &FGAIBase::_getLongitude,
 201                                          &FGAIBase::_setLongitude));
 202
 203    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 204    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 205    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 206
 207    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 208    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 209    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 210    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 211    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 212    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 213    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 214    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 215    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 216
 217    props->tie("controls/lighting/nav-lights",
 218                SGRawValueFunctions<bool>(_isNight));
 219    props->setBoolValue("controls/lighting/beacon", true);
 220    props->setBoolValue("controls/lighting/strobe", true);
 221    props->setBoolValue("controls/glide-path", true);
 222 }
 223
 224 void FGAIBase::unbind() {
 225     props->untie("id");
 226     props->untie("velocities/true-airspeed-kt");
 227     props->untie("velocities/vertical-speed-fps");
 228
 229     props->untie("position/altitude-ft");
 230     props->untie("position/latitude-deg");
 231     props->untie("position/longitude-deg");
 232
 233     props->untie("orientation/pitch-deg");
 234     props->untie("orientation/roll-deg");
 235     props->untie("orientation/true-heading-deg");
 236
 237     props->untie("radar/in-range");
 238     props->untie("radar/bearing-deg");
 239     props->untie("radar/elevation-deg");
 240     props->untie("radar/range-nm");
 241     props->untie("radar/h-offset");
 242     props->untie("radar/v-offset");
 243     props->untie("radar/x-shift");
 244     props->untie("radar/y-shift");
 245     props->untie("radar/rotation");
 246
 247     props->untie("controls/lighting/nav-lights");
 248 }
 249
 250 double FGAIBase::UpdateRadar(FGAIManager* manager)
 251 {
 252    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 253    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 254    radar_range_ft2 *= radar_range_ft2;
 255
 256    double user_latitude  = manager->get_user_latitude();
 257    double user_longitude = manager->get_user_longitude();
 258    double lat_range = fabs(pos.lat() - user_latitude) * ft_per_deg_lat;
 259    double lon_range = fabs(pos.lon() - user_longitude) * ft_per_deg_lon;
 260    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 261
 262    //
 263    // Test whether the target is within radar range.
 264    //
 265    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 266    if ( in_range )
 267    {
 268      props->setBoolValue("radar/in-range", true);
 269
 270      // copy values from the AIManager
 271      double user_altitude  = manager->get_user_altitude();
 272      double user_heading   = manager->get_user_heading();
 273      double user_pitch     = manager->get_user_pitch();
 274      double user_yaw       = manager->get_user_yaw();
 275      double user_speed     = manager->get_user_speed();
 276
 277      // calculate range to target in feet and nautical miles
 278      double range_ft = sqrt( range_ft2 );
 279      range = range_ft / 6076.11549;
 280
 281      // calculate bearing to target
 282      if (pos.lat() >= user_latitude) {
 283         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 284         if (pos.lon() >= user_longitude) {
 285            bearing = 90.0 - bearing;
 286         } else {
 287            bearing = 270.0 + bearing;
 288         }
 289      } else {
 290         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 291         if (pos.lon() >= user_longitude) {
 292            bearing = 180.0 - bearing;
 293         } else {
 294            bearing = 180.0 + bearing;
 295         }
 296      }
 297
 298      // calculate look left/right to target, without yaw correction
 299      horiz_offset = bearing - user_heading;
 300      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 301      if (horiz_offset < -180.0) horiz_offset += 360.0;
 302
 303      // calculate elevation to target
 304      elevation = atan2( altitude * SG_METER_TO_FEET - user_altitude, range_ft )
 305                         * SG_RADIANS_TO_DEGREES;
 306
 307      // calculate look up/down to target
 308      vert_offset = elevation + user_pitch;
 309
 310      /* this calculation needs to be fixed, but it isn't important anyway
 311      // calculate range rate
 312      double recip_bearing = bearing + 180.0;
 313      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 314      double my_horiz_offset = recip_bearing - hdg;
 315      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 316      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 317      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 318              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 319 */
 320
 321      // now correct look left/right for yaw
 322      horiz_offset += user_yaw;
 323
 324      // calculate values for radar display
 325      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 326      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 327      rotation = hdg - user_heading;
 328      if (rotation < 0.0) rotation += 360.0;
 329
 330    }
 331
 332    return range_ft2;
 333 }
 334
 335 Point3D
 336 FGAIBase::getCartPosAt(const Point3D& off) const
 337 {
 338   // The offset converted to the usual body fixed coordinate system.
 339   sgdVec3 sgdOff;
 340   sgdSetVec3(sgdOff, -off.x(), off.z(), -off.y());
 341
 342   // Transform that one to the horizontal local coordinate system.
 343   sgdMat4 hlTrans;
 344   sgdMakeRotMat4(hlTrans, hdg, pitch, roll);
 345   sgdXformPnt3(sgdOff, hlTrans);
 346
 347   // Now transform to the wgs84 earth centeres system.
 348   Point3D pos2(pos.lon()* SGD_DEGREES_TO_RADIANS,
 349                pos.lat() * SGD_DEGREES_TO_RADIANS,
 350                pos.elev());
 351   Point3D cartPos3D = sgGeodToCart(pos2);
 352   sgdMat4 ecTrans;
 353   sgdMakeCoordMat4(ecTrans, cartPos3D.x(), cartPos3D.y(), cartPos3D.z(),
 354                    pos.lon(), 0, - 90 - pos.lat());
 355   sgdXformPnt3(sgdOff, ecTrans);
 356
 357   return Point3D(sgdOff[0], sgdOff[1], sgdOff[2]);
 358 }
 359
 360 Point3D
 361 FGAIBase::getGeocPosAt(const Point3D& off) const
 362 {
 363   return sgCartToGeod(getCartPosAt(off));
 364 }
 365
 366 /*
 367  * getters and Setters
 368  */
 369 void FGAIBase::_setLongitude( double longitude ) {
 370     pos.setlon(longitude);
 371 }
 372 void FGAIBase::_setLatitude ( double latitude )  {
 373     pos.setlat(latitude);
 374 }
 375
 376 double FGAIBase::_getLongitude() const {
 377     return pos.lon();
 378 }
 379 double FGAIBase::_getLatitude () const {
 380     return pos.lat();
 381 }
 382 double FGAIBase::_getRdot() const {
 383     return rdot;
 384 }
 385 double FGAIBase::_getVS_fps() const {
 386     return vs*60.0;
 387 }
 388 void FGAIBase::_setVS_fps( double _vs ) {
 389     vs = _vs/60.0;
 390 }
 391
 392 double FGAIBase::_getAltitude() const {
 393     return altitude;
 394 }
 395 void FGAIBase::_setAltitude( double _alt ) {
 396     setAltitude( _alt );
 397 }
 398
 399 bool FGAIBase::_isNight() {
 400     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 401 }
 402
 403 int FGAIBase::getID() const {
 404     return  _refID;
 405 }
 406
 407 void FGAIBase::CalculateMach() {
 408      // Calculate rho at altitude, using standard atmosphere
 409      // For the temperature T and the pressure p,
 410
 411      if (altitude < 36152) {            // curve fits for the troposphere
 412        T = 59 - 0.00356 * altitude;
 413        p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
 414
 415      } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
 416        T = -70;
 417        p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
 418
 419      } else {                                    //  upper stratosphere
 420        T = -205.05 + (0.00164 * altitude);
 421        p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
 422      }
 423
 424      rho = p / (1718 * (T + 459.7));
 425
 426         // calculate the speed of sound at altitude
 427         // a = sqrt ( g * R * (T + 459.7))
 428         // where:
 429         // a = speed of sound [ft/s]
 430         // g = specific heat ratio, which is usually equal to 1.4
 431         // R = specific gas constant, which equals 1716 ft-lb/slug/°R
 432
 433         a = sqrt ( 1.4 * 1716 * (T + 459.7));
 434
 435         // calculate Mach number
 436
 437         Mach = speed/a;
 438
 439  //     cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach;
 440 }
 441
 442 int FGAIBase::_newAIModelID() {
 443    static int id = 0;
 444    if (!++id) id++;     // id = 0 is not allowed.
 445    return id;
 446 }
 447