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