src/AIModel/AIBallistic.hxx

   1 // FGAIBallistic.hxx - AIBase derived class creates an AI ballistic object
   2 //
   3 // Written by David Culp, started November 2003.
   4 // - davidculp2@comcast.net
   5 //
   6 // With major additions by Vivian Meazza, Feb 2008
   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_AIBALLISTIC_HXX
  23 #define _FG_AIBALLISTIC_HXX
  24
  25 #include <math.h>
  26 #include <vector>
  27 #include <simgear/structure/SGSharedPtr.hxx>
  28 #include <simgear/scene/material/mat.hxx>
  29
  30
  31 #include "AIManager.hxx"
  32 #include "AIBase.hxx"
  33
  34 using std::vector;
  35 using std::list;
  36
  37 class FGAIBallistic : public FGAIBase {
  38
  39 public:
  40
  41     FGAIBallistic(object_type ot = otBallistic);
  42     ~FGAIBallistic();
  43
  44     void readFromScenario(SGPropertyNode* scFileNode);
  45
  46     bool init(bool search_in_AI_path=false);
  47     virtual void bind();
  48     virtual void unbind();
  49
  50     void update(double dt);
  51
  52     FGAIBallistic *ballistic;
  53
  54     void Run(double dt);
  55
  56     void setAzimuth( double az );
  57     void setElevation( double el );
  58     void setRoll( double rl );
  59     void setStabilisation( bool val );
  60     void setDragArea( double a );
  61     void setLife( double seconds );
  62     void setBuoyancy( double fpss );
  63     void setWind_from_east( double fps );
  64     void setWind_from_north( double fps );
  65     void setWind( bool val );
  66     void setCd( double c );
  67     void setMass( double m );
  68     void setWeight( double w );
  69     void setNoRoll( bool nr );
  70     void setRandom( bool r );
  71         void setRandomness( double r );
  72     void setName(const string&);
  73     void setCollision(bool c);
  74         void setExpiry(bool e);
  75     void setImpact(bool i);
  76     void setImpactReportNode(const string&);
  77     void setContentsNode(const string&);
  78     void setFuseRange(double f);
  79     void setSMPath(const string&);
  80     void setSubID(int i);
  81     void setSubmodel(const string&);
  82     void setExternalForce( bool f );
  83     void setForcePath(const string&);
  84     void setForceStabilisation( bool val );
  85     void setGroundOffset(double g);
  86     void setLoadOffset(double l);
  87     void setSlaved(bool s);
  88     void setSlavedLoad(bool s);
  89     void setHitchPos();
  90     void setPch (double e, double dt, double c);
  91     void setHdg (double az, double dt, double c);
  92     void setBnk(double r, double dt, double c);
  93     void setHt(double h, double dt, double c);
  94     void setHitchVelocity(double dt);
  95     void setFormate(bool f);
  96
  97     double _getTime() const;
  98     double getRelBrgHitchToUser() const;
  99     double getElevHitchToUser() const;
 100     double getLoadOffset() const;
 101     double getContents();
 102
 103     SGVec3d getCartHitchPos() const;
 104
 105     bool getHtAGL();
 106     bool getSlaved() const;
 107     bool getSlavedLoad() const;
 108
 109     virtual const char* getTypeString(void) const { return "ballistic"; }
 110     static const double slugs_to_kgs; //conversion factor
 111     static const double slugs_to_lbs; //conversion factor
 112
 113     SGPropertyNode_ptr _force_node;
 114     SGPropertyNode_ptr _force_azimuth_node;
 115     SGPropertyNode_ptr _force_elevation_node;
 116
 117     SGGeod hitchpos;
 118
 119     double _height;
 120     double _ht_agl_ft;       // height above ground level
 121     double _azimuth;         // degrees true
 122     double _elevation;       // degrees
 123     double _rotation;        // degrees
 124
 125     bool   _formate_to_ac;
 126
 127     void setTgtXOffset(double x);
 128     void setTgtYOffset(double y);
 129     void setTgtZOffset(double z);
 130     void setTgtOffsets(double dt, double c);
 131
 132     double getTgtXOffset() const;
 133     double getTgtYOffset() const;
 134     double getTgtZOffset() const;
 135
 136     double _tgt_x_offset;
 137     double _tgt_y_offset;
 138     double _tgt_z_offset;
 139     double _elapsed_time;
 140
 141 private:
 142
 143     virtual void reinit() { init(); }
 144
 145     bool   _aero_stabilised; // if true, object will align with trajectory
 146     double _drag_area;       // equivalent drag area in ft2
 147     double _life_timer;      // seconds
 148     double _gravity;         // fps^2
 149     double _buoyancy;        // fps^2
 150     double _wind_from_east;  // fps
 151     double _wind_from_north; // fps
 152     bool   _wind;            // if true, local wind will be applied to object
 153     double _Cd;              // drag coefficient
 154     double _mass;            // slugs
 155     bool   _random;          // modifier for Cd, life, az
 156         double _randomness;              // dimension for _random, only applies to life at present
 157     double _load_resistance; // ground load resistanc N/m^2
 158     double _frictionFactor;  // dimensionless modifier for Coefficient of Friction
 159     bool   _solid;           // if true ground is solid for FDMs
 160     double _elevation_m;     // ground elevation in meters
 161     bool   _force_stabilised;// if true, object will align to external force
 162     bool   _slave_to_ac;     // if true, object will be slaved to the parent ac pos and orientation
 163     bool   _slave_load_to_ac;// if true, object will be slaved to the parent ac pos
 164     double _contents_lb;     // contents of the object
 165     double _weight_lb;       // weight of the object (no contents if appropriate) (lbs)
 166
 167     bool   _report_collision;       // if true a collision point with AI Objects is calculated
 168     bool   _report_impact;          // if true an impact point on the terrain is calculated
 169     bool   _external_force;         // if true then apply external force
 170         bool   _report_expiry;
 171
 172     SGPropertyNode_ptr _impact_report_node;  // report node for impact and collision
 173     SGPropertyNode_ptr _contents_node;  // report node for impact and collision
 174
 175     double _fuse_range;
 176     double _distance;
 177     double _dt_count;
 178     double _next_run;
 179
 180     string _name;
 181     string _path;
 182     string _submodel;
 183     string _force_path;
 184
 185     const SGMaterial* _material;
 186
 187     void handle_collision();
 188         void handle_expiry();
 189     void handle_impact();
 190     void report_impact(double elevation, const FGAIBase *target = 0);
 191     void slaveToAC(double dt);
 192     void setContents(double c);
 193     void formateToAC(double dt);
 194
 195     SGVec3d getCartUserPos() const;
 196
 197     double getDistanceLoadToHitch() const;
 198     double getElevLoadToHitch() const;
 199     double getBearingLoadToHitch() const;
 200
 201     double getRecip(double az);
 202     double getMass() const;
 203
 204     double hs;
 205     double _ground_offset;
 206     double _load_offset;
 207     double _old_height;
 208
 209     SGVec3d _oldcarthitchPos;
 210
 211     SGGeod oldhitchpos;
 212
 213 };
 214
 215 #endif  // _FG_AIBALLISTIC_HXX