src/AIModel/AICarrier.hxx

   1 // FGAICarrier - AIShip-derived class creates an AI aircraft carrier
   2 //
   3 // Written by David Culp, started October 2004.
   4 //
   5 // Copyright (C) 2004  David P. Culp - davidculp2@comcast.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_AICARRIER_HXX
  22 #define _FG_AICARRIER_HXX
  23
  24 #include <string>
  25 #include <list>
  26 #include <plib/ssg.h>
  27 #include <simgear/compiler.h>
  28
  29 SG_USING_STD(string);
  30 SG_USING_STD(list);
  31
  32 #include "AIShip.hxx"
  33
  34 #include "AIManager.hxx"
  35 #include "AIBase.hxx"
  36
  37 class FGAIManager;
  38 class FGAICarrier;
  39
  40 class FGAICarrierHardware : public ssgBase {
  41 public:
  42
  43     enum Type { Catapult, Wire, Solid };
  44
  45     FGAICarrier *carrier;
  46     int id;
  47     Type type;
  48
  49     static FGAICarrierHardware* newCatapult(FGAICarrier *c) {
  50         FGAICarrierHardware* ch = new FGAICarrierHardware;
  51         ch->carrier = c;
  52         ch->type = Catapult;
  53         ch->id = unique_id++;
  54         return ch;
  55     }
  56     static FGAICarrierHardware* newWire(FGAICarrier *c) {
  57         FGAICarrierHardware* ch = new FGAICarrierHardware;
  58         ch->carrier = c;
  59         ch->type = Wire;
  60         ch->id = unique_id++;
  61         return ch;
  62     }
  63     static FGAICarrierHardware* newSolid(FGAICarrier *c) {
  64         FGAICarrierHardware* ch = new FGAICarrierHardware;
  65         ch->carrier = c;
  66         ch->type = Solid;
  67         ch->id = unique_id++;
  68         return ch;
  69     }
  70
  71 private:
  72     static int unique_id;
  73 };
  74
  75
  76 class FGAICarrier  : public FGAIShip {
  77 public:
  78
  79     FGAICarrier();
  80     virtual ~FGAICarrier();
  81
  82     virtual void readFromScenario(SGPropertyNode* scFileNode);
  83
  84     void setSign(const string& );
  85     void setTACANChannelID(const string &);
  86
  87     void getVelocityWrtEarth(sgdVec3& v, sgdVec3& omega, sgdVec3& pivot);
  88     virtual void bind();
  89     virtual void unbind();
  90     void UpdateWind ( double dt );
  91     void setWind_from_east( double fps );
  92     void setWind_from_north( double fps );
  93     void setMaxLat( double deg );
  94     void setMinLat( double deg );
  95     void setMaxLong( double deg );
  96     void setMinLong( double deg );
  97     void TurnToLaunch();
  98     void TurnToBase();
  99     void ReturnToBox();
 100     float Horizon(float h);
 101     bool OutsideBox();
 102
 103     bool init();
 104
 105     virtual const char* getTypeString(void) const { return "carrier"; }
 106
 107     bool getParkPosition(const string& id, SGGeod& geodPos,
 108                          double& hdng, SGVec3d& uvw);
 109
 110 private:
 111   /// Is sufficient to be private, stores a possible position to place an
 112   /// aircraft on start
 113   struct ParkPosition {
 114     ParkPosition(const ParkPosition& pp)
 115       : name(pp.name), offset(pp.offset), heading_deg(pp.heading_deg)
 116     {}
 117     ParkPosition(const string& n, const SGVec3d& off = SGVec3d(), double heading = 0)
 118       : name(n), offset(off), heading_deg(heading)
 119     {}
 120     string name;
 121     SGVec3d offset;
 122     double heading_deg;
 123   };
 124
 125
 126     void update(double dt);
 127     void mark_nohot(ssgEntity*);
 128
 129     bool mark_wires(ssgEntity*, const list<string>&, bool = false);
 130     bool mark_cat(ssgEntity*, const list<string>&, bool = false);
 131     bool mark_solid(ssgEntity*, const list<string>&, bool = false);
 132     double wind_from_east;  // fps
 133     double wind_from_north; // fps
 134     double rel_wind_speed_kts;
 135     double rel_wind_from_deg;
 136
 137
 138     list<string> solid_objects;       // List of solid object names
 139     list<string> wire_objects;        // List of wire object names
 140     list<string> catapult_objects;    // List of catapult object names
 141     list<ParkPosition> ppositions;    // List of positions where an aircraft can start.
 142     string sign;                      // The sign of this carrier.
 143
 144     // Velocity wrt earth.
 145     SGVec3d vel_wrt_earth;
 146     SGVec3d rot_wrt_earth;
 147     SGVec3d rot_pivot_wrt_earth;
 148
 149     // these describe the flols
 150     SGVec3d flols_off;
 151
 152     double dist;            // the distance of the eyepoint from the flols
 153     double angle;
 154     int source;             // the flols light which is visible at the moment
 155     bool wave_off_lights;
 156
 157     // these are for maneuvering the carrier
 158     SGGeod mOpBoxPos;
 159
 160     double wind_speed_from_north_kts ;
 161     double wind_speed_from_east_kts  ;
 162     double wind_speed_kts;  //true wind speed
 163     double wind_from_deg;   //true wind direction
 164     double rel_wind;
 165     double max_lat, min_lat, max_long, min_long;
 166     double base_course, base_speed;
 167
 168     bool turn_to_launch_hdg;
 169     bool returning;      // set if the carrier is returning to an operating box
 170     bool InToWind();     // set if the carrier is in to wind
 171
 172
 173     SGPropertyNode_ptr _longitude_node;
 174     SGPropertyNode_ptr _latitude_node;
 175     SGPropertyNode_ptr _altitude_node;
 176     SGPropertyNode_ptr _surface_wind_from_deg_node;
 177     SGPropertyNode_ptr _surface_wind_speed_node;
 178     SGPropertyNode_ptr _launchbar_state_node;
 179     // this is for tacan
 180
 181     string TACAN_channel_id;
 182
 183     // these are for moving the elevators
 184     void UpdateElevator( double dt, double transition_time);
 185     double pos_norm, raw_pos_norm;
 186     double transition_time, time_constant;
 187     bool elevators;
 188
 189     // these are for moving the jet blast deflectors
 190     void UpdateJBD( double dt, double jbd_transition_time);
 191     double jbd_pos_norm, raw_jbd_pos_norm;
 192     double jbd_transition_time, jbd_time_constant;
 193     bool jbd;
 194 };
 195
 196 #endif  // _FG_AICARRIER_HXX