1 // FGAIBase - 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
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.
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.
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.
20 #ifndef _FG_AIBASE_HXX
21 #define _FG_AIBASE_HXX
25 #include <simgear/constants.h>
26 #include <simgear/math/point3d.hxx>
27 #include <simgear/scene/model/placement.hxx>
29 #include <Main/fg_props.hxx>
40 // can be aircraft, ship, storm, thermal or ballistic
44 const char* flightplan;
48 double repeat; // in seconds
49 double latitude; // used if no flightplan defined
50 double longitude; // used if no flightplan defined
51 double altitude; // used if no flightplan defined
52 double speed; // used if no flightplan defined
53 double heading; // used if no flightplan defined
54 double roll; // used if no flightplan defined
55 double azimuth; // used by ballistic objects
56 double elevation; // used by ballistic objects
57 double rudder; // used by ship objects
58 double strength; // used by thermal objects
59 double diameter; // used by thermal objects
60 double eda; // used by ballistic objects
61 double life; // life span in seconds
62 double buoyancy; // acceleration in ft per sec2
63 double wind_from_east; // in feet per second
64 double wind_from_north; // in feet per second
75 virtual void update(double dt);
76 inline Point3D GetPos() { return(pos); }
78 enum object_type { otNull, otAircraft, otShip, otBallistic,
79 otRocket, otStorm, otThermal };
83 virtual void unbind();
85 void setPath( const char* model );
86 void setSpeed( double speed_KTAS );
87 void setAltitude( double altitude_ft );
88 void setHeading( double heading );
89 void setLatitude( double latitude );
90 void setLongitude( double longitude );
91 void setBank( double bank );
95 void setDie( bool die );
100 SGPropertyNode *props;
101 FGAIManager* manager;
103 // these describe the model's actual state
104 Point3D pos; // WGS84 lat & lon in degrees, elev above sea-level in meters
105 double hdg; // True heading in degrees
106 double roll; // degrees, left is negative
107 double pitch; // degrees, nose-down is negative
108 double speed; // knots true airspeed
109 double altitude; // meters above sea level
110 double vs; // vertical speed, feet per minute
112 double ft_per_deg_lon;
113 double ft_per_deg_lat;
115 // these describe the model's desired state
116 double tgt_heading; // target heading, degrees true
117 double tgt_altitude; // target altitude, *feet* above sea level
118 double tgt_speed; // target speed, KTAS
124 // these describe radar information for the user
125 bool in_range; // true if in range of the radar, otherwise false
126 double bearing; // true bearing from user to this model
127 double elevation; // elevation in degrees from user to this model
128 double range; // range from user to this model, nm
129 double rdot; // range rate, in knots
130 double horiz_offset; // look left/right from user to me, deg
131 double vert_offset; // look up/down from user to me, deg
132 double x_shift; // value used by radar display instrument
133 double y_shift; // value used by radar display instrument
134 double rotation; // value used by radar display instrument
137 string model_path; //Path to the 3D model
138 ssgBranch * model; //The 3D model object
139 SGModelPlacement aip;
149 double UpdateRadar(FGAIManager* manager);
157 object_type getType();
158 bool isa( object_type otype );
160 double _getVS_fps() const;
161 void _setVS_fps( double _vs );
163 double _getAltitude() const;
164 void _setAltitude( double _alt );
166 void _setLongitude( double longitude );
167 void _setLatitude ( double latitude );
169 double _getLongitude() const;
170 double _getLatitude () const;
172 double _getBearing() const;
173 double _getElevation() const;
174 double _getRdot() const;
175 double _getH_offset() const;
176 double _getV_offset() const;
177 double _getX_shift() const;
178 double _getY_shift() const;
179 double _getRotation() const;
181 inline double _getRange() { return range; };
183 static bool _isNight();
187 inline void FGAIBase::setPath( const char* model ) {
188 model_path.append(model);
191 inline void FGAIBase::setSpeed( double speed_KTAS ) {
192 speed = tgt_speed = speed_KTAS;
195 inline void FGAIBase::setHeading( double heading ) {
196 hdg = tgt_heading = heading;
199 inline void FGAIBase::setAltitude( double altitude_ft ) {
200 altitude = tgt_altitude = altitude_ft;
201 pos.setelev(altitude * SG_FEET_TO_METER);
204 inline void FGAIBase::setBank( double bank ) {
205 roll = tgt_roll = bank;
209 inline void FGAIBase::setLongitude( double longitude ) {
210 pos.setlon( longitude );
212 inline void FGAIBase::setLatitude ( double latitude ) {
213 pos.setlat( latitude );
216 inline void FGAIBase::setDie( bool die ) { delete_me = die; }
217 inline bool FGAIBase::getDie() { return delete_me; }
219 inline void FGAIBase::setID( int ID ) { id = ID; }
220 inline int FGAIBase::getID() { return id; }
222 inline FGAIBase::object_type FGAIBase::getType() { return _otype; }
224 #endif // _FG_AIBASE_HXX