src/AIModel/AIShip.hxx

   1 // FGAIShip - AIBase derived class creates an AI ship
   2 //
   3 // Written by David Culp, started November 2003.
   4 // with major amendments and additions by Vivian Meazza, 2004 - 2007
   5 //
   6 // Copyright (C) 2003  David P. Culp - davidculp2@comcast.net
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifndef _FG_AISHIP_HXX
  23 #define _FG_AISHIP_HXX
  24
  25 #include "AIBase.hxx"
  26 #include "AIFlightPlan.hxx"
  27 #include <simgear/scene/material/mat.hxx>
  28
  29 class FGAIManager;
  30
  31 class FGAIShip : public FGAIBase {
  32
  33 public:
  34
  35     FGAIShip(object_type ot = otShip);
  36     virtual ~FGAIShip();
  37
  38     virtual void readFromScenario(SGPropertyNode* scFileNode);
  39
  40     virtual bool init(bool search_in_AI_path=false);
  41     virtual void bind();
  42     virtual void update(double dt);
  43     virtual void reinit();
  44
  45     void setFlightPlan(FGAIFlightPlan* f);
  46     void setRudder(float r);
  47     void setRoll(double rl);
  48     void ProcessFlightPlan( double dt);
  49     void AccelTo(double speed);
  50     void PitchTo(double angle);
  51     void RollTo(double angle);
  52     void YawTo(double angle);
  53     void ClimbTo(double altitude);
  54     void TurnTo(double heading);
  55     void setCurrName(const string&);
  56     void setNextName(const string&);
  57     void setPrevName(const string&);
  58     void setLeadAngleGain(double g);
  59     void setLeadAngleLimit(double l);
  60     void setLeadAngleProp(double p);
  61     void setRudderConstant(double rc);
  62     void setSpeedConstant(double sc);
  63     void setFixedTurnRadius(double ft);
  64     void setRollFactor(double rf);
  65
  66     void setTunnel(bool t);
  67     void setInitialTunnel(bool t);
  68
  69     void setWPNames();
  70     void setWPPos();
  71
  72     double sign(double x);
  73
  74     bool _hdg_lock;
  75     bool _serviceable;
  76     bool _waiting;
  77     bool _new_waypoint;
  78     bool _tunnel, _initial_tunnel;
  79     bool _restart;
  80
  81     virtual const char* getTypeString(void) const { return "ship"; }
  82     double _rudder_constant, _speed_constant, _hdg_constant, _limit ;
  83     double _elevation_m, _elevation_ft;
  84     double _missed_range, _tow_angle, _wait_count, _missed_count,_wp_range;
  85     double _dt_count, _next_run;
  86
  87     FGAIWaypoint* prev; // the one behind you
  88     FGAIWaypoint* curr; // the one ahead
  89     FGAIWaypoint* next; // the next plus 1
  90
  91 protected:
  92
  93 private:
  94
  95
  96     void setRepeat(bool r);
  97     void setRestart(bool r);
  98     void setMissed(bool m);
  99
 100     void setServiceable(bool s);
 101     void Run(double dt);
 102     void setStartTime(const string&);
 103     void setUntilTime(const string&);
 104     //void setWPPos();
 105     void setWPAlt();
 106     void setXTrackError();
 107
 108     SGGeod wppos;
 109
 110     const SGMaterial* _material;
 111
 112     double getRange(double lat, double lon, double lat2, double lon2) const;
 113     double getCourse(double lat, double lon, double lat2, double lon2) const;
 114     double getDaySeconds();
 115     double processTimeString(const string& time);
 116
 117     bool initFlightPlan();
 118     bool advanceFlightPlan (double elapsed_sec, double day_sec);
 119
 120     float _rudder, _tgt_rudder;
 121
 122     double _roll_constant, _roll_factor;
 123     double _sp_turn_radius_ft, _rd_turn_radius_ft, _fixed_turn_radius;
 124     double _old_range, _range_rate;
 125     double _missed_time_sec;
 126     double _start_sec;
 127     double _day;
 128     double _lead_angle;
 129     double _lead_angle_gain, _lead_angle_limit, _proportion;
 130     double _course;
 131     double _xtrack_error;
 132     double _curr_alt, _prev_alt;
 133
 134     string _prev_name, _curr_name, _next_name;
 135     string _path;
 136     string _start_time, _until_time;
 137
 138     bool _repeat;
 139     bool _fp_init;
 140     bool _missed;
 141
 142
 143 };
 144
 145 #endif  // _FG_AISHIP_HXX