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