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