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 FGAIBase::FGAIBase() {
  47     _type_str = "model";
  48     tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
  49     bearing = elevation = range = rdot = 0.0;
  50     x_shift = y_shift = rotation = 0.0;
  51     in_range = false;
  52     invisible = true;
  53     no_roll = true;
  54     life = 900;
  55     model_path = "";
  56     model = 0;
  57     _otype = otNull;
  58     index = 0;
  59     fp = (FGAIFlightPlan*)0;
  60     delete_me = false;
  61     manager = NULL;
  62 }
  63
  64 FGAIBase::~FGAIBase() {
  65     globals->get_scenery()->get_scene_graph()->removeKid(aip.getSceneGraph());
  66     // unbind();
  67     SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
  68     root->removeChild(_type_str.c_str(), index);
  69     if (fp) delete fp;
  70 }
  71
  72 void FGAIBase::update(double dt) {
  73     ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.lat()/SG_RADIANS_TO_DEGREES);
  74     ft_per_deg_lon = 365228.16 * cos(pos.lat() / SG_RADIANS_TO_DEGREES);
  75 }
  76
  77
  78 void FGAIBase::Transform() {
  79     if (!invisible) {
  80       aip.setPosition(pos.lon(), pos.lat(), pos.elev() * SG_METER_TO_FEET);
  81       if (no_roll) {
  82          aip.setOrientation(0.0, pitch, hdg);
  83       } else {
  84          aip.setOrientation(roll, pitch, hdg);
  85       }
  86       aip.update( globals->get_scenery()->get_center() );
  87     }
  88 }
  89
  90
  91 bool FGAIBase::init() {
  92
  93    SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
  94
  95    index = manager->getNum(_otype) - 1;
  96    props = root->getNode(_type_str.c_str(), index, true);
  97
  98    if (model_path != "") {
  99       model = sgLoad3DModel( globals->get_fg_root(),
 100                              model_path.c_str(),
 101                              props,
 102                              globals->get_sim_time_sec() );
 103    }
 104    if (model) {
 105      aip.init( model );
 106      aip.setVisible(true);
 107      invisible = false;
 108      globals->get_scenery()->get_scene_graph()->addKid(aip.getSceneGraph());
 109    } else {
 110      if (model_path != "") {
 111        SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model.");
 112      }
 113    }
 114
 115    setDie(false);
 116
 117    return true;
 118 }
 119
 120 bool FGAIBase::isa( object_type otype ) {
 121  if ( otype == _otype ) { return true; }
 122  else { return false; }
 123 }
 124
 125
 126 void FGAIBase::bind() {
 127    props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
 128                                          &FGAIBase::_getID));
 129    props->tie("velocities/true-airspeed-kt",  SGRawValuePointer<double>(&speed));
 130    props->tie("velocities/vertical-speed-fps",
 131                SGRawValueMethods<FGAIBase,double>(*this,
 132                                          &FGAIBase::_getVS_fps,
 133                                          &FGAIBase::_setVS_fps));
 134
 135    props->tie("position/altitude-ft",
 136                SGRawValueMethods<FGAIBase,double>(*this,
 137                                          &FGAIBase::_getAltitude,
 138                                          &FGAIBase::_setAltitude));
 139    props->tie("position/latitude-deg",
 140                SGRawValueMethods<FGAIBase,double>(*this,
 141                                          &FGAIBase::_getLatitude,
 142                                          &FGAIBase::_setLatitude));
 143    props->tie("position/longitude-deg",
 144                SGRawValueMethods<FGAIBase,double>(*this,
 145                                          &FGAIBase::_getLongitude,
 146                                          &FGAIBase::_setLongitude));
 147
 148    props->tie("orientation/pitch-deg",   SGRawValuePointer<double>(&pitch));
 149    props->tie("orientation/roll-deg",    SGRawValuePointer<double>(&roll));
 150    props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
 151
 152    props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
 153    props->tie("radar/bearing-deg",   SGRawValuePointer<double>(&bearing));
 154    props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
 155    props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
 156    props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
 157    props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
 158    props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
 159    props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
 160    props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
 161
 162    props->tie("controls/lighting/nav-lights",
 163                SGRawValueFunctions<bool>(_isNight));
 164    props->setBoolValue("controls/lighting/beacon", true);
 165    props->setBoolValue("controls/lighting/strobe", true);
 166 }
 167
 168 void FGAIBase::unbind() {
 169     props->untie("id");
 170     props->untie("velocities/true-airspeed-kt");
 171     props->untie("velocities/vertical-speed-fps");
 172
 173     props->untie("position/altitude-ft");
 174     props->untie("position/latitude-deg");
 175     props->untie("position/longitude-deg");
 176
 177     props->untie("orientation/pitch-deg");
 178     props->untie("orientation/roll-deg");
 179     props->untie("orientation/true-heading-deg");
 180
 181     props->untie("radar/in-range");
 182     props->untie("radar/bearing-deg");
 183     props->untie("radar/elevation-deg");
 184     props->untie("radar/range-nm");
 185     props->untie("radar/h-offset");
 186     props->untie("radar/v-offset");
 187     props->untie("radar/x-shift");
 188     props->untie("radar/y-shift");
 189     props->untie("radar/rotation");
 190
 191     props->untie("controls/lighting/nav-lights");
 192 }
 193
 194 double FGAIBase::UpdateRadar(FGAIManager* manager)
 195 {
 196    double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
 197    radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
 198    radar_range_ft2 *= radar_range_ft2;
 199
 200    double user_latitude  = manager->get_user_latitude();
 201    double user_longitude = manager->get_user_longitude();
 202    double lat_range = fabs(pos.lat() - user_latitude) * ft_per_deg_lat;
 203    double lon_range = fabs(pos.lon() - user_longitude) * ft_per_deg_lon;
 204    double range_ft2 = lat_range*lat_range + lon_range*lon_range;
 205
 206    //
 207    // Test whether the target is within radar range.
 208    //
 209    in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
 210    if ( in_range )
 211    {
 212      props->setBoolValue("radar/in-range", true);
 213
 214      // copy values from the AIManager
 215      double user_altitude  = manager->get_user_altitude();
 216      double user_heading   = manager->get_user_heading();
 217      double user_pitch     = manager->get_user_pitch();
 218      double user_yaw       = manager->get_user_yaw();
 219      double user_speed     = manager->get_user_speed();
 220
 221      // calculate range to target in feet and nautical miles
 222      double range_ft = sqrt( range_ft2 );
 223      range = range_ft / 6076.11549;
 224
 225      // calculate bearing to target
 226      if (pos.lat() >= user_latitude) {
 227         bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
 228         if (pos.lon() >= user_longitude) {
 229            bearing = 90.0 - bearing;
 230         } else {
 231            bearing = 270.0 + bearing;
 232         }
 233      } else {
 234         bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
 235         if (pos.lon() >= user_longitude) {
 236            bearing = 180.0 - bearing;
 237         } else {
 238            bearing = 180.0 + bearing;
 239         }
 240      }
 241
 242      // calculate look left/right to target, without yaw correction
 243      horiz_offset = bearing - user_heading;
 244      if (horiz_offset > 180.0) horiz_offset -= 360.0;
 245      if (horiz_offset < -180.0) horiz_offset += 360.0;
 246
 247      // calculate elevation to target
 248      elevation = atan2( altitude * SG_METER_TO_FEET - user_altitude, range_ft )
 249                         * SG_RADIANS_TO_DEGREES;
 250
 251      // calculate look up/down to target
 252      vert_offset = elevation + user_pitch;
 253
 254      /* this calculation needs to be fixed, but it isn't important anyway
 255      // calculate range rate
 256      double recip_bearing = bearing + 180.0;
 257      if (recip_bearing > 360.0) recip_bearing -= 360.0;
 258      double my_horiz_offset = recip_bearing - hdg;
 259      if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
 260      if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
 261      rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
 262              +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
 263 */
 264
 265      // now correct look left/right for yaw
 266      horiz_offset += user_yaw;
 267
 268      // calculate values for radar display
 269      y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 270      x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 271      rotation = hdg - user_heading;
 272      if (rotation < 0.0) rotation += 360.0;
 273
 274    }
 275
 276    return range_ft2;
 277 }
 278
 279
 280 /*
 281  * getters and Setters
 282  */
 283 void FGAIBase::_setLongitude( double longitude ) {
 284     pos.setlon(longitude);
 285 }
 286 void FGAIBase::_setLatitude ( double latitude )  {
 287     pos.setlat(latitude);
 288 }
 289
 290 double FGAIBase::_getLongitude() const {
 291     return pos.lon();
 292 }
 293 double FGAIBase::_getLatitude () const {
 294     return pos.lat();
 295 }
 296 double FGAIBase::_getRdot() const {
 297     return rdot;
 298 }
 299 double FGAIBase::_getVS_fps() const {
 300     return vs*60.0;
 301 }
 302 void FGAIBase::_setVS_fps( double _vs ) {
 303     vs = _vs/60.0;
 304 }
 305
 306 double FGAIBase::_getAltitude() const {
 307     return altitude;
 308 }
 309 void FGAIBase::_setAltitude( double _alt ) {
 310     setAltitude( _alt );
 311 }
 312
 313 bool FGAIBase::_isNight() {
 314     return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
 315 }
 316
 317 int FGAIBase::_getID() const {
 318     return (int)(this);
 319 }