1 // FGAIGroundVehicle - FGAIShip-derived class creates an AI Ground Vehicle
2 // by adding a ground following utility
4 // Written by Vivian Meazza, started August 2009.
5 // - vivian.meazza at lineone.net
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include <simgear/sg_inlines.h>
27 #include <Main/viewer.hxx>
28 #include <Scenery/scenery.hxx>
29 #include <Scenery/tilemgr.hxx>
30 #include <Airports/dynamics.hxx>
32 #include "AIGroundVehicle.hxx"
34 FGAIGroundVehicle::FGAIGroundVehicle() :
35 FGAIShip(otGroundVehicle),
55 FGAIGroundVehicle::~FGAIGroundVehicle() {}
57 void FGAIGroundVehicle::readFromScenario(SGPropertyNode* scFileNode) {
61 FGAIShip::readFromScenario(scFileNode);
63 setName(scFileNode->getStringValue("name", "groundvehicle"));
64 setParentName(scFileNode->getStringValue("parent", ""));
65 setNoRoll(scFileNode->getBoolValue("no-roll", true));
66 setContactX1offset(scFileNode->getDoubleValue("contact-x1-offset", 0.0));
67 setContactX2offset(scFileNode->getDoubleValue("contact-x2-offset", 0.0));
68 setXOffset(scFileNode->getDoubleValue("hitch-x-offset", 35.0));
69 setYOffset(scFileNode->getDoubleValue("hitch-y-offset", 0.0));
70 setZOffset(scFileNode->getDoubleValue("hitch-z-offset", 0.0));
71 setPitchoffset(scFileNode->getDoubleValue("pitch-offset", 0.0));
72 setRolloffset(scFileNode->getDoubleValue("roll-offset", 0.0));
73 setYawoffset(scFileNode->getDoubleValue("yaw-offset", 0.0));
74 setPitchCoeff(scFileNode->getDoubleValue("pitch-coefficient", 0.1));
75 setElevCoeff(scFileNode->getDoubleValue("elevation-coefficient", 0.25));
76 setTowAngleGain(scFileNode->getDoubleValue("tow-angle-gain", 1.0));
77 setTowAngleLimit(scFileNode->getDoubleValue("tow-angle-limit-deg", 2.0));
78 setInitialTunnel(scFileNode->getBoolValue("tunnel", false));
79 //we may need these later for towed vehicles
80 // setSubID(scFileNode->getIntValue("SubID", 0));
81 // setGroundOffset(scFileNode->getDoubleValue("ground-offset", 0.0));
82 // setFormate(scFileNode->getBoolValue("formate", true));
85 void FGAIGroundVehicle::bind() {
88 props->tie("controls/constants/elevation-coeff",
89 SGRawValuePointer<double>(&_elevation_coeff));
90 props->tie("controls/constants/pitch-coeff",
91 SGRawValuePointer<double>(&_pitch_coeff));
92 props->tie("position/ht-AGL-ft",
93 SGRawValuePointer<double>(&_ht_agl_ft));
94 props->tie("hitch/rel-bearing-deg",
95 SGRawValuePointer<double>(&_relbrg));
96 props->tie("hitch/tow-angle-deg",
97 SGRawValuePointer<double>(&_tow_angle));
98 props->tie("hitch/range-ft",
99 SGRawValuePointer<double>(&_range_ft));
100 props->tie("hitch/x-offset-ft",
101 SGRawValuePointer<double>(&_x_offset));
102 props->tie("hitch/y-offset-ft",
103 SGRawValuePointer<double>(&_y_offset));
104 props->tie("hitch/z-offset-ft",
105 SGRawValuePointer<double>(&_z_offset));
106 props->tie("hitch/parent-x-offset-ft",
107 SGRawValuePointer<double>(&_parent_x_offset));
108 props->tie("hitch/parent-y-offset-ft",
109 SGRawValuePointer<double>(&_parent_y_offset));
110 props->tie("hitch/parent-z-offset-ft",
111 SGRawValuePointer<double>(&_parent_z_offset));
112 props->tie("controls/constants/tow-angle/gain",
113 SGRawValuePointer<double>(&_tow_angle_gain));
114 props->tie("controls/constants/tow-angle/limit-deg",
115 SGRawValuePointer<double>(&_tow_angle_limit));
116 props->tie("controls/contact-x1-offset-ft",
117 SGRawValuePointer<double>(&_contact_x1_offset));
118 props->tie("controls/contact-x2-offset-ft",
119 SGRawValuePointer<double>(&_contact_x2_offset));
122 void FGAIGroundVehicle::unbind() {
125 props->untie("controls/constants/elevation-coeff");
126 props->untie("controls/constants/pitch-coeff");
127 props->untie("position/ht-AGL-ft");
128 props->untie("hitch/rel-bearing-deg");
129 props->untie("hitch/tow-angle-deg");
130 props->untie("hitch/range-ft");
131 props->untie("hitch/x-offset-ft");
132 props->untie("hitch/y-offset-ft");
133 props->untie("hitch/z-offset-ft");
134 props->untie("hitch/parent-x-offset-ft");
135 props->untie("hitch/parent-y-offset-ft");
136 props->untie("hitch/parent-y-offset-ft");
137 props->untie("controls/constants/tow-angle/gain");
138 props->untie("controls/constants/tow-angle/limit-deg");
139 props->untie("controls/contact-x1-offset-ft");
140 props->untie("controls/contact-x2-offset-ft");
143 bool FGAIGroundVehicle::init(bool search_in_AI_path) {
144 if (!FGAIShip::init(search_in_AI_path))
151 props->setStringValue("controls/parent-name", _parent.c_str());
153 if (setParentNode()){
154 _parent_x_offset = _selected_ac->getDoubleValue("hitch/x-offset-ft");
155 _parent_y_offset = _selected_ac->getDoubleValue("hitch/y-offset-ft");
156 _parent_z_offset = _selected_ac->getDoubleValue("hitch/z-offset-ft");
157 _hitch_x_offset_m = _selected_ac->getDoubleValue("hitch/x-offset-ft")
159 _hitch_y_offset_m = _selected_ac->getDoubleValue("hitch/y-offset-ft")
161 _hitch_z_offset_m = _selected_ac->getDoubleValue("hitch/z-offset-ft")
169 void FGAIGroundVehicle::update(double dt) {
170 // SG_LOG(SG_GENERAL, SG_ALERT, "updating GroundVehicle: " << _name );
171 FGAIShip::update(dt);
173 RunGroundVehicle(dt);
176 void FGAIGroundVehicle::setNoRoll(bool nr) {
180 void FGAIGroundVehicle::setContactX1offset(double x1) {
181 _contact_x1_offset = x1;
184 void FGAIGroundVehicle::setContactX2offset(double x2) {
185 _contact_x2_offset = x2;
188 void FGAIGroundVehicle::setXOffset(double x) {
192 void FGAIGroundVehicle::setYOffset(double y) {
196 void FGAIGroundVehicle::setZOffset(double z) {
200 void FGAIGroundVehicle::setPitchCoeff(double pc) {
204 void FGAIGroundVehicle::setElevCoeff(double ec) {
205 _elevation_coeff = ec;
208 void FGAIGroundVehicle::setTowAngleGain(double g) {
212 void FGAIGroundVehicle::setTowAngleLimit(double l) {
213 _tow_angle_limit = l;
216 void FGAIGroundVehicle::setElevation(double h, double dt, double coeff){
217 double c = dt / (coeff + dt);
218 _elevation_ft = (h * c) + (_elevation_ft * (1 - c));
221 void FGAIGroundVehicle::setPitch(double p, double dt, double coeff){
222 double c = dt / (coeff + dt);
223 _pitch_deg = (p * c) + (_pitch_deg * (1 - c));
226 void FGAIGroundVehicle::setTowAngle(double ta, double dt, double coeff){
227 ta *= _tow_angle_gain;
228 double factor = -0.0045 * speed + 1;
229 double limit = _tow_angle_limit * factor;
230 // cout << "speed "<< speed << " _factor " << _factor<<" " <<_tow_angle_limit<< endl;
231 _tow_angle = pow(ta,2) * sign(ta) * factor;
232 SG_CLAMP_RANGE(_tow_angle, -limit, limit);
235 //bool FGAIGroundVehicle::getGroundElev(SGGeod inpos) {
239 // if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(inpos, 3000), height_m, &_material,0)){
240 // _ht_agl_ft = inpos.getElevationFt() - height_m * SG_METER_TO_FEET;
243 // const vector<string>& names = _material->get_names();
245 // _solid = _material->get_solid();
247 // if (!names.empty())
248 // props->setStringValue("material/name", names[0].c_str());
250 // props->setStringValue("material/name", "");
252 // //cout << "material " << names[0].c_str()
253 // // << " _elevation_m " << _elevation_m
254 // // << " solid " << _solid
255 // // << " load " << _load_resistance
256 // // << " frictionFactor " << _frictionFactor
268 bool FGAIGroundVehicle::getPitch() {
271 double vel = props->getDoubleValue("velocities/true-airspeed-kt", 0);
272 double contact_offset_x1_m = _contact_x1_offset * SG_FEET_TO_METER;
273 double contact_offset_x2_m = _contact_x2_offset * SG_FEET_TO_METER;
274 double _z_offset_m = _parent_z_offset * SG_FEET_TO_METER;
276 SGVec3d front(-contact_offset_x1_m, 0, 0);
277 SGVec3d rear(-contact_offset_x2_m, 0, 0);
278 SGVec3d Front = getCartPosAt(front);
279 SGVec3d Rear = getCartPosAt(rear);
281 SGGeod geodFront = SGGeod::fromCart(Front);
282 SGGeod geodRear = SGGeod::fromCart(Rear);
284 double front_elev_m = 0;
285 double rear_elev_m = 0;
286 double elev_front = 0;
287 double elev_rear = 0;
288 //double max_alt = 10000;
290 if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(geodFront, 3000),
291 elev_front, &_material, 0)){
292 front_elev_m = elev_front + _z_offset_m;
296 if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(geodRear, 3000),
297 elev_rear, &_material, 0)){
298 rear_elev_m = elev_rear;
303 double diff = front_elev_m - rear_elev_m;
304 _pitch = atan2 (diff,
305 fabs(contact_offset_x1_m) + fabs(contact_offset_x2_m)) * SG_RADIANS_TO_DEGREES;
306 _elevation = (rear_elev_m + diff/2) * SG_METER_TO_FEET;
308 double diff = rear_elev_m - front_elev_m;
309 _pitch = atan2 (diff,
310 fabs(contact_offset_x1_m) + fabs(contact_offset_x2_m)) * SG_RADIANS_TO_DEGREES;
311 _elevation = (front_elev_m + diff/2) * SG_METER_TO_FEET;
317 if (prev->altitude == 0 || curr->altitude == 0) return false;
319 static double distance;
321 static double curr_alt;
322 static double prev_alt;
325 //cout << "new waypoint, calculating pitch " << endl;
326 curr_alt = curr->altitude;
327 prev_alt = prev->altitude;
328 //cout << "prev_alt" <<prev_alt << endl;
329 d_alt = (curr_alt - prev_alt) * SG_METER_TO_FEET;
330 //_elevation = prev->altitude;
331 distance = SGGeodesy::distanceM(SGGeod::fromDeg(prev->longitude, prev->latitude),
332 SGGeod::fromDeg(curr->longitude, curr->latitude));
333 _pitch = atan2(d_alt, distance * SG_METER_TO_FEET) * SG_RADIANS_TO_DEGREES;
334 //cout << "new waypoint, calculating pitch " << _pitch <<
335 // " " << _pitch_offset << " " << _elevation <<endl;
338 double distance_to_go = SGGeodesy::distanceM(SGGeod::fromDeg(pos.getLongitudeDeg(), pos.getLatitudeDeg()),
339 SGGeod::fromDeg(curr->longitude, curr->latitude));
341 /*cout << "tunnel " << _tunnel
342 << " distance prev & curr " << prev->name << " " << curr->name << " " << distance * SG_METER_TO_FEET
343 << " distance to go " << distance_to_go * SG_METER_TO_FEET
344 << " d_alt ft " << d_alt
347 if (distance_to_go > distance)
348 _elevation = prev_alt;
350 _elevation = curr_alt - (tan(_pitch * SG_DEGREES_TO_RADIANS) * distance_to_go * SG_METER_TO_FEET);
357 void FGAIGroundVehicle::setParent(){
359 double lat = _selected_ac->getDoubleValue("position/latitude-deg");
360 double lon = _selected_ac->getDoubleValue("position/longitude-deg");
361 double elevation = _selected_ac->getDoubleValue("position/altitude-ft");
363 _selectedpos.setLatitudeDeg(lat);
364 _selectedpos.setLongitudeDeg(lon);
365 _selectedpos.setElevationFt(elevation);
367 _parent_speed = _selected_ac->getDoubleValue("velocities/true-airspeed-kt");
369 SGVec3d rear_hitch(-_hitch_x_offset_m, _hitch_y_offset_m, 0);
370 SGVec3d RearHitch = getCartHitchPosAt(rear_hitch);
372 SGGeod rearpos = SGGeod::fromCart(RearHitch);
374 double user_lat = rearpos.getLatitudeDeg();
375 double user_lon = rearpos.getLongitudeDeg();
377 double range, bearing;
379 calcRangeBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(),
380 user_lat, user_lon, range, bearing);
381 _range_ft = range * 6076.11549;
382 _relbrg = calcRelBearingDeg(bearing, hdg);
385 void FGAIGroundVehicle::calcRangeBearing(double lat, double lon, double lat2, double lon2,
386 double &range, double &bearing) const
388 // calculate the bearing and range of the second pos from the first
389 double az2, distance;
390 geo_inverse_wgs_84(lat, lon, lat2, lon2, &bearing, &az2, &distance);
391 range = distance * SG_METER_TO_NM;
394 double FGAIGroundVehicle::calcRelBearingDeg(double bearing, double heading)
396 double angle = bearing - heading;
397 SG_NORMALIZE_RANGE(angle, -180.0, 180.0);
401 SGVec3d FGAIGroundVehicle::getCartHitchPosAt(const SGVec3d& _off) const {
402 double hdg = _selected_ac->getDoubleValue("orientation/true-heading-deg");
403 double pitch = _selected_ac->getDoubleValue("orientation/pitch-deg");
404 double roll = _selected_ac->getDoubleValue("orientation/roll-deg");
406 // Transform that one to the horizontal local coordinate system.
407 SGQuatd hlTrans = SGQuatd::fromLonLat(_selectedpos);
409 // and postrotate the orientation of the AIModel wrt the horizontal
411 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
413 // The offset converted to the usual body fixed coordinate system
414 // rotated to the earth fiexed coordinates axis
415 SGVec3d off = hlTrans.backTransform(_off);
417 // Add the position offset of the AIModel to gain the earth centered position
418 SGVec3d cartPos = SGVec3d::fromGeod(_selectedpos);
420 return cartPos + off;
423 void FGAIGroundVehicle::AdvanceFP(){
426 string parent_next_name =_selected_ac->getStringValue("waypoint/name-next");
428 while(fp->getNextWaypoint() != 0 && fp->getNextWaypoint()->name != "END" && count < 5){
429 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
430 <<" advancing waypoint to: " << parent_next_name);
432 if (fp->getNextWaypoint()->name == parent_next_name){
433 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
434 << " not setting waypoint already at: " << fp->getNextWaypoint()->name);
439 fp->IncrementWaypoint(false);
440 curr = fp->getCurrentWaypoint();
441 next = fp->getNextWaypoint();
443 if (fp->getNextWaypoint()->name == parent_next_name){
444 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
445 << " waypoint set to: " << fp->getNextWaypoint()->name);
453 while(fp->getPreviousWaypoint() != 0 && fp->getPreviousWaypoint()->name != "END"
455 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
456 << " retreating waypoint to: " << parent_next_name
457 << " at: " << fp->getNextWaypoint()->name);
459 if (fp->getNextWaypoint()->name == parent_next_name){
460 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
461 << " not setting waypoint already at:" << fp->getNextWaypoint()->name );
466 fp->DecrementWaypoint(false);
467 curr = fp->getCurrentWaypoint();
468 next = fp->getNextWaypoint();
470 if (fp->getNextWaypoint()->name == parent_next_name){
471 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
472 << " waypoint set to: " << fp->getNextWaypoint()->name);
481 void FGAIGroundVehicle::setTowSpeed(){
483 //double diff = _range_ft - _x_offset;
486 if (_range_ft > _x_offset * 3) x = 50;
488 if (_relbrg < -90 || _relbrg > 90){
489 setSpeed(_parent_speed - 5 - x);
490 //cout << _name << " case 1r _relbrg spd - 5 " << _relbrg << " " << diff << endl;
491 }else if (_range_ft > _x_offset + 0.25 && _relbrg >= -90 && _relbrg <= 90){
492 setSpeed(_parent_speed + 1 + x);
493 //cout << _name << " case 2r _relbrg spd + 1 " << _relbrg << " "
494 // << diff << " range " << _range_ft << endl;
495 } else if (_range_ft < _x_offset - 0.25 && _relbrg >= -90 && _relbrg <= 90){
496 setSpeed(_parent_speed - 1 - x);
497 //cout << _name << " case 3r _relbrg spd - 2 " << _relbrg << " "
498 // << diff << " " << _range_ft << endl;
500 setSpeed(_parent_speed);
501 //cout << _name << " else r _relbrg " << _relbrg << " " << diff << endl;
506 void FGAIGroundVehicle::RunGroundVehicle(double dt){
510 ///////////////////////////////////////////////////////////////////////////
511 // Check execution time (currently once every 0.05 sec or 20 fps)
512 // Add a bit of randomization to prevent the execution of all flight plans
513 // in synchrony, which can add significant periodic framerate flutter.
514 // Randomization removed to get better appearance
515 ///////////////////////////////////////////////////////////////////////////
517 //cout << "_start_sec " << _start_sec << " time_sec " << time_sec << endl;
518 if (_dt_count < _next_run)
521 _next_run = 0.05 /*+ (0.015 * sg_random())*/;
524 setElevation(_elevation, _dt_count, _elevation_coeff);
525 ClimbTo(_elevation_ft);
526 setPitch(_pitch, _dt_count, _pitch_coeff);
531 AccelTo(prev->speed);
538 string parent_next_name = _selected_ac->getStringValue("waypoint/name-next");
539 bool parent_waiting = _selected_ac->getBoolValue("waypoint/waiting");
540 //bool parent_restart = _selected_ac->getBoolValue("controls/restart");
542 if (parent_next_name == "END" && fp->getNextWaypoint()->name != "END" ){
543 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
544 << " setting END: getting new waypoints ");
547 setTunnel(_initial_tunnel);
548 if(_restart) _missed_count = 200;
549 /*} else if (parent_next_name == "WAIT" && fp->getNextWaypoint()->name != "WAIT" ){*/
550 } else if (parent_waiting && !_waiting){
551 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
552 << " setting WAIT/WAITUNTIL: getting new waypoints ");
556 } else if (parent_next_name != "WAIT" && fp->getNextWaypoint()->name == "WAIT"){
557 SG_LOG(SG_GENERAL, SG_DEBUG, "AIGroundVeh1cle: " << _name
558 << " wait done: getting new waypoints ");
561 fp->IncrementWaypoint(false);
562 next = fp->getNextWaypoint();
564 if (next->name == "WAITUNTIL" || next->name == "WAIT"
565 || next->name == "END"){
568 fp->IncrementWaypoint(false);
569 curr = fp->getCurrentWaypoint();
570 next = fp->getNextWaypoint();
574 } else if (_range_ft > (_x_offset +_parent_x_offset)* 4
576 SG_LOG(SG_GENERAL, SG_ALERT, "AIGroundVeh1cle: " << _name
577 << " rescue: reforming train " << _range_ft
580 setTowAngle(0, dt, 1);
581 setSpeed(_parent_speed + (10 * sign(_parent_speed)));
583 } else if (_parent_speed > 1){
586 setTowAngle(_relbrg, dt, 1);
588 } else if (_parent_speed < -1){
593 setTowAngle(-(180 - (360 + _relbrg)), dt, 1);
595 setTowAngle(-(180 - _relbrg), dt, 1);
598 setSpeed(_parent_speed);
600 // FGAIShip::update(_dt_count);
605 // end AIGroundvehicle