src/AIModel/AICarrier.cxx

   1 // FGAICarrier - FGAIShip-derived class creates an AI aircraft carrier
   2 //
   3 // Written by David Culp, started October 2004.
   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 #ifdef HAVE_CONFIG_H
  21 #  include <config.h>
  22 #endif
  23
  24 #include <string>
  25 #include <vector>
  26
  27 #include <simgear/math/point3d.hxx>
  28 #include <simgear/math/sg_geodesy.hxx>
  29 #include <math.h>
  30 #include <Main/util.hxx>
  31 #include <Main/viewer.hxx>
  32
  33 #include "AICarrier.hxx"
  34
  35 #include "AIScenario.hxx"
  36
  37 /** Value of earth radius (meters) */
  38 #define RADIUS_M   SG_EQUATORIAL_RADIUS_M
  39
  40
  41
  42 FGAICarrier::FGAICarrier(FGAIManager* mgr) : FGAIShip(mgr) {
  43   _type_str = "carrier";
  44   _otype = otCarrier;
  45
  46
  47 }
  48
  49 FGAICarrier::~FGAICarrier() {
  50 }
  51
  52 void FGAICarrier::setWind_from_east(double fps) {
  53    wind_from_east = fps;
  54 }
  55
  56 void FGAICarrier::setWind_from_north(double fps) {
  57    wind_from_north = fps;
  58 }
  59
  60 void FGAICarrier::setMaxLat(double deg) {
  61    max_lat = fabs(deg);
  62 }
  63
  64 void FGAICarrier::setMinLat(double deg) {
  65    min_lat = fabs(deg);
  66 }
  67
  68 void FGAICarrier::setMaxLong(double deg) {
  69    max_long = fabs(deg);
  70 }
  71
  72 void FGAICarrier::setMinLong(double deg) {
  73    min_long = fabs(deg);
  74 }
  75
  76 void FGAICarrier::setSolidObjects(const list<string>& so) {
  77   solid_objects = so;
  78 }
  79
  80 void FGAICarrier::setWireObjects(const list<string>& wo) {
  81   wire_objects = wo;
  82 }
  83
  84 void FGAICarrier::setCatapultObjects(const list<string>& co) {
  85   catapult_objects = co;
  86 }
  87
  88 void FGAICarrier::setParkingPositions(const list<ParkPosition>& p) {
  89   ppositions = p;
  90 }
  91
  92 void FGAICarrier::setSign(const string& s) {
  93   sign = s;
  94 }
  95
  96 void FGAICarrier::setTACANChannelID(const string& id) {
  97    TACAN_channel_id = id;
  98 }
  99
 100 void FGAICarrier::setFlolsOffset(const Point3D& off) {
 101   flols_off = off;
 102 }
 103
 104 void FGAICarrier::getVelocityWrtEarth(sgdVec3& v, sgdVec3& omega, sgdVec3& pivot) {
 105   sgdCopyVec3(v, vel_wrt_earth );
 106   sgdCopyVec3(omega, rot_wrt_earth );
 107   sgdCopyVec3(pivot, rot_pivot_wrt_earth );
 108 }
 109
 110 void FGAICarrier::update(double dt) {
 111
 112    // For computation of rotation speeds we just use finite differences her.
 113    // That is perfectly valid since this thing is not driven by accelerations
 114    // but by just apply discrete changes at its velocity variables.
 115    double old_hdg = hdg;
 116    double old_roll = roll;
 117    double old_pitch = pitch;
 118
 119    // Update the velocity information stored in those nodes.
 120    double v_north = 0.51444444*speed*cos(hdg * SGD_DEGREES_TO_RADIANS);
 121    double v_east  = 0.51444444*speed*sin(hdg * SGD_DEGREES_TO_RADIANS);
 122
 123    double sin_lat = sin(pos.lat() * SGD_DEGREES_TO_RADIANS);
 124    double cos_lat = cos(pos.lat() * SGD_DEGREES_TO_RADIANS);
 125    double sin_lon = sin(pos.lon() * SGD_DEGREES_TO_RADIANS);
 126    double cos_lon = cos(pos.lon() * SGD_DEGREES_TO_RADIANS);
 127    double sin_roll = sin(roll * SGD_DEGREES_TO_RADIANS);
 128    double cos_roll = cos(roll * SGD_DEGREES_TO_RADIANS);
 129    double sin_pitch = sin(pitch * SGD_DEGREES_TO_RADIANS);
 130    double cos_pitch = cos(pitch * SGD_DEGREES_TO_RADIANS);
 131    double sin_hdg = sin(hdg * SGD_DEGREES_TO_RADIANS);
 132    double cos_hdg = cos(hdg * SGD_DEGREES_TO_RADIANS);
 133
 134    // Transform this back the the horizontal local frame.
 135    sgdMat3 trans;
 136
 137    // set up the transform matrix
 138    trans[0][0] =          cos_pitch*cos_hdg;
 139    trans[0][1] = sin_roll*sin_pitch*cos_hdg - cos_roll*sin_hdg;
 140    trans[0][2] = cos_roll*sin_pitch*cos_hdg + sin_roll*sin_hdg;
 141
 142    trans[1][0] =          cos_pitch*sin_hdg;
 143    trans[1][1] = sin_roll*sin_pitch*sin_hdg + cos_roll*cos_hdg;
 144    trans[1][2] = cos_roll*sin_pitch*sin_hdg - sin_roll*cos_hdg;
 145
 146    trans[2][0] =         -sin_pitch;
 147    trans[2][1] = sin_roll*cos_pitch;
 148    trans[2][2] = cos_roll*cos_pitch;
 149
 150    sgdSetVec3( vel_wrt_earth,
 151               - cos_lon*sin_lat*v_north - sin_lon*v_east,
 152               - sin_lon*sin_lat*v_north + cos_lon*v_east,
 153                 cos_lat*v_north );
 154    sgGeodToCart(pos.lat() * SGD_DEGREES_TO_RADIANS,
 155                 pos.lon() * SGD_DEGREES_TO_RADIANS,
 156                 pos.elev(), rot_pivot_wrt_earth);
 157
 158    // Now update the position and heading. This will compute new hdg and
 159    // roll values required for the rotation speed computation.
 160    FGAIShip::update(dt);
 161
 162
 163    //automatic turn into wind with a target wind of 25 kts otd
 164    if(turn_to_launch_hdg){
 165        TurnToLaunch();
 166    } else if(OutsideBox() || returning) {// check that the carrier is inside the operating box
 167        ReturnToBox();
 168    } else {                   //if(!returning
 169        TurnToBase();
 170    }  //end if
 171
 172    // Only change these values if we are able to compute them safely
 173    if (dt < DBL_MIN)
 174      sgdSetVec3( rot_wrt_earth, 0.0, 0.0, 0.0);
 175    else {
 176      // Compute the change of the euler angles.
 177      double hdg_dot = SGD_DEGREES_TO_RADIANS * (hdg-old_hdg)/dt;
 178      // Allways assume that the movement was done by the shorter way.
 179      if (hdg_dot < - SGD_DEGREES_TO_RADIANS * 180)
 180        hdg_dot += SGD_DEGREES_TO_RADIANS * 360;
 181      if (hdg_dot > SGD_DEGREES_TO_RADIANS * 180)
 182        hdg_dot -= SGD_DEGREES_TO_RADIANS * 360;
 183      double pitch_dot = SGD_DEGREES_TO_RADIANS * (pitch-old_pitch)/dt;
 184      // Allways assume that the movement was done by the shorter way.
 185      if (pitch_dot < - SGD_DEGREES_TO_RADIANS * 180)
 186        pitch_dot += SGD_DEGREES_TO_RADIANS * 360;
 187      if (pitch_dot > SGD_DEGREES_TO_RADIANS * 180)
 188        pitch_dot -= SGD_DEGREES_TO_RADIANS * 360;
 189      double roll_dot = SGD_DEGREES_TO_RADIANS * (roll-old_roll)/dt;
 190      // Allways assume that the movement was done by the shorter way.
 191      if (roll_dot < - SGD_DEGREES_TO_RADIANS * 180)
 192        roll_dot += SGD_DEGREES_TO_RADIANS * 360;
 193      if (roll_dot > SGD_DEGREES_TO_RADIANS * 180)
 194        roll_dot -= SGD_DEGREES_TO_RADIANS * 360;
 195      /*cout << "euler derivatives = "
 196           << roll_dot << " " << pitch_dot << " " << hdg_dot << endl;*/
 197
 198      // Now Compute the rotation vector in the carriers coordinate frame
 199      // originating from the euler angle changes.
 200      sgdVec3 body;
 201      body[0] = roll_dot - hdg_dot*sin_pitch;
 202      body[1] = pitch_dot*cos_roll + hdg_dot*sin_roll*cos_pitch;
 203      body[2] = -pitch_dot*sin_roll + hdg_dot*cos_roll*cos_pitch;
 204
 205      // Transform that back to the horizontal local frame.
 206      sgdVec3 hl;
 207      hl[0] = body[0]*trans[0][0] + body[1]*trans[0][1] + body[2]*trans[0][2];
 208      hl[1] = body[0]*trans[1][0] + body[1]*trans[1][1] + body[2]*trans[1][2];
 209      hl[2] = body[0]*trans[2][0] + body[1]*trans[2][1] + body[2]*trans[2][2];
 210
 211      // Now we need to project out rotation components ending in speeds in y
 212      // direction in the hoirizontal local frame.
 213      hl[1] = 0;
 214
 215      // Transform that to the earth centered frame.
 216      sgdSetVec3(rot_wrt_earth,
 217                - cos_lon*sin_lat*hl[0] - sin_lon*hl[1] - cos_lat*cos_lon*hl[2],
 218                - sin_lon*sin_lat*hl[0] + cos_lon*hl[1] - cos_lat*sin_lon*hl[2],
 219                  cos_lat*hl[0] - sin_lat*hl[2]);
 220    }
 221
 222    UpdateWind(dt);
 223    UpdateTACAN(dt);
 224    UpdateFlols(trans);
 225 } //end update
 226
 227 bool FGAICarrier::init() {
 228    if (!FGAIShip::init())
 229       return false;
 230
 231    // process the 3d model here
 232    // mark some objects solid, mark the wires ...
 233
 234    // The model should be used for altitude computations.
 235    // To avoid that every detail in a carrier 3D model will end into
 236    // the aircraft local cache, only set the HOT traversal bit on
 237    // selected objects.
 238    ssgEntity *sel = aip.getSceneGraph();
 239    // Clear the HOT traversal flag
 240    mark_nohot(sel);
 241    // Selectively set that flag again for wires/cats/solid objects.
 242    // Attach a pointer to this carrier class to those objects.
 243    mark_wires(sel, wire_objects);
 244    mark_cat(sel, catapult_objects);
 245    mark_solid(sel, solid_objects);
 246
 247    _longitude_node = fgGetNode("/position/longitude-deg", true);
 248    _latitude_node = fgGetNode("/position/latitude-deg", true);
 249    _altitude_node = fgGetNode("/position/altitude-ft", true);
 250    _dme_freq_node = fgGetNode("/instrumentation/dme/frequencies/selected-mhz", true);
 251    _surface_wind_from_deg_node =
 252               fgGetNode("/environment/config/boundary/entry[0]/wind-from-heading-deg", true);
 253    _surface_wind_speed_node =
 254               fgGetNode("/environment/config/boundary/entry[0]/wind-speed-kt", true);
 255
 256
 257    turn_to_launch_hdg = false;
 258    returning = false;
 259
 260    initialpos = pos;
 261    base_course = hdg;
 262    base_speed = speed;
 263
 264    return true;
 265 }
 266
 267 void FGAICarrier::bind() {
 268    FGAIShip::bind();
 269
 270    props->untie("velocities/true-airspeed-kt");
 271
 272    props->tie("controls/flols/source-lights",
 273                 SGRawValuePointer<int>(&source));
 274    props->tie("controls/flols/distance-m",
 275                 SGRawValuePointer<double>(&dist));
 276    props->tie("controls/flols/angle-degs",
 277                 SGRawValuePointer<double>(&angle));
 278    props->tie("controls/turn-to-launch-hdg",
 279                 SGRawValuePointer<bool>(&turn_to_launch_hdg));
 280    props->tie("controls/in-to-wind",
 281                 SGRawValuePointer<bool>(&turn_to_launch_hdg));
 282    props->tie("controls/base-course-deg",
 283                 SGRawValuePointer<double>(&base_course));
 284    props->tie("controls/base-speed-kts",
 285                 SGRawValuePointer<double>(&base_speed));
 286    props->tie("controls/start-pos-lat-deg",
 287                 SGRawValuePointer<double>(&initialpos[1]));
 288    props->tie("controls/start-pos-long-deg",
 289                 SGRawValuePointer<double>(&initialpos[0]));
 290    props->tie("velocities/speed-kts",
 291                 SGRawValuePointer<double>(&speed));
 292    props->tie("environment/surface-wind-speed-true-kts",
 293                 SGRawValuePointer<double>(&wind_speed_kts));
 294    props->tie("environment/surface-wind-from-true-degs",
 295                 SGRawValuePointer<double>(&wind_from_deg));
 296    props->tie("environment/rel-wind-from-degs",
 297                 SGRawValuePointer<double>(&rel_wind_from_deg));
 298    props->tie("environment/rel-wind-from-carrier-hdg-degs",
 299                 SGRawValuePointer<double>(&rel_wind));
 300    props->tie("environment/rel-wind-speed-kts",
 301                 SGRawValuePointer<double>(&rel_wind_speed_kts));
 302    props->tie("controls/flols/wave-off-lights",
 303                 SGRawValuePointer<bool>(&wave_off_lights));
 304
 305    props->setBoolValue("controls/flols/cut-lights", false);
 306    props->setBoolValue("controls/flols/wave-off-lights", false);
 307    props->setBoolValue("controls/flols/cond-datum-lights", true);
 308    props->setBoolValue("controls/crew", false);
 309
 310    props->setStringValue("navaids/tacan/channel-ID", TACAN_channel_id.c_str());
 311    props->setStringValue("sign", sign.c_str());
 312 }
 313
 314 void FGAICarrier::unbind() {
 315     FGAIShip::unbind();
 316
 317     props->untie("velocities/true-airspeed-kt");
 318
 319     props->untie("controls/flols/source-lights");
 320     props->untie("controls/flols/distance-m");
 321     props->untie("controls/flols/angle-degs");
 322     props->untie("controls/turn-to-launch-hdg");
 323     props->untie("velocities/speed-kts");
 324     props->untie("environment/wind-speed-true-kts");
 325     props->untie("environment/wind-from-true-degs");
 326     props->untie("environment/rel-wind-from-degs");
 327     props->untie("environment/rel-wind-speed-kts");
 328     props->untie("controls/flols/wave-off-lights");
 329
 330 }
 331
 332 bool FGAICarrier::getParkPosition(const string& id, Point3D& geodPos,
 333                                   double& hdng, sgdVec3 uvw)
 334 {
 335
 336   // FIXME: does not yet cover rotation speeds.
 337   list<ParkPosition>::iterator it = ppositions.begin();
 338   while (it != ppositions.end()) {
 339     // Take either the specified one or the first one ...
 340     if ((*it).name == id || id.empty()) {
 341       ParkPosition ppos = *it;
 342       geodPos = getGeocPosAt(ppos.offset);
 343       hdng = hdg + ppos.heading_deg;
 344       double shdng = sin(ppos.heading_deg * SGD_DEGREES_TO_RADIANS);
 345       double chdng = cos(ppos.heading_deg * SGD_DEGREES_TO_RADIANS);
 346       double speed_fps = speed*1.6878099;
 347       sgdSetVec3(uvw, chdng*speed_fps, shdng*speed_fps, 0);
 348       return true;
 349     }
 350     ++it;
 351   }
 352
 353   return false;
 354 }
 355
 356 void FGAICarrier::mark_nohot(ssgEntity* e) {
 357   if (e->isAKindOf(ssgTypeBranch())) {
 358     ssgBranch* br = (ssgBranch*)e;
 359     ssgEntity* kid;
 360     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 361       mark_nohot(kid);
 362
 363     br->clrTraversalMaskBits(SSGTRAV_HOT);
 364
 365   } else if (e->isAKindOf(ssgTypeLeaf())) {
 366
 367     e->clrTraversalMaskBits(SSGTRAV_HOT);
 368
 369   }
 370 }
 371
 372 bool FGAICarrier::mark_wires(ssgEntity* e, const list<string>& wire_objects, bool mark) {
 373   bool found = false;
 374   if (e->isAKindOf(ssgTypeBranch())) {
 375     ssgBranch* br = (ssgBranch*)e;
 376     ssgEntity* kid;
 377
 378     list<string>::const_iterator it;
 379     for (it = wire_objects.begin(); it != wire_objects.end(); ++it)
 380       mark = mark || (e->getName() && (*it) == e->getName());
 381
 382     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 383       found = mark_wires(kid, wire_objects, mark) || found;
 384
 385     if (found)
 386       br->setTraversalMaskBits(SSGTRAV_HOT);
 387
 388   } else if (e->isAKindOf(ssgTypeLeaf())) {
 389     list<string>::const_iterator it;
 390     for (it = wire_objects.begin(); it != wire_objects.end(); ++it) {
 391       if (mark || (e->getName() && (*it) == e->getName())) {
 392         e->setTraversalMaskBits(SSGTRAV_HOT);
 393         ssgBase* ud = e->getUserData();
 394         if (ud) {
 395           FGAICarrierHardware* ch = dynamic_cast<FGAICarrierHardware*>(ud);
 396           if (ch) {
 397             SG_LOG(SG_GENERAL, SG_WARN,
 398                    "AICarrier: Carrier hardware gets marked twice!\n"
 399                    "           You have propably a whole branch marked as"
 400                    " a wire which also includes other carrier hardware."
 401                    );
 402           } else {
 403             SG_LOG(SG_GENERAL, SG_ALERT,
 404                    "AICarrier: Found user data attached to a leaf node which "
 405                    "should be marked as a wire!\n    ****Skipping!****");
 406           }
 407         } else {
 408           e->setUserData( FGAICarrierHardware::newWire( this ) );
 409           ssgLeaf *l = (ssgLeaf*)e;
 410           if ( l->getNumLines() != 1 ) {
 411             SG_LOG(SG_GENERAL, SG_ALERT,
 412                    "AICarrier: Found wires not modelled with exactly one line!");
 413           }
 414           found = true;
 415         }
 416       }
 417     }
 418   }
 419   return found;
 420 }
 421
 422 bool FGAICarrier::mark_solid(ssgEntity* e, const list<string>& solid_objects, bool mark) {
 423   bool found = false;
 424   if (e->isAKindOf(ssgTypeBranch())) {
 425     ssgBranch* br = (ssgBranch*)e;
 426     ssgEntity* kid;
 427
 428     list<string>::const_iterator it;
 429     for (it = solid_objects.begin(); it != solid_objects.end(); ++it)
 430       mark = mark || (e->getName() && (*it) == e->getName());
 431
 432     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 433       found = mark_solid(kid, solid_objects, mark) || found;
 434
 435     if (found)
 436       br->setTraversalMaskBits(SSGTRAV_HOT);
 437
 438   } else if (e->isAKindOf(ssgTypeLeaf())) {
 439     list<string>::const_iterator it;
 440     for (it = solid_objects.begin(); it != solid_objects.end(); ++it) {
 441       if (mark || (e->getName() && (*it) == e->getName())) {
 442         e->setTraversalMaskBits(SSGTRAV_HOT);
 443         ssgBase* ud = e->getUserData();
 444         if (ud) {
 445           FGAICarrierHardware* ch = dynamic_cast<FGAICarrierHardware*>(ud);
 446           if (ch) {
 447             SG_LOG(SG_GENERAL, SG_WARN,
 448                    "AICarrier: Carrier hardware gets marked twice!\n"
 449                    "           You have propably a whole branch marked solid"
 450                    " which also includes other carrier hardware."
 451                    );
 452           } else {
 453             SG_LOG(SG_GENERAL, SG_ALERT,
 454                    "AICarrier: Found user data attached to a leaf node which "
 455                    "should be marked solid!\n    ****Skipping!****");
 456           }
 457         } else {
 458           e->setUserData( FGAICarrierHardware::newSolid( this ) );
 459           found = true;
 460         }
 461       }
 462     }
 463   }
 464   return found;
 465 }
 466
 467 bool FGAICarrier::mark_cat(ssgEntity* e, const list<string>& cat_objects, bool mark) {
 468   bool found = false;
 469   if (e->isAKindOf(ssgTypeBranch())) {
 470     ssgBranch* br = (ssgBranch*)e;
 471     ssgEntity* kid;
 472
 473     list<string>::const_iterator it;
 474     for (it = cat_objects.begin(); it != cat_objects.end(); ++it)
 475       mark = mark || (e->getName() && (*it) == e->getName());
 476
 477     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 478       found = mark_cat(kid, cat_objects, mark) || found;
 479
 480     if (found)
 481       br->setTraversalMaskBits(SSGTRAV_HOT);
 482
 483   } else if (e->isAKindOf(ssgTypeLeaf())) {
 484     list<string>::const_iterator it;
 485     for (it = cat_objects.begin(); it != cat_objects.end(); ++it) {
 486       if (mark || (e->getName() && (*it) == e->getName())) {
 487         e->setTraversalMaskBits(SSGTRAV_HOT);
 488         ssgBase* ud = e->getUserData();
 489         if (ud) {
 490           FGAICarrierHardware* ch = dynamic_cast<FGAICarrierHardware*>(ud);
 491           if (ch) {
 492             SG_LOG(SG_GENERAL, SG_WARN,
 493                    "AICarrier: Carrier hardware gets marked twice!\n"
 494                    "You have probably a whole branch marked as"
 495                    "a catapult which also includes other carrier hardware."
 496                     );
 497           } else {
 498             SG_LOG(SG_GENERAL, SG_ALERT,
 499                    "AICarrier: Found user data attached to a leaf node which "
 500                    "should be marked as a catapult!\n    ****Skipping!****");
 501           }
 502         } else {
 503           e->setUserData( FGAICarrierHardware::newCatapult( this ) );
 504           ssgLeaf *l = (ssgLeaf*)e;
 505           if ( l->getNumLines() != 1 ) {
 506             SG_LOG(SG_GENERAL, SG_ALERT,
 507                    "AICarrier: Found a cat not modelled with exactly "
 508                    "one line!");
 509           } else {
 510             // Now some special code to make sure the cat points in the right
 511             // direction. The 0 index must be the backward end, the 1 index
 512             // the forward end.
 513             // Forward is positive x-direction in our 3D model, also the model
 514             // as such is flattened when it is loaded, so we do not need to
 515             // care for transforms ...
 516             short v[2];
 517             l->getLine(0, v, v+1 );
 518             sgVec3 ends[2];
 519             for (int k=0; k<2; ++k)
 520               sgCopyVec3( ends[k], l->getVertex( v[k] ) );
 521
 522             // When the 1 end is behind the 0 end, swap the coordinates.
 523             if (ends[0][0] < ends[1][0]) {
 524               sgCopyVec3( l->getVertex( v[0] ), ends[1] );
 525               sgCopyVec3( l->getVertex( v[1] ), ends[0] );
 526             }
 527
 528             found = true;
 529           }
 530         }
 531       }
 532     }
 533   }
 534   return found;
 535 }
 536
 537 void FGAICarrier::UpdateFlols(const sgdMat3& trans) {
 538
 539     float in[3];
 540     float out[3];
 541
 542     double flolsXYZ[3], eyeXYZ[3];
 543     double lat, lon, alt;
 544     Point3D eyepos;
 545     Point3D flolspos;
 546
 547 /*    cout << "x_offset " << flols_x_offset
 548           << " y_offset " << flols_y_offset
 549           << " z_offset " << flols_z_offset << endl;
 550
 551      cout << "roll " << roll
 552           << " heading " << hdg
 553           << " pitch " << pitch << endl;
 554
 555      cout << "carrier lon " << pos[0]
 556           << " lat " <<  pos[1]
 557           << " alt " << pos[2] << endl;*/
 558
 559 // set the Flols intitial position to the carrier position
 560
 561   flolspos = pos;
 562
 563 /*  cout << "flols lon " << flolspos[0]
 564           << " lat " <<  flolspos[1]
 565           << " alt " << flolspos[2] << endl;*/
 566
 567 // set the offsets in metres
 568
 569 /*  cout << "flols_x_offset " << flols_x_offset << endl
 570        << "flols_y_offset " << flols_y_offset << endl
 571        << "flols_z_offset " << flols_z_offset << endl;*/
 572
 573   in[0] = flols_off.x();
 574   in[1] = flols_off.y();
 575   in[2] = flols_off.z();
 576
 577 // multiply the input and transform matrices
 578
 579    out[0] = in[0] * trans[0][0] + in[1] * trans[0][1] + in[2] * trans[0][2];
 580    out[1] = in[0] * trans[1][0] + in[1] * trans[1][1] + in[2] * trans[1][2];
 581    out[2] = in[0] * trans[2][0] + in[1] * trans[2][1] + in[2] * trans[2][2];
 582
 583 // convert meters to ft to degrees of latitude
 584    out[0] = (out[0] * 3.28083989501) /(366468.96 - 3717.12 * cos(flolspos[0] * SG_DEGREES_TO_RADIANS));
 585
 586 // convert meters to ft to degrees of longitude
 587    out[1] = (out[1] * 3.28083989501)/(365228.16 * cos(flolspos[1] * SG_DEGREES_TO_RADIANS));
 588
 589 //print out the result
 590 /*   cout  << "lat adjust deg" << out[0]
 591         << " lon adjust deg " << out[1]
 592         << " alt adjust m " << out[2]  << endl;*/
 593
 594 // adjust Flols position
 595    flolspos[0] += out[0];
 596    flolspos[1] += out[1];
 597    flolspos[2] += out[2];
 598
 599 // convert flols position to cartesian co-ordinates
 600
 601   sgGeodToCart(flolspos[1] * SG_DEGREES_TO_RADIANS,
 602                flolspos[0] * SG_DEGREES_TO_RADIANS,
 603                flolspos[2] , flolsXYZ );
 604
 605
 606 /*  cout << "flols X " << flolsXYZ[0]
 607        << " Y " <<  flolsXYZ[1]
 608        << " Z " << flolsXYZ[2] << endl;
 609
 610 // check the conversion
 611
 612   sgCartToGeod(flolsXYZ, &lat, &lon, &alt);
 613
 614   cout << "flols check lon " << lon
 615         << " lat " << lat
 616         << " alt " << alt << endl;      */
 617
 618 //get the current position of the pilot's eyepoint (cartesian cordinates)
 619
 620   sgdCopyVec3( eyeXYZ, globals->get_current_view()->get_absolute_view_pos() );
 621
 622  /* cout  << "Eye_X "  << eyeXYZ[0]
 623         << " Eye_Y " << eyeXYZ[1]
 624         << " Eye_Z " << eyeXYZ[2]  << endl; */
 625
 626   sgCartToGeod(eyeXYZ, &lat, &lon, &alt);
 627
 628   eyepos[0] = lon * SG_RADIANS_TO_DEGREES;
 629   eyepos[1] = lat * SG_RADIANS_TO_DEGREES;
 630   eyepos[2] = alt;
 631
 632 /*  cout << "eye lon " << eyepos[0]
 633         << " eye lat " << eyepos[1]
 634         << " eye alt " << eyepos[2] << endl; */
 635
 636 //calculate the ditance from eye to flols
 637
 638   dist = sgdDistanceVec3( flolsXYZ, eyeXYZ );
 639
 640 //apply an index error
 641
 642   dist -= 100;
 643
 644   //cout << "distance " << dist << endl;
 645
 646   if ( dist < 5000 ) {
 647        // calculate height above FLOLS
 648        double y = eyepos[2] - flolspos[2];
 649
 650        // calculate the angle from the flols to eye
 651        // above the horizontal
 652        // double angle;
 653
 654        if ( dist != 0 ) {
 655            angle = asin( y / dist );
 656          } else {
 657            angle = 0.0;
 658          }
 659
 660        angle *= SG_RADIANS_TO_DEGREES;
 661
 662
 663   // cout << " height " << y << " angle " << angle ;
 664
 665 // set the value of source
 666
 667        if ( angle <= 4.35 && angle > 4.01 )
 668          { source = 1; }
 669          else if ( angle <= 4.01 && angle > 3.670 )
 670          { source = 2; }
 671          else if ( angle <= 3.670 && angle > 3.330 )
 672          { source = 3; }
 673          else if ( angle <= 3.330 && angle > 2.990 )
 674          { source = 4; }
 675          else if ( angle <= 2.990 && angle > 2.650 )
 676          { source = 5; }
 677          else if ( angle <= 2.650  )
 678          { source = 6; }
 679          else
 680          { source = 0; }
 681
 682 //         cout << " source " << source << endl;
 683
 684    }
 685 } // end updateflols
 686
 687 // find relative wind
 688
 689
 690
 691
 692 void FGAICarrier::UpdateWind( double dt) {
 693
 694     double recip;
 695
 696     //calculate the reciprocal hdg
 697
 698     if (hdg >= 180){
 699         recip = hdg - 180;
 700     }
 701     else{
 702         recip = hdg + 180;
 703     }
 704
 705     //cout <<" heading: " << hdg << "recip: " << recip << endl;
 706
 707     //get the surface wind speed and direction
 708     wind_from_deg = _surface_wind_from_deg_node->getDoubleValue();
 709     wind_speed_kts  = _surface_wind_speed_node->getDoubleValue();
 710
 711     //calculate the surface wind speed north and east in kts
 712     double wind_speed_from_north_kts = cos( wind_from_deg / SGD_RADIANS_TO_DEGREES )* wind_speed_kts ;
 713     double wind_speed_from_east_kts  = sin( wind_from_deg / SGD_RADIANS_TO_DEGREES )* wind_speed_kts ;
 714
 715     //calculate the carrier speed north and east in kts
 716     double speed_north_kts = cos( hdg / SGD_RADIANS_TO_DEGREES )* speed ;
 717     double speed_east_kts  = sin( hdg / SGD_RADIANS_TO_DEGREES )* speed ;
 718
 719     //calculate the relative wind speed north and east in kts
 720     double rel_wind_speed_from_east_kts = wind_speed_from_east_kts + speed_east_kts;
 721     double rel_wind_speed_from_north_kts = wind_speed_from_north_kts + speed_north_kts;
 722
 723     //combine relative speeds north and east to get relative windspeed in kts
 724     rel_wind_speed_kts = sqrt((rel_wind_speed_from_east_kts * rel_wind_speed_from_east_kts)
 725     + (rel_wind_speed_from_north_kts * rel_wind_speed_from_north_kts));
 726
 727     //calculate the relative wind direction
 728     rel_wind_from_deg = atan(rel_wind_speed_from_east_kts/rel_wind_speed_from_north_kts)
 729                             * SG_RADIANS_TO_DEGREES;
 730
 731     // rationalise the output
 732     if (rel_wind_speed_from_north_kts <= 0){
 733         rel_wind_from_deg = 180 + rel_wind_from_deg;
 734     }
 735     else{
 736         if(rel_wind_speed_from_east_kts <= 0){
 737             rel_wind_from_deg = 360 + rel_wind_from_deg;
 738         }
 739     }
 740
 741     //calculate rel wind
 742     rel_wind = rel_wind_from_deg - hdg  ;
 743     if (rel_wind > 180) rel_wind -= 360;
 744
 745     //switch the wave-off lights
 746     if (InToWind()){
 747        wave_off_lights = false;
 748     }else{
 749        wave_off_lights = true;
 750     }
 751
 752     // cout << "rel wind: " << rel_wind << endl;
 753
 754 }// end update wind
 755
 756 void FGAICarrier::TurnToLaunch(){
 757
 758      //calculate tgt speed
 759        double tgt_speed = 25 - wind_speed_kts;
 760        if (tgt_speed < 10) tgt_speed = 10;
 761
 762      //turn the carrier
 763        FGAIShip::TurnTo(wind_from_deg);
 764        FGAIShip::AccelTo(tgt_speed);
 765
 766
 767
 768 }  // end turn to launch
 769
 770 void FGAICarrier::TurnToBase(){
 771
 772     //turn the carrier
 773        FGAIShip::TurnTo(base_course);
 774        FGAIShip::AccelTo(base_speed);
 775
 776 } //  end turn to base
 777
 778 void FGAICarrier::ReturnToBox(){
 779     double course, distance;
 780
 781     //get the carrier position
 782     carrierpos = pos;
 783
 784     //cout << "lat: " << carrierpos[1] << " lon: " << carrierpos[0] << endl;
 785
 786     //calculate the bearing and range of the initial position from the carrier
 787     geo_inverse_wgs_84(carrierpos[2],
 788                        carrierpos[1],
 789                        carrierpos[0],
 790                        initialpos[1],
 791                        initialpos[0],
 792                        &course, &az2, &distance);
 793
 794     distance *= SG_METER_TO_NM;
 795
 796     //cout << "return course: " << course << " distance: " << distance << endl;
 797     //turn the carrier
 798        FGAIShip::TurnTo(course);
 799        FGAIShip::AccelTo(base_speed);
 800        if (distance >= 1 ){
 801            returning = true;
 802        }else{
 803            returning = false;
 804        }
 805
 806 } //  end turn to base
 807
 808
 809 void FGAICarrier::UpdateTACAN(double dt){ //update the TACAN
 810
 811   //cout << "TACAN: " << TACAN_channel_id << endl;
 812
 813   double max_range_nm = 100; //nm
 814
 815   double dme_freq = _dme_freq_node->getDoubleValue();
 816
 817   //cout << "dme_freq: " << dme_freq << endl;
 818
 819   if (TACAN_channel_id == "017X"){
 820
 821       //get the aircraft position
 822       double longitude_deg = _longitude_node->getDoubleValue();
 823       double latitude_deg  = _latitude_node->getDoubleValue();
 824       double altitude_m    = _altitude_node->getDoubleValue() * SG_FEET_TO_METER;
 825
 826       //get the carrier position
 827       carrierpos = pos;
 828
 829       //cout << "lat: " << carrierpos[1] << " lon: " << carrierpos[0] << endl;
 830
 831       //calculate the bearing and range of the carrier from the aircraft
 832       geo_inverse_wgs_84(altitude_m,
 833                          latitude_deg,
 834                          longitude_deg,
 835                          carrierpos[1],
 836                          carrierpos[0],
 837                          &bearing, &az2, &range);
 838
 839       range *= SG_METER_TO_NM;
 840
 841
 842
 843        double aircraft_horizon_nm = Horizon(altitude_m) * SG_METER_TO_NM;
 844        double carrier_horizon_nm = Horizon(50) * SG_METER_TO_NM;
 845        double horizon_nm = aircraft_horizon_nm + carrier_horizon_nm;
 846
 847        if (range > horizon_nm || range > max_range_nm) {
 848            range = 0;
 849            bearing = 0 ;
 850         }
 851     /*cout << "bearing: " << bearing << " range: " << range << " altitude: " << altitude_m
 852       <<  " horizon: " << horizon_nm << endl; */
 853   } else {
 854       range = 0;
 855       bearing = 0 ;
 856   }  // end if
 857
 858 }// end update TACAN
 859
 860 bool FGAICarrier::OutsideBox(){ //returns true if the carrier is outside operating box
 861
 862     if ( max_lat == 0 && min_lat == 0 && max_long == 0 && min_long == 0) {
 863        SG_LOG(SG_GENERAL, SG_BULK,"AICarrier: No Operating Box defined" );
 864        return false;
 865     }
 866
 867     if (initialpos[1] >= 0){//northern hemisphere
 868         if (pos[1] >= initialpos[1] + max_lat) {return true;}
 869         else if (pos[1] <= initialpos[1] - min_lat) {return true;}
 870     }else{                  //southern hemisphere
 871         if (pos[1] <= initialpos[1] - max_lat) {return true;}
 872         else if (pos[1] >= initialpos[1] + min_lat) {return true;}
 873     }
 874
 875     if (initialpos[0] >=0) {//eastern hemisphere
 876         if (pos[0] >= initialpos[0] + max_long) {return true;}
 877         else if (pos[0] <= initialpos[0] - min_long) {return true;}
 878     }else{                 //western hemisphere
 879         if (pos[0] <= initialpos[0] - max_long) {return true;}
 880         else if (pos[0] >= initialpos[0] + min_long) {return true;}
 881     }
 882
 883     SG_LOG(SG_GENERAL, SG_BULK,"AICarrier: Inside Operating Box" );
 884
 885     return false;
 886
 887 } // end OutsideBox
 888
 889 // return the distance to the horizon, given the altitude and the radius of the earth
 890 float FGAICarrier::Horizon(float h) { return RADIUS_M * acos(RADIUS_M / (RADIUS_M + h)); }
 891
 892 bool FGAICarrier::InToWind(){
 893
 894     // test
 895     if ( fabs(rel_wind) < 5 ) return true;
 896     return false;
 897
 898 } //end InToWind
 899 int FGAICarrierHardware::unique_id = 1;