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>
30 #include "AIFlightPlan.hxx"
42 virtual void update(double dt);
43 inline Point3D GetPos() { return(pos); }
45 enum object_type { otNull, otAircraft, otShip, otBallistic,
46 otRocket, otStorm, otThermal };
50 virtual void unbind();
52 void setPath( const char* model );
53 void setSpeed( double speed_KTAS );
54 void setAltitude( double altitude_ft );
55 void setHeading( double heading );
56 void setLatitude( double latitude );
57 void setLongitude( double longitude );
58 void setBank( double bank );
62 void setDie( bool die );
67 SGPropertyNode *props;
70 // these describe the model's actual state
71 Point3D pos; // WGS84 lat & lon in degrees, elev above sea-level in meters
72 double hdg; // True heading in degrees
73 double roll; // degrees, left is negative
74 double pitch; // degrees, nose-down is negative
75 double speed; // knots true airspeed
76 double altitude; // meters above sea level
77 double vs; // vertical speed, feet per minute
79 double ft_per_deg_lon;
80 double ft_per_deg_lat;
82 // these describe the model's desired state
83 double tgt_heading; // target heading, degrees true
84 double tgt_altitude; // target altitude, *feet* above sea level
85 double tgt_speed; // target speed, KTAS
91 // these describe radar information for the user
92 bool in_range; // true if in range of the radar, otherwise false
93 double bearing; // true bearing from user to this model
94 double elevation; // elevation in degrees from user to this model
95 double range; // range from user to this model, nm
96 double rdot; // range rate, in knots
97 double horiz_offset; // look left/right from user to me, deg
98 double vert_offset; // look up/down from user to me, deg
99 double x_shift; // value used by radar display instrument
100 double y_shift; // value used by radar display instrument
101 double rotation; // value used by radar display instrument
104 string model_path; //Path to the 3D model
105 ssgBranch * model; //The 3D model object
106 SGModelPlacement aip;
115 double UpdateRadar(FGAIManager* manager);
123 object_type getType();
124 bool isa( object_type otype );
126 double _getVS_fps() const;
127 void _setVS_fps( double _vs );
129 double _getAltitude() const;
130 void _setAltitude( double _alt );
132 void _setLongitude( double longitude );
133 void _setLatitude ( double latitude );
135 double _getLongitude() const;
136 double _getLatitude () const;
138 double _getBearing() const;
139 double _getElevation() const;
140 double _getRdot() const;
141 double _getH_offset() const;
142 double _getV_offset() const;
143 double _getX_shift() const;
144 double _getY_shift() const;
145 double _getRotation() const;
147 inline double _getRange() { return range; };
149 static bool _isNight();
153 inline void FGAIBase::setPath( const char* model ) {
154 model_path.append(model);
157 inline void FGAIBase::setSpeed( double speed_KTAS ) {
158 speed = tgt_speed = speed_KTAS;
161 inline void FGAIBase::setHeading( double heading ) {
162 hdg = tgt_heading = heading;
165 inline void FGAIBase::setAltitude( double altitude_ft ) {
166 altitude = tgt_altitude = altitude_ft;
167 pos.setelev(altitude * SG_FEET_TO_METER);
170 inline void FGAIBase::setBank( double bank ) {
171 roll = tgt_roll = bank;
175 inline void FGAIBase::setLongitude( double longitude ) {
176 pos.setlon( longitude );
178 inline void FGAIBase::setLatitude ( double latitude ) {
179 pos.setlat( latitude );
182 inline void FGAIBase::setDie( bool die ) { delete_me = die; }
183 inline bool FGAIBase::getDie() { return delete_me; }
185 inline void FGAIBase::setID( int ID ) { id = ID; }
186 inline int FGAIBase::getID() { return id; }
188 inline FGAIBase::object_type FGAIBase::getType() { return _otype; }
190 #endif // _FG_AIBASE_HXX