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     globals->get_scenery()->get_scene_graph()->removeKid(aip.getSceneGraph());
  73     // unbind();
  74     SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
  75     root->removeChild(_type_str.c_str(), index);
  76     if (fp) delete fp;
  77     fp = NULL;
  78 }
  79
  80 void FGAIBase::update(double dt) {
  81     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.lat()/SG_RADIANS_TO_DEGREES);
  82     ft_per_deg_lon = 365228.16 * cos(pos.lat() / SG_RADIANS_TO_DEGREES);
  83
  84     // Calculate rho at altitude, using standard atmosphere
  85     // For the temperature T and the pressure p,
  86
  87     if (altitude < 36152) {             // curve fits for the troposphere
  88       T = 59 - 0.00356 * altitude;
  89       p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
  90
  91     } else if ( 36152 < altitude && altitude < 82345 ) {    // lower stratosphere
  92       T = -70;
  93       p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
  94
  95     } else {                                    //  upper stratosphere
  96       T = -205.05 + (0.00164 * altitude);
  97       p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
  98     }
  99
 100     rho = p / (1718 * (T + 459.7));
 101
 102         // calculate the speed of sound at altitude
 103         // a = sqrt ( g * R * (T + 459.7))
 104         // where:
 105         // a = speed of sound [ft/s]
 106         // g = specific heat ratio, which is usually equal to 1.4
 107         // R = specific gas constant, which equals 1716 ft-lb/slug/°R
 108
 109         a = sqrt ( 1.4 * 1716 * (T + 459.7));
 110
 111         // calculate Mach number
 112
 113         Mach = speed/a;
 114
 115 //      cout  << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach;
 116 }
 117
 118 void FGAIBase::Transform() {
 119     if (!invisible) {
 120       aip.setPosition(pos.lon(), pos.lat(), pos.elev() * SG_METER_TO_FEET);
 121       if (no_roll) {
 122          aip.setOrientation(0.0, pitch, hdg);
 123       } else {
 124          aip.setOrientation(roll, pitch, hdg);
 125       }
 126       aip.update( globals->get_scenery()->get_center() );
 127     }
 128 }
 129
 130
 131 bool FGAIBase::init() {
 132
 133    SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
 134
 135    index = manager->getNum(_otype) - 1;
 136    props = root->getNode(_type_str.c_str(), index, true);
 137
 138    if (model_path != "") {
 139       model = sgLoad3DModel( globals->get_fg_root(),
 140                              model_path.c_str(),
 141                              props,
 142                              globals->get_sim_time_sec() );
 143    }
 144    if (model) {
 145      aip.init( model );
 146      aip.setVisible(true);
 147      invisible = false;
 148      globals->get_scenery()->get_scene_graph()->addKid(aip.getSceneGraph());
 149    } else {
 150      if (model_path != "") {
 151        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model.");
 152      }
 153    }
 154
 155    setDie(false);
 156
 157    return true;
 158 }
 159
 160 bool FGAIBase::isa( object_type otype ) {
 161  if ( otype == _otype ) { return true; }
 162  else { return false; }
 163 }
 164
 165
 166 void FGAIBase::bind() {
 167    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 168                                          &FGAIBase::_getID));
 169    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 170    props->tie("velocities/vertical-speed-fps",
 171                SGRawValueMethods<FGAIBase,double>(*this,
 172                                          &FGAIBase::_getVS_fps,
 173                                          &FGAIBase::_setVS_fps));
 174
 175    props->tie("position/altitude-ft",
 176                SGRawValueMethods<FGAIBase,double>(*this,
 177                                          &FGAIBase::_getAltitude,
 178                                          &FGAIBase::_setAltitude));
 179    props->tie("position/latitude-deg",
 180                SGRawValueMethods<FGAIBase,double>(*this,
 181                                          &FGAIBase::_getLatitude,
 182                                          &FGAIBase::_setLatitude));
 183    props->tie("position/longitude-deg",
 184                SGRawValueMethods<FGAIBase,double>(*this,
 185                                          &FGAIBase::_getLongitude,
 186                                          &FGAIBase::_setLongitude));
 187
 188    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 189    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 190    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 191
 192    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 193    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 194    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 195    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 196    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 197    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 198    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 199    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 200    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 201
 202    props->tie("controls/lighting/nav-lights",
 203                SGRawValueFunctions<bool>(_isNight));
 204    props->setBoolValue("controls/lighting/beacon", true);
 205    props->setBoolValue("controls/lighting/strobe", true);
 206 }
 207
 208 void FGAIBase::unbind() {
 209     props->untie("id");
 210     props->untie("velocities/true-airspeed-kt");
 211     props->untie("velocities/vertical-speed-fps");
 212
 213     props->untie("position/altitude-ft");
 214     props->untie("position/latitude-deg");
 215     props->untie("position/longitude-deg");
 216
 217     props->untie("orientation/pitch-deg");
 218     props->untie("orientation/roll-deg");
 219     props->untie("orientation/true-heading-deg");
 220
 221     props->untie("radar/in-range");
 222     props->untie("radar/bearing-deg");
 223     props->untie("radar/elevation-deg");
 224     props->untie("radar/range-nm");
 225     props->untie("radar/h-offset");
 226     props->untie("radar/v-offset");
 227     props->untie("radar/x-shift");
 228     props->untie("radar/y-shift");
 229     props->untie("radar/rotation");
 230
 231     props->untie("controls/lighting/nav-lights");
 232 }
 233
 234 double FGAIBase::UpdateRadar(FGAIManager* manager)
 235 {
 236    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 237    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 238    radar_range_ft2 *= radar_range_ft2;
 239
 240    double user_latitude  = manager->get_user_latitude();
 241    double user_longitude = manager->get_user_longitude();
 242    double lat_range = fabs(pos.lat() - user_latitude) * ft_per_deg_lat;
 243    double lon_range = fabs(pos.lon() - user_longitude) * ft_per_deg_lon;
 244    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 245
 246    //
 247    // Test whether the target is within radar range.
 248    //
 249    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 250    if ( in_range )
 251    {
 252      props->setBoolValue("radar/in-range", true);
 253
 254      // copy values from the AIManager
 255      double user_altitude  = manager->get_user_altitude();
 256      double user_heading   = manager->get_user_heading();
 257      double user_pitch     = manager->get_user_pitch();
 258      double user_yaw       = manager->get_user_yaw();
 259      double user_speed     = manager->get_user_speed();
 260
 261      // calculate range to target in feet and nautical miles
 262      double range_ft = sqrt( range_ft2 );
 263      range = range_ft / 6076.11549;
 264
 265      // calculate bearing to target
 266      if (pos.lat() >= user_latitude) {
 267         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 268         if (pos.lon() >= user_longitude) {
 269            bearing = 90.0 - bearing;
 270         } else {
 271            bearing = 270.0 + bearing;
 272         }
 273      } else {
 274         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 275         if (pos.lon() >= user_longitude) {
 276            bearing = 180.0 - bearing;
 277         } else {
 278            bearing = 180.0 + bearing;
 279         }
 280      }
 281
 282      // calculate look left/right to target, without yaw correction
 283      horiz_offset = bearing - user_heading;
 284      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 285      if (horiz_offset < -180.0) horiz_offset += 360.0;
 286
 287      // calculate elevation to target
 288      elevation = atan2( altitude * SG_METER_TO_FEET - user_altitude, range_ft )
 289                         * SG_RADIANS_TO_DEGREES;
 290
 291      // calculate look up/down to target
 292      vert_offset = elevation + user_pitch;
 293
 294      /* this calculation needs to be fixed, but it isn't important anyway
 295      // calculate range rate
 296      double recip_bearing = bearing + 180.0;
 297      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 298      double my_horiz_offset = recip_bearing - hdg;
 299      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 300      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 301      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 302              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 303 */
 304
 305      // now correct look left/right for yaw
 306      horiz_offset += user_yaw;
 307
 308      // calculate values for radar display
 309      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 310      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 311      rotation = hdg - user_heading;
 312      if (rotation < 0.0) rotation += 360.0;
 313
 314    }
 315
 316    return range_ft2;
 317 }
 318
 319
 320 /*
 321  * getters and Setters
 322  */
 323 void FGAIBase::_setLongitude( double longitude ) {
 324     pos.setlon(longitude);
 325 }
 326 void FGAIBase::_setLatitude ( double latitude )  {
 327     pos.setlat(latitude);
 328 }
 329
 330 double FGAIBase::_getLongitude() const {
 331     return pos.lon();
 332 }
 333 double FGAIBase::_getLatitude () const {
 334     return pos.lat();
 335 }
 336 double FGAIBase::_getRdot() const {
 337     return rdot;
 338 }
 339 double FGAIBase::_getVS_fps() const {
 340     return vs*60.0;
 341 }
 342 void FGAIBase::_setVS_fps( double _vs ) {
 343     vs = _vs/60.0;
 344 }
 345
 346 double FGAIBase::_getAltitude() const {
 347     return altitude;
 348 }
 349 void FGAIBase::_setAltitude( double _alt ) {
 350     setAltitude( _alt );
 351 }
 352
 353 bool FGAIBase::_isNight() {
 354     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 355 }
 356
 357 int FGAIBase::_getID() const {
 358     return (int)(this);
 359 }