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