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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include <simgear/compiler.h>
32 #include <simgear/math/point3d.hxx>
33 #include <simgear/math/sg_geodesy.hxx>
34 #include <simgear/misc/sg_path.hxx>
35 #include <simgear/scene/model/location.hxx>
36 #include <simgear/scene/model/model.hxx>
37 #include <simgear/debug/logstream.hxx>
38 #include <simgear/props/props.hxx>
40 #include <Main/globals.hxx>
41 #include <Scenery/scenery.hxx>
45 #include "AIManager.hxx"
48 const double FGAIBase::e = 2.71828183;
49 const double FGAIBase::lbs_to_slugs = 0.031080950172; //conversion factor
52 FGAIBase::FGAIBase(object_type ot)
56 _refID( _newAIModelID() ),
59 tgt_heading = hdg = tgt_altitude = tgt_speed = 0.0;
60 tgt_roll = roll = tgt_pitch = tgt_yaw = tgt_vs = vs = pitch = 0.0;
61 bearing = elevation = range = rdot = 0.0;
62 x_shift = y_shift = rotation = 0.0;
70 FGAIBase::~FGAIBase() {
71 // Unregister that one at the scenery manager
72 if (globals->get_scenery()) {
73 globals->get_scenery()->unregister_placement_transform(aip.getTransform());
74 globals->get_scenery()->get_scene_graph()->removeKid(aip.getSceneGraph());
77 SGPropertyNode* parent = props->getParent();
79 parent->removeChild(props->getName(), props->getIndex());
86 void FGAIBase::readFromScenario(SGPropertyNode* scFileNode)
91 setPath(scFileNode->getStringValue("model", "Models/Geometry/glider.ac"));
93 setHeading(scFileNode->getDoubleValue("heading", 0.0));
94 setSpeed(scFileNode->getDoubleValue("speed", 0.0));
95 setAltitude(scFileNode->getDoubleValue("altitude", 0.0));
96 setLongitude(scFileNode->getDoubleValue("longitude", 0.0));
97 setLatitude(scFileNode->getDoubleValue("latitude", 0.0));
98 setBank(scFileNode->getDoubleValue("roll", 0.0));
101 void FGAIBase::update(double dt) {
102 if (_otype == otStatic) return;
103 if (_otype == otBallistic) CalculateMach();
105 ft_per_deg_lat = 366468.96 - 3717.12 * cos(pos.lat()*SGD_DEGREES_TO_RADIANS);
106 ft_per_deg_lon = 365228.16 * cos(pos.lat()*SGD_DEGREES_TO_RADIANS);
109 void FGAIBase::Transform() {
111 aip.setPosition(pos.lon(), pos.lat(), pos.elev() * SG_METER_TO_FEET);
113 aip.setOrientation(0.0, pitch, hdg);
115 aip.setOrientation(roll, pitch, hdg);
122 bool FGAIBase::init() {
124 SGPropertyNode *root = globals->get_props()->getNode("ai/models", true);
126 unsigned index = root->getChildren(getTypeString()).size();
128 props = root->getNode(getTypeString(), index, true);
130 if (!model_path.empty()) {
132 model = load3DModel( globals->get_fg_root(), model_path, props,
133 globals->get_sim_time_sec() );
134 } catch (const sg_exception &e) {
140 aip.setVisible(true);
142 globals->get_scenery()->get_scene_graph()->addKid(aip.getSceneGraph());
143 // Register that one at the scenery manager
144 globals->get_scenery()->register_placement_transform(aip.getTransform());
146 if (!model_path.empty()) {
147 SG_LOG(SG_INPUT, SG_WARN, "AIBase: Could not load model " << model_path);
157 ssgBranch * FGAIBase::load3DModel(const string& fg_root,
159 SGPropertyNode *prop_root,
162 // some more code here to check whether a model with this name has already been loaded
163 // if not load it, otherwise, get the memory pointer and do something like
164 // SetModel as in ATC/AIEntity.cxx
165 model = manager->getModel(path);
168 model = sgLoad3DModel(fg_root,
172 manager->setModel(path, model);
178 bool FGAIBase::isa( object_type otype ) {
179 if ( otype == _otype ) { return true; }
180 else { return false; }
184 void FGAIBase::bind() {
185 props->tie("id", SGRawValueMethods<FGAIBase,int>(*this,
187 props->tie("velocities/true-airspeed-kt", SGRawValuePointer<double>(&speed));
188 props->tie("velocities/vertical-speed-fps",
189 SGRawValueMethods<FGAIBase,double>(*this,
190 &FGAIBase::_getVS_fps,
191 &FGAIBase::_setVS_fps));
193 props->tie("position/altitude-ft",
194 SGRawValueMethods<FGAIBase,double>(*this,
195 &FGAIBase::_getAltitude,
196 &FGAIBase::_setAltitude));
197 props->tie("position/latitude-deg",
198 SGRawValueMethods<FGAIBase,double>(*this,
199 &FGAIBase::_getLatitude,
200 &FGAIBase::_setLatitude));
201 props->tie("position/longitude-deg",
202 SGRawValueMethods<FGAIBase,double>(*this,
203 &FGAIBase::_getLongitude,
204 &FGAIBase::_setLongitude));
206 props->tie("orientation/pitch-deg", SGRawValuePointer<double>(&pitch));
207 props->tie("orientation/roll-deg", SGRawValuePointer<double>(&roll));
208 props->tie("orientation/true-heading-deg", SGRawValuePointer<double>(&hdg));
210 props->tie("radar/in-range", SGRawValuePointer<bool>(&in_range));
211 props->tie("radar/bearing-deg", SGRawValuePointer<double>(&bearing));
212 props->tie("radar/elevation-deg", SGRawValuePointer<double>(&elevation));
213 props->tie("radar/range-nm", SGRawValuePointer<double>(&range));
214 props->tie("radar/h-offset", SGRawValuePointer<double>(&horiz_offset));
215 props->tie("radar/v-offset", SGRawValuePointer<double>(&vert_offset));
216 props->tie("radar/x-shift", SGRawValuePointer<double>(&x_shift));
217 props->tie("radar/y-shift", SGRawValuePointer<double>(&y_shift));
218 props->tie("radar/rotation", SGRawValuePointer<double>(&rotation));
220 props->tie("controls/lighting/nav-lights",
221 SGRawValueFunctions<bool>(_isNight));
222 props->setBoolValue("controls/lighting/beacon", true);
223 props->setBoolValue("controls/lighting/strobe", true);
224 props->setBoolValue("controls/glide-path", true);
227 void FGAIBase::unbind() {
229 props->untie("velocities/true-airspeed-kt");
230 props->untie("velocities/vertical-speed-fps");
232 props->untie("position/altitude-ft");
233 props->untie("position/latitude-deg");
234 props->untie("position/longitude-deg");
236 props->untie("orientation/pitch-deg");
237 props->untie("orientation/roll-deg");
238 props->untie("orientation/true-heading-deg");
240 props->untie("radar/in-range");
241 props->untie("radar/bearing-deg");
242 props->untie("radar/elevation-deg");
243 props->untie("radar/range-nm");
244 props->untie("radar/h-offset");
245 props->untie("radar/v-offset");
246 props->untie("radar/x-shift");
247 props->untie("radar/y-shift");
248 props->untie("radar/rotation");
250 props->untie("controls/lighting/nav-lights");
253 double FGAIBase::UpdateRadar(FGAIManager* manager)
255 double radar_range_ft2 = fgGetDouble("/instrumentation/radar/range");
256 radar_range_ft2 *= SG_NM_TO_METER * SG_METER_TO_FEET * 1.1; // + 10%
257 radar_range_ft2 *= radar_range_ft2;
259 double user_latitude = manager->get_user_latitude();
260 double user_longitude = manager->get_user_longitude();
261 double lat_range = fabs(pos.lat() - user_latitude) * ft_per_deg_lat;
262 double lon_range = fabs(pos.lon() - user_longitude) * ft_per_deg_lon;
263 double range_ft2 = lat_range*lat_range + lon_range*lon_range;
266 // Test whether the target is within radar range.
268 in_range = (range_ft2 && (range_ft2 <= radar_range_ft2));
271 props->setBoolValue("radar/in-range", true);
273 // copy values from the AIManager
274 double user_altitude = manager->get_user_altitude();
275 double user_heading = manager->get_user_heading();
276 double user_pitch = manager->get_user_pitch();
277 double user_yaw = manager->get_user_yaw();
278 double user_speed = manager->get_user_speed();
280 // calculate range to target in feet and nautical miles
281 double range_ft = sqrt( range_ft2 );
282 range = range_ft / 6076.11549;
284 // calculate bearing to target
285 if (pos.lat() >= user_latitude) {
286 bearing = atan2(lat_range, lon_range) * SG_RADIANS_TO_DEGREES;
287 if (pos.lon() >= user_longitude) {
288 bearing = 90.0 - bearing;
290 bearing = 270.0 + bearing;
293 bearing = atan2(lon_range, lat_range) * SG_RADIANS_TO_DEGREES;
294 if (pos.lon() >= user_longitude) {
295 bearing = 180.0 - bearing;
297 bearing = 180.0 + bearing;
301 // calculate look left/right to target, without yaw correction
302 horiz_offset = bearing - user_heading;
303 if (horiz_offset > 180.0) horiz_offset -= 360.0;
304 if (horiz_offset < -180.0) horiz_offset += 360.0;
306 // calculate elevation to target
307 elevation = atan2( altitude * SG_METER_TO_FEET - user_altitude, range_ft )
308 * SG_RADIANS_TO_DEGREES;
310 // calculate look up/down to target
311 vert_offset = elevation + user_pitch;
313 /* this calculation needs to be fixed, but it isn't important anyway
314 // calculate range rate
315 double recip_bearing = bearing + 180.0;
316 if (recip_bearing > 360.0) recip_bearing -= 360.0;
317 double my_horiz_offset = recip_bearing - hdg;
318 if (my_horiz_offset > 180.0) my_horiz_offset -= 360.0;
319 if (my_horiz_offset < -180.0) my_horiz_offset += 360.0;
320 rdot = (-user_speed * cos( horiz_offset * SG_DEGREES_TO_RADIANS ))
321 +(-speed * 1.686 * cos( my_horiz_offset * SG_DEGREES_TO_RADIANS ));
324 // now correct look left/right for yaw
325 horiz_offset += user_yaw;
327 // calculate values for radar display
328 y_shift = range * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
329 x_shift = range * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
330 rotation = hdg - user_heading;
331 if (rotation < 0.0) rotation += 360.0;
339 FGAIBase::getCartPosAt(const SGVec3d& _off) const
341 // Transform that one to the horizontal local coordinate system.
342 SGQuatd hlTrans = SGQuatd::fromLonLatDeg(pos.lon(), pos.lat());
343 // and postrotate the orientation of the AIModel wrt the horizontal
345 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
347 // The offset converted to the usual body fixed coordinate system
348 // rotated to the earth fiexed coordinates axis
349 SGVec3d off = hlTrans.backTransform(_off);
351 // Add the position offset of the AIModel to gain the earth centered position
352 SGVec3d cartPos = SGGeod::fromDegFt(pos.lon(), pos.lat(), pos.elev());
354 return cartPos + off;
358 * getters and Setters
360 void FGAIBase::_setLongitude( double longitude ) {
361 pos.setlon(longitude);
363 void FGAIBase::_setLatitude ( double latitude ) {
364 pos.setlat(latitude);
367 double FGAIBase::_getLongitude() const {
370 double FGAIBase::_getLatitude () const {
373 double FGAIBase::_getRdot() const {
376 double FGAIBase::_getVS_fps() const {
379 void FGAIBase::_setVS_fps( double _vs ) {
383 double FGAIBase::_getAltitude() const {
386 void FGAIBase::_setAltitude( double _alt ) {
390 bool FGAIBase::_isNight() {
391 return (fgGetFloat("/sim/time/sun-angle-rad") > 1.57);
394 int FGAIBase::getID() const {
398 void FGAIBase::CalculateMach() {
399 // Calculate rho at altitude, using standard atmosphere
400 // For the temperature T and the pressure p,
402 if (altitude < 36152) { // curve fits for the troposphere
403 T = 59 - 0.00356 * altitude;
404 p = 2116 * pow( ((T + 459.7) / 518.6) , 5.256);
406 } else if ( 36152 < altitude && altitude < 82345 ) { // lower stratosphere
408 p = 473.1 * pow( e , 1.73 - (0.000048 * altitude) );
410 } else { // upper stratosphere
411 T = -205.05 + (0.00164 * altitude);
412 p = 51.97 * pow( ((T + 459.7) / 389.98) , -11.388);
415 rho = p / (1718 * (T + 459.7));
417 // calculate the speed of sound at altitude
418 // a = sqrt ( g * R * (T + 459.7))
420 // a = speed of sound [ft/s]
421 // g = specific heat ratio, which is usually equal to 1.4
422 // R = specific gas constant, which equals 1716 ft-lb/slug/°R
424 a = sqrt ( 1.4 * 1716 * (T + 459.7));
426 // calculate Mach number
430 // cout << "Speed(ft/s) "<< speed <<" Altitude(ft) "<< altitude << " Mach " << Mach;
433 int FGAIBase::_newAIModelID() {
435 if (!++id) id++; // id = 0 is not allowed.