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