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