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
  36 FGAICarrier::FGAICarrier(FGAIManager* mgr) : FGAIShip(mgr) {
  37 }
  38
  39 FGAICarrier::~FGAICarrier() {
  40 }
  41
  42 void FGAICarrier::setSolidObjects(const list<string>& so) {
  43   solid_objects = so;
  44 }
  45
  46 void FGAICarrier::setWireObjects(const list<string>& wo) {
  47   wire_objects = wo;
  48 }
  49
  50 void FGAICarrier::setCatapultObjects(const list<string>& co) {
  51   catapult_objects = co;
  52 }
  53
  54 void FGAICarrier::getVelocityWrtEarth(sgVec3 v) {
  55   sgCopyVec3(v, vel_wrt_earth );
  56 }
  57
  58 void FGAICarrier::update(double dt) {
  59    UpdateFlols(dt);
  60    FGAIShip::update(dt);
  61
  62    // Update the velocity information stored in those nodes.
  63    double v_north = 0.51444444*speed*cos(hdg * SGD_DEGREES_TO_RADIANS);
  64    double v_east  = 0.51444444*speed*sin(hdg * SGD_DEGREES_TO_RADIANS);
  65
  66    double sin_lat = sin(pos.lat() * SGD_DEGREES_TO_RADIANS);
  67    double cos_lat = cos(pos.lat() * SGD_DEGREES_TO_RADIANS);
  68    double sin_lon = sin(pos.lon() * SGD_DEGREES_TO_RADIANS);
  69    double cos_lon = cos(pos.lon() * SGD_DEGREES_TO_RADIANS);
  70    sgSetVec3( vel_wrt_earth,
  71               - cos_lon*sin_lat*v_north - sin_lon*v_east,
  72               - sin_lon*sin_lat*v_north + cos_lon*v_east,
  73                 cos_lat*v_north );
  74
  75 }
  76
  77 bool FGAICarrier::init() {
  78    if (!FGAIShip::init())
  79       return false;
  80
  81    // process the 3d model here
  82    // mark some objects solid, mark the wires ...
  83
  84    // The model should be used for altitude computations.
  85    // To avoid that every detail in a carrier 3D model will end into
  86    // the aircraft local cache, only set the HOT traversal bit on
  87    // selected objects.
  88    ssgEntity *sel = aip.getSceneGraph();
  89    // Clear the HOT traversal flag
  90    mark_nohot(sel);
  91    // Selectively set that flag again for wires/cats/solid objects.
  92    // Attach a pointer to this carrier class to those objects.
  93    mark_wires(sel, wire_objects);
  94    mark_cat(sel, catapult_objects);
  95    mark_solid(sel, solid_objects, false);
  96
  97    return true;
  98 }
  99 void FGAICarrier::bind() {
 100    FGAIBase::bind();
 101
 102    props->tie("controls/flols/source-lights",
 103                 SGRawValuePointer<int>(&source));
 104    props->tie("controls/flols/distance-m",
 105                 SGRawValuePointer<double>(&dist));
 106    props->setBoolValue("controls/flols/cut-lights", false);
 107    props->setBoolValue("controls/flols/wave-off-lights", false);
 108    props->setBoolValue("controls/flols/cond-datum-lights", true);
 109    }
 110
 111 void FGAICarrier::unbind() {
 112     FGAIBase::unbind();
 113     props->untie("controls/flols/source-lights");
 114 }
 115
 116 void FGAICarrier::mark_nohot(ssgEntity* e) {
 117   if (e->isAKindOf(ssgTypeBranch())) {
 118     ssgBranch* br = (ssgBranch*)e;
 119     ssgEntity* kid;
 120     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 121       mark_nohot(kid);
 122
 123     br->clrTraversalMaskBits(SSGTRAV_HOT);
 124
 125   } else if (e->isAKindOf(ssgTypeLeaf())) {
 126
 127     e->clrTraversalMaskBits(SSGTRAV_HOT);
 128
 129   }
 130 }
 131
 132 bool FGAICarrier::mark_wires(ssgEntity* e, const list<string>& wire_objects) {
 133   bool found = false;
 134   if (e->isAKindOf(ssgTypeBranch())) {
 135
 136     ssgBranch* br = (ssgBranch*)e;
 137     ssgEntity* kid;
 138     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 139       found = mark_wires(kid, wire_objects) || found;
 140
 141     if (found)
 142       br->setTraversalMaskBits(SSGTRAV_HOT);
 143
 144   } else if (e->isAKindOf(ssgTypeLeaf())) {
 145     list<string>::const_iterator it;
 146     for (it = wire_objects.begin(); it != wire_objects.end(); ++it) {
 147       if (e->getName() && (*it) == e->getName()) {
 148         e->setTraversalMaskBits(SSGTRAV_HOT);
 149         e->setUserData( FGAICarrierHardware::newWire( this ) );
 150         ssgLeaf *l = (ssgLeaf*)e;
 151         if ( l->getNumLines() != 1 ) {
 152           SG_LOG(SG_GENERAL, SG_ALERT,
 153                  "AICarrier: Found wires not modelled with exactly one line!");
 154         }
 155
 156         found = true;
 157       }
 158     }
 159   }
 160   return found;
 161 }
 162
 163 bool FGAICarrier::mark_solid(ssgEntity* e, const list<string>& solid_objects, bool mark) {
 164   bool found = false;
 165   if (e->isAKindOf(ssgTypeBranch())) {
 166     ssgBranch* br = (ssgBranch*)e;
 167     ssgEntity* kid;
 168
 169     list<string>::const_iterator it;
 170     for (it = solid_objects.begin(); it != solid_objects.end(); ++it)
 171       mark = mark || e->getName() && (*it) == e->getName();
 172
 173     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 174       found = mark_solid(kid, solid_objects, mark) || found;
 175
 176     if (found)
 177       br->setTraversalMaskBits(SSGTRAV_HOT);
 178
 179   } else if (e->isAKindOf(ssgTypeLeaf())) {
 180     list<string>::const_iterator it;
 181     for (it = solid_objects.begin(); it != solid_objects.end(); ++it) {
 182       if (mark || (e->getName() && (*it) == e->getName())) {
 183         e->setTraversalMaskBits(SSGTRAV_HOT);
 184         e->setUserData( FGAICarrierHardware::newSolid( this ) );
 185         found = true;
 186       }
 187     }
 188   }
 189   return found;
 190 }
 191
 192 bool FGAICarrier::mark_cat(ssgEntity* e, const list<string>& cat_objects) {
 193   bool found = false;
 194   if (e->isAKindOf(ssgTypeBranch())) {
 195     ssgBranch* br = (ssgBranch*)e;
 196     ssgEntity* kid;
 197     for ( kid = br->getKid(0); kid != NULL ; kid = br->getNextKid() )
 198       found = mark_cat(kid, cat_objects) || found;
 199
 200     if (found)
 201       br->setTraversalMaskBits(SSGTRAV_HOT);
 202
 203   } else if (e->isAKindOf(ssgTypeLeaf())) {
 204     list<string>::const_iterator it;
 205     for (it = cat_objects.begin(); it != cat_objects.end(); ++it) {
 206       if (e->getName() && (*it) == e->getName()) {
 207         e->setTraversalMaskBits(SSGTRAV_HOT);
 208         e->setUserData( FGAICarrierHardware::newCatapult( this ) );
 209         ssgLeaf *l = (ssgLeaf*)e;
 210         if ( l->getNumLines() != 1 ) {
 211           SG_LOG(SG_GENERAL, SG_ALERT,
 212                  "AICarrier: Found a cat not modelled with exactly one line!");
 213         }
 214         // Now some special code to make sure the cat points in the right
 215         // direction. The 0 index must be the backward end, the 1 index
 216         // the forward end.
 217         // Forward is positive x-direction in our 3D model, also the model
 218         // as such is flattened when it is loaded, so we do not need to care
 219         // for transforms ...
 220         short v[2];
 221         l->getLine(0, v, v+1 );
 222         sgVec3 ends[2];
 223         for (int k=0; k<2; ++k)
 224           sgCopyVec3( ends[k], l->getVertex( v[k] ) );
 225
 226         // When the 1 end is behind the 0 end, swap the coordinates.
 227         if (ends[0][0] < ends[1][0]) {
 228           sgCopyVec3( l->getVertex( v[0] ), ends[1] );
 229           sgCopyVec3( l->getVertex( v[1] ), ends[0] );
 230         }
 231
 232         found = true;
 233       }
 234     }
 235   }
 236   return found;
 237 }
 238
 239 void FGAICarrier::UpdateFlols( double dt) {
 240 /*    cout << "x_offset " << flols_x_offset
 241           << " y_offset " << flols_y_offset
 242           << " z_offset " << flols_z_offset << endl;
 243
 244      cout << "roll " << roll
 245           << " heading " << hdg
 246           << " pitch " << pitch << endl;
 247
 248      cout << "carrier lon " << pos[0]
 249           << " lat " <<  pos[1]
 250           << " alt " << pos[2] << endl;*/
 251
 252 // set the Flols intitial position to the carrier position
 253
 254   flolspos = pos;
 255
 256 /*  cout << "flols lon " << flolspos[0]
 257           << " lat " <<  flolspos[1]
 258           << " alt " << flolspos[2] << endl;*/
 259
 260 // set the offsets in metres
 261
 262 /*  cout << "flols_x_offset " << flols_x_offset << endl
 263        << "flols_y_offset " << flols_y_offset << endl
 264        << "flols_z_offset " << flols_z_offset << endl;*/
 265
 266   in[0] = flols_x_offset;
 267   in[1] = flols_y_offset;
 268   in[2] = flols_z_offset;
 269
 270 // pre-process the trig functions
 271
 272     cosRx = cos(roll * SG_DEGREES_TO_RADIANS);
 273     sinRx = sin(roll * SG_DEGREES_TO_RADIANS);
 274     cosRy = cos(pitch * SG_DEGREES_TO_RADIANS);
 275     sinRy = sin(pitch * SG_DEGREES_TO_RADIANS);
 276     cosRz = cos(hdg * SG_DEGREES_TO_RADIANS);
 277     sinRz = sin(hdg * SG_DEGREES_TO_RADIANS);
 278
 279 // set up the transform matrix
 280
 281     trans[0][0] =  cosRy * cosRz;
 282     trans[0][1] =  -1 * cosRx * sinRz + sinRx * sinRy * cosRz ;
 283     trans[0][2] =  sinRx * sinRz + cosRx * sinRy * cosRz;
 284
 285     trans[1][0] =  cosRy * sinRz;
 286     trans[1][1] =  cosRx * cosRz + sinRx * sinRy * sinRz;
 287     trans[1][2] =  -1 * sinRx * cosRx + cosRx * sinRy * sinRz;
 288
 289     trans[2][0] =  -1 * sinRy;
 290     trans[2][1] =  sinRx * cosRy;
 291     trans[2][2] =  cosRx * cosRy;
 292
 293 // multiply the input and transform matrices
 294
 295    out[0] = in[0] * trans[0][0] + in[1] * trans[0][1] + in[2] * trans[0][2];
 296    out[1] = in[0] * trans[1][0] + in[1] * trans[1][1] + in[2] * trans[1][2];
 297    out[2] = in[0] * trans[2][0] + in[1] * trans[2][1] + in[2] * trans[2][2];
 298
 299 // convert meters to ft to degrees of latitude
 300    out[0] = (out[0] * 3.28083989501) /(366468.96 - 3717.12 * cos(flolspos[0] * SG_DEGREES_TO_RADIANS));
 301
 302 // convert meters to ft to degrees of longitude
 303    out[1] = (out[1] * 3.28083989501)/(365228.16 * cos(flolspos[1] * SG_DEGREES_TO_RADIANS));
 304
 305 //print out the result
 306 /*   cout  << "lat adjust deg" << out[0]
 307         << " lon adjust deg " << out[1]
 308         << " alt adjust m " << out[2]  << endl;*/
 309
 310 // adjust Flols position
 311    flolspos[0] += out[0];
 312    flolspos[1] += out[1];
 313    flolspos[2] += out[2];
 314
 315 // convert flols position to cartesian co-ordinates
 316
 317   sgGeodToCart(flolspos[1] * SG_DEGREES_TO_RADIANS,
 318                flolspos[0] * SG_DEGREES_TO_RADIANS,
 319                flolspos[2] , flolsXYZ );
 320
 321
 322 /*  cout << "flols X " << flolsXYZ[0]
 323        << " Y " <<  flolsXYZ[1]
 324        << " Z " << flolsXYZ[2] << endl;
 325
 326 // check the conversion
 327
 328   sgCartToGeod(flolsXYZ, &lat, &lon, &alt);
 329
 330   cout << "flols check lon " << lon
 331         << " lat " << lat
 332         << " alt " << alt << endl;      */
 333
 334 //get the current position of the pilot's eyepoint (cartesian cordinates)
 335
 336   sgdCopyVec3( eyeXYZ, globals->get_current_view()->get_absolute_view_pos() );
 337
 338  /* cout  << "Eye_X "  << eyeXYZ[0]
 339         << " Eye_Y " << eyeXYZ[1]
 340         << " Eye_Z " << eyeXYZ[2]  << endl; */
 341
 342   sgCartToGeod(eyeXYZ, &lat, &lon, &alt);
 343
 344   eyepos[0] = lon * SG_RADIANS_TO_DEGREES;
 345   eyepos[1] = lat * SG_RADIANS_TO_DEGREES;
 346   eyepos[2] = alt;
 347
 348 /*  cout << "eye lon " << eyepos[0]
 349         << " eye lat " << eyepos[1]
 350         << " eye alt " << eyepos[2] << endl; */
 351
 352 //calculate the ditance from eye to flols
 353
 354   dist = sgdDistanceVec3( flolsXYZ, eyeXYZ );
 355
 356   //cout << "distance " << dist << endl;
 357
 358   if ( dist < 5000 ) {
 359        // calculate height above FLOLS
 360        double y = eyepos[2] - flolspos[2];
 361
 362        // calculate the angle from the flols to eye
 363        // above the horizontal
 364        double angle;
 365        if ( dist != 0 ) {
 366            angle = asin( y / dist );
 367          } else {
 368            angle = 0.0;
 369          }
 370
 371        angle *= SG_RADIANS_TO_DEGREES;
 372
 373
 374   // cout << " height " << y << " angle " << angle ;
 375
 376 // set the value of source
 377
 378        if ( angle <= 4.35 && angle > 4.01 )
 379          { source = 1; }
 380          else if ( angle <= 4.01 && angle > 3.670 )
 381          { source = 2; }
 382          else if ( angle <= 3.670 && angle > 3.330 )
 383          { source = 3; }
 384          else if ( angle <= 3.330 && angle > 2.990 )
 385          { source = 4; }
 386          else if ( angle <= 2.990 && angle > 2.650 )
 387          { source = 5; }
 388          else if ( angle <= 2.650  )
 389          { source = 6; }
 390          else
 391          { source = 0; }
 392
 393 //         cout << " source " << source << endl;
 394
 395    }
 396 } // end updateflols
 397
 398 int FGAICarrierHardware::unique_id = 1;