src/AIModel/AIBase.hxx

   1 // FGAIBase.hxx - abstract base class for AI objects
   2 // Written by David Culp, started Nov 2003, based on
   3 // David Luff's FGAIEntity class.
   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 #ifndef _FG_AIBASE_HXX
  21 #define _FG_AIBASE_HXX
  22
  23 #include <string>
  24 #include <list>
  25
  26 #include <simgear/constants.h>
  27 #include <simgear/math/point3d.hxx>
  28 #include <simgear/scene/model/placement.hxx>
  29 #include <simgear/misc/sg_path.hxx>
  30 #include <simgear/structure/ssgSharedPtr.hxx>
  31
  32 #include <Main/fg_props.hxx>
  33
  34 SG_USING_STD(string);
  35 SG_USING_STD(list);
  36
  37 class FGAIManager;
  38 class FGAIFlightPlan;
  39
  40
  41 struct ParkPosition {
  42   ParkPosition(const ParkPosition& pp)
  43     : name(pp.name), offset(pp.offset), heading_deg(pp.heading_deg)
  44   {}
  45   ParkPosition(const string& n, const Point3D& off = Point3D(), double heading = 0)
  46     : name(n), offset(off), heading_deg(heading)
  47   {}
  48   string name;
  49   Point3D offset;
  50   double heading_deg;
  51 };
  52
  53 typedef struct {
  54    string callsign;
  55
  56    // can be aircraft, ship, storm, thermal, static or ballistic
  57    string m_type;
  58    string m_class;
  59    string path;
  60    string flightplan;
  61
  62    FGAIFlightPlan *fp;
  63
  64    double repeat;             // in seconds
  65    double latitude;           // used if no flightplan defined
  66    double longitude;          // used if no flightplan defined
  67    double altitude;           // used if no flightplan defined
  68    double speed;              // used if no flightplan defined
  69    double heading;            // used if no flightplan defined
  70    double roll;               // used if no flightplan defined
  71    double azimuth;            // used by ballistic objects
  72    double elevation;          // used by ballistic objects
  73    double rudder;             // used by ship objects
  74    double strength;           // used by thermal
  75    double turb_strength;      // used by storm objects
  76    double diameter;           // used by thermal and storm objects
  77    double height_msl;         // used by thermal and storm objects
  78    double eda;                // used by ballistic objects
  79    double life;               // life span in seconds
  80    double buoyancy;           // acceleration in ft per sec2
  81    double wind_from_east;     // in feet per second
  82    double wind_from_north;    // in feet per second
  83    double cd;                 // coefficient of drag
  84    bool wind;                 // if true, model reacts to parent wind
  85    double mass;               // in slugs
  86    bool aero_stabilised;      // if true, ballistic object aligns with trajectory
  87    list<string> solid_objects;    // List of solid object names
  88    list<string> wire_objects;     // List of wire object names
  89    list<string> catapult_objects; // List of catapult object names
  90    list<ParkPosition> ppositions; // List of positions on a carrier where an aircraft can start.
  91    Point3D flols_offset;      // used by carrier objects, in meters
  92    double radius;             // used by ship objects, in feet
  93    string name;               // used by carrier objects
  94    string pennant_number;     // used by carrier objects
  95    string acType;             // used by aircraft objects
  96    string company;            // used by aircraft objects
  97    string TACAN_channel_ID;   // used by carrier objects
  98    double max_lat;            // used by carrier objects
  99    double min_lat;            // used by carrier objects
 100    double max_long;            // used by carrier objects
 101    double min_long;            // used by carrier objects
 102
 103 } FGAIModelEntity;
 104
 105
 106 class FGAIBase {
 107
 108 public:
 109
 110     FGAIBase();
 111     virtual ~FGAIBase();
 112     virtual void update(double dt);
 113     inline const Point3D& GetPos() const { return(pos); }
 114
 115     enum object_type { otNull = 0, otAircraft, otShip, otCarrier, otBallistic,
 116                        otRocket, otStorm, otThermal, otStatic, otMultiplayer,
 117                        MAX_OBJECTS };   // Needs to be last!!!
 118
 119     virtual bool init();
 120     virtual void bind();
 121     virtual void unbind();
 122
 123     void setPath( const char* model );
 124     void setSpeed( double speed_KTAS );
 125     void setAltitude( double altitude_ft );
 126     void setHeading( double heading );
 127     void setLatitude( double latitude );
 128     void setLongitude( double longitude );
 129     void setBank( double bank );
 130     void setPitch( double newpitch );
 131     void setRadius ( double radius );
 132     void setXoffset( double x_offset );
 133     void setYoffset( double y_offset );
 134     void setZoffset( double z_offset );
 135
 136     int getID() const;
 137
 138     void setDie( bool die );
 139     bool getDie();
 140
 141     Point3D getCartPosAt(const Point3D& off) const;
 142     Point3D getGeocPosAt(const Point3D& off) const;
 143
 144 protected:
 145
 146     SGPropertyNode_ptr props;
 147     FGAIManager* manager;
 148
 149     // these describe the model's actual state
 150     Point3D pos;        // WGS84 lat & lon in degrees, elev above sea-level in meters
 151     double hdg;         // True heading in degrees
 152     double roll;        // degrees, left is negative
 153     double pitch;       // degrees, nose-down is negative
 154     double speed;       // knots true airspeed
 155     double altitude;    // meters above sea level
 156     double vs;          // vertical speed, feet per minute
 157     double turn_radius_ft; // turn radius ft at 15 kts rudder angle 15 degrees
 158
 159     double ft_per_deg_lon;
 160     double ft_per_deg_lat;
 161
 162     // these describe the model's desired state
 163     double tgt_heading;  // target heading, degrees true
 164     double tgt_altitude; // target altitude, *feet* above sea level
 165     double tgt_speed;    // target speed, KTAS
 166     double tgt_roll;
 167     double tgt_pitch;
 168     double tgt_yaw;
 169     double tgt_vs;
 170
 171     // these describe radar information for the user
 172     bool in_range;       // true if in range of the radar, otherwise false
 173     double bearing;      // true bearing from user to this model
 174     double elevation;    // elevation in degrees from user to this model
 175     double range;        // range from user to this model, nm
 176     double rdot;         // range rate, in knots
 177     double horiz_offset; // look left/right from user to me, deg
 178     double vert_offset;  // look up/down from user to me, deg
 179     double x_shift;      // value used by radar display instrument
 180     double y_shift;      // value used by radar display instrument
 181     double rotation;     // value used by radar display instrument
 182
 183
 184     string model_path;     //Path to the 3D model
 185     ssgSharedPtr<ssgBranch> model; //The 3D model object
 186     SGModelPlacement aip;
 187     bool delete_me;
 188     bool invisible;
 189     bool no_roll;
 190     double life;
 191     FGAIFlightPlan *fp;
 192
 193     void Transform();
 194     void CalculateMach();
 195     double UpdateRadar(FGAIManager* manager);
 196
 197     string _type_str;
 198     object_type _otype;
 199     int index;
 200
 201     static int _newAIModelID();
 202
 203 private:
 204     const int _refID;
 205
 206 public:
 207
 208     object_type getType();
 209     bool isa( object_type otype );
 210
 211     double _getVS_fps() const;
 212     void _setVS_fps( double _vs );
 213
 214     double _getAltitude() const;
 215     void _setAltitude( double _alt );
 216
 217     void _setLongitude( double longitude );
 218     void _setLatitude ( double latitude );
 219
 220     double _getLongitude() const;
 221     double _getLatitude () const;
 222
 223     double _getBearing() const;
 224     double _getElevation() const;
 225     double _getRdot() const;
 226     double _getH_offset() const;
 227     double _getV_offset() const;
 228     double _getX_shift() const;
 229     double _getY_shift() const;
 230     double _getRotation() const;
 231
 232     double rho;
 233     double T;                             // temperature, degs farenheit
 234     double p;                             // pressure lbs/sq ft
 235         double a;                             // speed of sound at altitude (ft/s)
 236         double Mach;                          // Mach number
 237
 238     static const double e;
 239     static const double lbs_to_slugs;
 240
 241     inline double _getRange() { return range; };
 242   ssgBranch * load3DModel(const string& fg_root,
 243                           const string &path,
 244                           SGPropertyNode *prop_root,
 245                           double sim_time_sec);
 246
 247     static bool _isNight();
 248 };
 249
 250
 251 inline void FGAIBase::setPath( const char* model ) {
 252   model_path.append(model);
 253 }
 254
 255 inline void FGAIBase::setSpeed( double speed_KTAS ) {
 256   speed = tgt_speed = speed_KTAS;
 257 }
 258
 259 inline void FGAIBase::setRadius( double radius ) {
 260   turn_radius_ft = radius;
 261 }
 262
 263 inline void FGAIBase::setHeading( double heading ) {
 264   hdg = tgt_heading = heading;
 265 }
 266
 267 inline void FGAIBase::setAltitude( double altitude_ft ) {
 268     altitude = tgt_altitude = altitude_ft;
 269     pos.setelev(altitude * SG_FEET_TO_METER);
 270 }
 271
 272 inline void FGAIBase::setBank( double bank ) {
 273   roll = tgt_roll = bank;
 274   no_roll = false;
 275 }
 276
 277 inline void FGAIBase::setPitch( double newpitch ) {
 278   pitch = tgt_pitch = newpitch;
 279 }
 280
 281 inline void FGAIBase::setLongitude( double longitude ) {
 282     pos.setlon( longitude );
 283 }
 284 inline void FGAIBase::setLatitude ( double latitude ) {
 285     pos.setlat( latitude );
 286 }
 287
 288 inline void FGAIBase::setDie( bool die ) { delete_me = die; }
 289 inline bool FGAIBase::getDie() { return delete_me; }
 290
 291 inline FGAIBase::object_type FGAIBase::getType() { return _otype; }
 292
 293
 294
 295 #endif  // _FG_AIBASE_HXX
 296