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