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>
41 virtual void update(double dt);
42 inline Point3D GetPos() { return(pos); }
46 virtual void unbind();
48 void setPath( const char* model );
49 void setSpeed( double speed_KTAS );
50 void setAltitude( double altitude_ft );
51 void setHeading( double heading );
52 void setLatitude( double latitude );
53 void setLongitude( double longitude );
54 void setBank( double bank );
58 void setDie( bool die );
63 SGPropertyNode *props;
66 // these describe the model's actual state
67 Point3D pos; // WGS84 lat & lon in degrees, elev above sea-level in meters
68 double hdg; // True heading in degrees
69 double roll; // degrees, left is negative
70 double pitch; // degrees, nose-down is negative
71 double speed; // knots true airspeed
72 double altitude; // meters above sea level
73 double vs; // vertical speed, feet per minute
75 // these describe the model's desired state
76 double tgt_heading; // target heading, degrees true
77 double tgt_altitude; // target altitude, *feet* above sea level
78 double tgt_speed; // target speed, KTAS
84 // these describe radar information for the user
85 double bearing; // true bearing from user to this model
86 double elevation; // elevation in degrees from user to this model
87 double range; // range from user to this model, nm
88 double rdot; // range rate, in knots
89 double horiz_offset; // look left/right from user to me, deg
90 double vert_offset; // look up/down from user to me, deg
91 double x_shift; // value used by radar display instrument
92 double y_shift; // value used by radar display instrument
93 double rotation; // value used by radar display instrument
96 string model_path; //Path to the 3D model
104 static FGAIBase *_self;
105 const char *_type_str;
109 static double _getVS_fps();
110 static void _setVS_fps( double _vs );
112 static double _getAltitude();
113 static void _setAltitude( double _alt );
115 static void _setLongitude( double longitude );
116 static void _setLatitude ( double latitude );
118 static double _getLongitude();
119 static double _getLatitude ();
121 static double _getBearing();
122 static double _getElevation();
123 static double _getRange();
124 static double _getRdot();
125 static double _getH_offset();
126 static double _getV_offset();
127 static double _getX_shift();
128 static double _getY_shift();
129 static double _getRotation();
131 static bool _isNight();
135 inline void FGAIBase::setPath( const char* model ) {
136 model_path.append(model);
139 inline void FGAIBase::setSpeed( double speed_KTAS ) {
140 speed = tgt_speed = speed_KTAS;
143 inline void FGAIBase::setHeading( double heading ) {
144 hdg = tgt_heading = heading;
147 inline void FGAIBase::setAltitude( double altitude_ft ) {
148 altitude = tgt_altitude = altitude_ft;
149 pos.setelev(altitude * SG_FEET_TO_METER);
152 inline void FGAIBase::setBank( double bank ) {
153 roll = tgt_roll = bank;
156 inline void FGAIBase::setLongitude( double longitude ) {
157 pos.setlon( longitude );
159 inline void FGAIBase::setLatitude ( double latitude ) {
160 pos.setlat( latitude );
163 inline void FGAIBase::setDie( bool die ) { delete_me = die; }
164 inline bool FGAIBase::getDie() { return delete_me; }
166 inline void FGAIBase::_setLongitude( double longitude ) {
167 _self->pos.setlon(longitude);
169 inline void FGAIBase::_setLatitude ( double latitude ) {
170 _self->pos.setlat(latitude);
173 inline double FGAIBase::_getLongitude() { return _self->pos.lon(); }
174 inline double FGAIBase::_getLatitude () { return _self->pos.lat(); }
176 inline double FGAIBase::_getBearing() { return _self->bearing; }
177 inline double FGAIBase::_getElevation() { return _self->elevation; }
178 inline double FGAIBase::_getRange() { return _self->range; }
179 inline double FGAIBase::_getRdot() { return _self->rdot; }
180 inline double FGAIBase::_getH_offset() { return _self->horiz_offset; }
181 inline double FGAIBase::_getV_offset() { return _self->vert_offset; }
182 inline double FGAIBase::_getX_shift() { return _self->x_shift; }
183 inline double FGAIBase::_getY_shift() { return _self->y_shift; }
184 inline double FGAIBase::_getRotation() { return _self->rotation; }
186 inline double FGAIBase::_getVS_fps() { return _self->vs*60.0; }
187 inline void FGAIBase::_setVS_fps( double _vs ) { _self->vs = _vs/60.0; }
189 inline double FGAIBase::_getAltitude() {
190 return _self->altitude;
192 inline void FGAIBase::_setAltitude( double _alt ) {
193 _self->setAltitude( _alt );
196 inline bool FGAIBase::_isNight() {
197 return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
200 inline void FGAIBase::setID( int ID ) { id = ID; }
201 inline int FGAIBase::getID() { return id; }
203 #endif // _FG_AIBASE_HXX