src/AIModel/AIEscort.cxx

   1 // FGAIEscort - FGAIShip-derived class creates an AI Ground Vehicle
   2 // by adding a ground following utility
   3 //
   4 // Written by Vivian Meazza, started August 2009.
   5 // - vivian.meazza at lineone.net
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <algorithm>
  26 #include <string>
  27 #include <vector>
  28
  29 #include <simgear/sg_inlines.h>
  30 #include <simgear/math/sg_geodesy.hxx>
  31 #include <simgear/math/sg_random.h>
  32
  33 #include <math.h>
  34 #include <Main/util.hxx>
  35 #include <Viewer/viewer.hxx>
  36
  37 #include <Scenery/scenery.hxx>
  38
  39 #include "AIEscort.hxx"
  40
  41 using std::string;
  42
  43 FGAIEscort::FGAIEscort() :
  44 FGAIShip(otEscort),
  45
  46 _relbrg (0),
  47 _parent_speed(0),
  48 _interval(0),
  49 _stn_truebrg(0),
  50 _stn_height(0),
  51 _stn_speed(0),
  52 _stn_angle_limit(0),
  53 _stn_limit(0),
  54 _max_speed(0),
  55 _MPControl(false),
  56 _patrol(false),
  57 _stn_deg_true(false)
  58
  59 {
  60     invisible = false;
  61 }
  62
  63 FGAIEscort::~FGAIEscort() {}
  64
  65 void FGAIEscort::readFromScenario(SGPropertyNode* scFileNode) {
  66     if (!scFileNode)
  67         return;
  68
  69     FGAIShip::readFromScenario(scFileNode);
  70
  71     setName(scFileNode->getStringValue("name", "Escort"));
  72     setSMPath(scFileNode->getStringValue("submodel-path", ""));
  73     setStnRange(scFileNode->getDoubleValue("station/range-nm", 1));
  74     setStnBrg(scFileNode->getDoubleValue("station/brg-deg", 0.0));
  75     setStnLimit(scFileNode->getDoubleValue("station/range-limit-nm", 0.2));
  76     setStnAngleLimit(scFileNode->getDoubleValue("station/angle-limit-deg", 15.0));
  77     setStnSpeed(scFileNode->getDoubleValue("station/speed-kts", 2.5));
  78     setStnPatrol(scFileNode->getBoolValue("station/patrol", false));
  79     setStnHtFt(scFileNode->getDoubleValue("station/height-ft", 0.0));
  80     setStnDegTrue(scFileNode->getBoolValue("station/deg-true", false));
  81     setParentName(scFileNode->getStringValue("station/parent", ""));
  82     setMaxSpeed(scFileNode->getDoubleValue("max-speed-kts", 30.0));
  83     setUpdateInterval(scFileNode->getDoubleValue("update-interval-sec", 10.0));
  84     setCallSign(scFileNode->getStringValue("callsign", ""));
  85
  86     if(_patrol)
  87         sg_srandom_time();
  88
  89 }
  90
  91 void FGAIEscort::bind() {
  92     FGAIShip::bind();
  93
  94     tie("station/rel-bearing-deg",
  95         SGRawValuePointer<double>(&_stn_relbrg));
  96     tie("station/true-bearing-deg",
  97         SGRawValuePointer<double>(&_stn_truebrg));
  98     tie("station/range-nm",
  99         SGRawValuePointer<double>(&_stn_range));
 100     tie("station/range-limit-nm",
 101         SGRawValuePointer<double>(&_stn_limit));
 102     tie("station/angle-limit-deg",
 103         SGRawValuePointer<double>(&_stn_angle_limit));
 104     tie("station/speed-kts",
 105         SGRawValuePointer<double>(&_stn_speed));
 106     tie("station/height-ft",
 107         SGRawValuePointer<double>(&_stn_height));
 108     tie("controls/update-interval-sec",
 109         SGRawValuePointer<double>(&_interval));
 110     tie("controls/parent-mp-control",
 111         SGRawValuePointer<bool>(&_MPControl));
 112     tie("station/target-range-nm",
 113         SGRawValuePointer<double>(&_tgtrange));
 114     tie("station/target-brg-deg-t",
 115         SGRawValuePointer<double>(&_tgtbrg));
 116     tie("station/patrol",
 117         SGRawValuePointer<bool>(&_patrol));
 118 }
 119
 120 bool FGAIEscort::init(bool search_in_AI_path) {
 121     if (!FGAIShip::init(search_in_AI_path))
 122         return false;
 123     reinit();
 124     return true;
 125 }
 126
 127 void FGAIEscort::reinit() {
 128     invisible = false;
 129     no_roll = false;
 130
 131     props->setStringValue("controls/parent-name", _parent.c_str());
 132
 133     if (setParentNode()){
 134         setParent();
 135         pos = _tgtpos;
 136         speed = _parent_speed;
 137         hdg = _parent_hdg;
 138     }
 139
 140     FGAIShip::reinit();
 141 }
 142
 143 void FGAIEscort::update(double dt) {
 144     FGAIShip::update(dt);
 145
 146     RunEscort(dt);
 147 }
 148
 149 void FGAIEscort::setStnRange(double r) {
 150     _stn_range = r;
 151 }
 152
 153 void FGAIEscort::setStnBrg(double b) {
 154     _stn_brg = b;
 155 }
 156
 157 void FGAIEscort::setStnLimit(double l) {
 158     _stn_limit = l;
 159 }
 160
 161 void FGAIEscort::setStnAngleLimit(double al) {
 162     _stn_angle_limit = al;
 163 }
 164
 165 void FGAIEscort::setStnSpeed(double s) {
 166     _stn_speed = s;
 167 }
 168
 169 void FGAIEscort::setStnHtFt(double h) {
 170     _stn_height = h;
 171 }
 172
 173 void FGAIEscort::setStnDegTrue(bool t) {
 174     _stn_deg_true = t;
 175 }
 176
 177 void FGAIEscort::setMaxSpeed(double m) {
 178     _max_speed = m;
 179 }
 180
 181 void FGAIEscort::setUpdateInterval(double i) {
 182     _interval = i;
 183 }
 184
 185 void FGAIEscort::setStnPatrol(bool p) {
 186     _patrol = p;
 187 }
 188
 189 bool FGAIEscort::getGroundElev(SGGeod inpos) {
 190
 191     double height_m ;
 192
 193     if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(inpos, 3000), height_m, &_material,0)){
 194         _ht_agl_ft = inpos.getElevationFt() - height_m * SG_METER_TO_FEET;
 195
 196         if (_material) {
 197             const vector<string>& names = _material->get_names();
 198
 199             _solid = _material->get_solid();
 200
 201             if (!names.empty())
 202                 props->setStringValue("material/name", names[0].c_str());
 203             else
 204                 props->setStringValue("material/name", "");
 205
 206             //cout << "material " << names[0].c_str()
 207             //    << " _elevation_m " << _elevation_m
 208             //    << " solid " << _solid
 209             //    << " load " << _load_resistance
 210             //    << " frictionFactor " << _frictionFactor
 211             //    << endl;
 212
 213         }
 214
 215         return true;
 216     } else {
 217         return false;
 218     }
 219
 220 }
 221
 222 void FGAIEscort::setParent()
 223 {
 224     double lat = _selected_ac->getDoubleValue("position/latitude-deg");
 225     double lon = _selected_ac->getDoubleValue("position/longitude-deg");
 226     double elevation = _selected_ac->getDoubleValue("position/altitude-ft");
 227     _MPControl = _selected_ac->getBoolValue("controls/mp-control");
 228
 229     _selectedpos.setLatitudeDeg(lat);
 230     _selectedpos.setLongitudeDeg(lon);
 231     _selectedpos.setElevationFt(elevation);
 232
 233     _parent_speed    = _selected_ac->getDoubleValue("velocities/speed-kts");
 234     _parent_hdg      = _selected_ac->getDoubleValue("orientation/true-heading-deg");
 235
 236     if(!_stn_deg_true){
 237         _stn_truebrg = calcTrueBearingDeg(_stn_brg, _parent_hdg);
 238         _stn_relbrg = _stn_brg;
 239         //cout << _name <<" set rel"<<endl;
 240     } else {
 241         _stn_truebrg = _stn_brg;
 242         _stn_relbrg = calcRelBearingDeg(_stn_brg, _parent_hdg);
 243         //cout << _name << " set true"<<endl;
 244     }
 245
 246     double course2;
 247
 248     SGGeodesy::direct( _selectedpos, _stn_truebrg, _stn_range * SG_NM_TO_METER,
 249         _tgtpos, course2);
 250
 251     _tgtpos.setElevationFt(_stn_height);
 252
 253     calcRangeBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(),
 254         _tgtpos.getLatitudeDeg(), _tgtpos.getLongitudeDeg(), _tgtrange, _tgtbrg);
 255
 256     _relbrg = calcRelBearingDeg(_tgtbrg, hdg);
 257
 258 }
 259
 260 void FGAIEscort::calcRangeBearing(double lat, double lon, double lat2, double lon2,
 261                                   double &range, double &bearing) const
 262 {
 263     // calculate the bearing and range of the second pos from the first
 264     double az2, distance;
 265     geo_inverse_wgs_84(lat, lon, lat2, lon2, &bearing, &az2, &distance);
 266     range = distance * SG_METER_TO_NM;
 267 }
 268
 269 double FGAIEscort::calcTrueBearingDeg(double bearing, double heading)
 270 {
 271     double angle = bearing + heading;
 272     SG_NORMALIZE_RANGE(angle, 0.0, 360.0);
 273     return angle;
 274 }
 275
 276 SGVec3d FGAIEscort::getCartHitchPosAt(const SGVec3d& _off) const {
 277     double hdg = _selected_ac->getDoubleValue("orientation/true-heading-deg");
 278     double pitch = _selected_ac->getDoubleValue("orientation/pitch-deg");
 279     double roll = _selected_ac->getDoubleValue("orientation/roll-deg");
 280
 281     // Transform that one to the horizontal local coordinate system.
 282     SGQuatd hlTrans = SGQuatd::fromLonLat(_selectedpos);
 283
 284     // and postrotate the orientation of the AIModel wrt the horizontal
 285     // local frame
 286     hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
 287
 288     // The offset converted to the usual body fixed coordinate system
 289     // rotated to the earth fiexed coordinates axis
 290     SGVec3d off = hlTrans.backTransform(_off);
 291
 292     // Add the position offset of the AIModel to gain the earth centered position
 293     SGVec3d cartPos = SGVec3d::fromGeod(_selectedpos);
 294
 295     return cartPos + off;
 296 }
 297
 298
 299 void FGAIEscort::setStationSpeed(){
 300
 301     double speed = 0;
 302     double angle = 0;
 303
 304     // these are the AI rules for the manoeuvring of escorts
 305
 306     if (_MPControl && _tgtrange > 4 * _stn_limit){
 307         SG_LOG(SG_AI, SG_ALERT, "AIEscort: " << _name
 308             << " re-aligning to MP pos");
 309         pos = _tgtpos;
 310         speed = 0;
 311         angle = 0;
 312     }else if ((_relbrg < -90 || _relbrg > 90) && _tgtrange > _stn_limit ){
 313         angle =_relbrg;
 314
 315         if(_tgtrange > 4 * _stn_limit)
 316             speed = 4 * -_stn_speed;
 317         else
 318             speed = -_stn_speed;
 319
 320     }else if ((_relbrg >= -90 || _relbrg <= 90) && _tgtrange > _stn_limit){
 321         angle = _relbrg;
 322
 323         if(_tgtrange > 4 * _stn_limit)
 324             speed = 4 * _stn_speed;
 325         else
 326             speed = _stn_speed;
 327
 328     } else {
 329
 330         if(_patrol){
 331             angle = 15 * sg_random();
 332             speed =  5 * sg_random();
 333         } else {
 334             angle = 0;
 335             speed = 0;
 336         }
 337
 338     }
 339
 340     double station_speed = _parent_speed + speed;
 341
 342     SG_CLAMP_RANGE(station_speed, 5.0, _max_speed);
 343     SG_CLAMP_RANGE(angle, -_stn_angle_limit, _stn_angle_limit);
 344
 345     AccelTo(station_speed);
 346     TurnTo(_parent_hdg + angle);
 347     ClimbTo(_stn_height);
 348
 349 }
 350
 351 void FGAIEscort::RunEscort(double dt){
 352
 353     _dt_count += dt;
 354
 355
 356
 357     ///////////////////////////////////////////////////////////////////////////
 358     // Check execution time (currently once every 0.05 sec or 20 fps)
 359     // Add a bit of randomization to prevent the execution of all flight plans
 360     // in synchrony, which can add significant periodic framerate flutter.
 361     // Randomization removed to get better appearance
 362     ///////////////////////////////////////////////////////////////////////////
 363
 364     //cout << "_start_sec " << _start_sec << " time_sec " << time_sec << endl;
 365     if (_dt_count < _next_run)
 366         return;
 367     _next_run = _interval /*+ (0.015 * sg_random())*/;
 368
 369     if(_parent == ""){
 370         return;
 371     }
 372
 373     setParent();
 374     setStationSpeed();
 375
 376     _dt_count = 0;
 377
 378 }
 379
 380 // end AIEscort