src/AIModel/AIEscort.hxx

   1 // FGAIGroundVehicle - 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 #ifndef _FG_AIESCORT_HXX
  22 #define _FG_AIESCORT_HXX
  23
  24 #include <string>
  25 #include <list>
  26
  27 #include <simgear/compiler.h>
  28
  29 #include "AIBase.hxx"
  30
  31 #include "AIShip.hxx"
  32
  33 #include "AIManager.hxx"
  34 #include "AIBase.hxx"
  35
  36 class FGAIEscort : public FGAIShip {
  37 public:
  38     FGAIEscort();
  39     virtual ~FGAIEscort();
  40
  41     virtual void readFromScenario(SGPropertyNode* scFileNode);
  42     virtual void bind();
  43     virtual void unbind();
  44     virtual const char* getTypeString(void) const { return "escort"; }
  45
  46     bool init(bool search_in_AI_path=false);
  47
  48 private:
  49
  50     virtual void reinit() { init(); }
  51     virtual void update (double dt);
  52
  53     void setParentName(const std::string& p);
  54     void setParent();
  55     void setStnRange(double r);
  56     void setStnBrg(double y);
  57     void setStationSpeed();
  58     void setStnLimit(double l);
  59     void setStnAngleLimit(double l);
  60     void setStnSpeed(double s);
  61     void setStnHtFt(double h);
  62     void setStnPatrol(bool p);
  63     void setStnDegTrue(bool t);
  64
  65     void setMaxSpeed(double m);
  66     void setUpdateInterval(double i);
  67
  68     void RunEscort(double dt);
  69
  70     bool getGroundElev(SGGeod inpos);
  71
  72     SGVec3d getCartHitchPosAt(const SGVec3d& off) const;
  73
  74     void calcRangeBearing(double lat, double lon, double lat2, double lon2,
  75         double &range, double &bearing) const;
  76     double calcRelBearingDeg(double bearing, double heading);
  77     double calcTrueBearingDeg(double bearing, double heading);
  78     double calcRecipBearingDeg(double bearing);
  79
  80     SGGeod _selectedpos;
  81     SGGeod _tgtpos;
  82
  83     bool   _solid;           // if true ground is solid for FDMs
  84     double _load_resistance; // ground load resistanc N/m^2
  85     double _frictionFactor;  // dimensionless modifier for Coefficient of Friction
  86     double _tgtrange, _tgtbrg;
  87     double _ht_agl_ft;
  88     double _relbrg, _truebrg;
  89     double _parent_speed, _parent_hdg;
  90     double _interval;
  91
  92     double _stn_relbrg, _stn_truebrg, _stn_brg, _stn_range, _stn_height;
  93     double _stn_speed, _stn_angle_limit, _stn_limit;
  94
  95     double _max_speed;
  96
  97     const SGMaterial* _material;
  98     SGPropertyNode_ptr _selected_ac;
  99
 100     bool _MPControl, _patrol, _stn_deg_true;
 101
 102     std::string _parent;
 103
 104 };
 105
 106 #endif  // FG_AIGROUNDVEHICLE_HXX