1 // FGAIEscort - 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.
29 #include <simgear/sg_inlines.h>
30 #include <simgear/math/sg_geodesy.hxx>
31 #include <simgear/math/sg_random.h>
34 #include <Main/util.hxx>
35 #include <Main/globals.hxx>
36 #include <Viewer/viewer.hxx>
38 #include <Scenery/scenery.hxx>
40 #include "AIEscort.hxx"
44 FGAIEscort::FGAIEscort() :
64 FGAIEscort::~FGAIEscort() {}
66 void FGAIEscort::readFromScenario(SGPropertyNode* scFileNode) {
70 FGAIShip::readFromScenario(scFileNode);
72 setName(scFileNode->getStringValue("name", "Escort"));
73 setSMPath(scFileNode->getStringValue("submodel-path", ""));
74 setStnRange(scFileNode->getDoubleValue("station/range-nm", 1));
75 setStnBrg(scFileNode->getDoubleValue("station/brg-deg", 0.0));
76 setStnLimit(scFileNode->getDoubleValue("station/range-limit-nm", 0.2));
77 setStnAngleLimit(scFileNode->getDoubleValue("station/angle-limit-deg", 15.0));
78 setStnSpeed(scFileNode->getDoubleValue("station/speed-kts", 2.5));
79 setStnPatrol(scFileNode->getBoolValue("station/patrol", false));
80 setStnHtFt(scFileNode->getDoubleValue("station/height-ft", 0.0));
81 setStnDegTrue(scFileNode->getBoolValue("station/deg-true", false));
82 setParentName(scFileNode->getStringValue("station/parent", ""));
83 setMaxSpeed(scFileNode->getDoubleValue("max-speed-kts", 30.0));
84 setUpdateInterval(scFileNode->getDoubleValue("update-interval-sec", 10.0));
85 setCallSign(scFileNode->getStringValue("callsign", ""));
92 void FGAIEscort::bind() {
95 tie("station/rel-bearing-deg",
96 SGRawValuePointer<double>(&_stn_relbrg));
97 tie("station/true-bearing-deg",
98 SGRawValuePointer<double>(&_stn_truebrg));
99 tie("station/range-nm",
100 SGRawValuePointer<double>(&_stn_range));
101 tie("station/range-limit-nm",
102 SGRawValuePointer<double>(&_stn_limit));
103 tie("station/angle-limit-deg",
104 SGRawValuePointer<double>(&_stn_angle_limit));
105 tie("station/speed-kts",
106 SGRawValuePointer<double>(&_stn_speed));
107 tie("station/height-ft",
108 SGRawValuePointer<double>(&_stn_height));
109 tie("controls/update-interval-sec",
110 SGRawValuePointer<double>(&_interval));
111 tie("controls/parent-mp-control",
112 SGRawValuePointer<bool>(&_MPControl));
113 tie("station/target-range-nm",
114 SGRawValuePointer<double>(&_tgtrange));
115 tie("station/target-brg-deg-t",
116 SGRawValuePointer<double>(&_tgtbrg));
117 tie("station/patrol",
118 SGRawValuePointer<bool>(&_patrol));
121 bool FGAIEscort::init(bool search_in_AI_path) {
122 if (!FGAIShip::init(search_in_AI_path))
128 void FGAIEscort::reinit() {
132 props->setStringValue("controls/parent-name", _parent.c_str());
134 if (setParentNode()){
137 speed = _parent_speed;
144 void FGAIEscort::update(double dt) {
145 FGAIShip::update(dt);
150 void FGAIEscort::setStnRange(double r) {
154 void FGAIEscort::setStnBrg(double b) {
158 void FGAIEscort::setStnLimit(double l) {
162 void FGAIEscort::setStnAngleLimit(double al) {
163 _stn_angle_limit = al;
166 void FGAIEscort::setStnSpeed(double s) {
170 void FGAIEscort::setStnHtFt(double h) {
174 void FGAIEscort::setStnDegTrue(bool t) {
178 void FGAIEscort::setMaxSpeed(double m) {
182 void FGAIEscort::setUpdateInterval(double i) {
186 void FGAIEscort::setStnPatrol(bool p) {
190 bool FGAIEscort::getGroundElev(SGGeod inpos) {
194 const simgear::BVHMaterial* mat = 0;
195 if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(inpos, 3000), height_m, &mat, 0)){
196 const SGMaterial* material = dynamic_cast<const SGMaterial*>(mat);
197 _ht_agl_ft = inpos.getElevationFt() - height_m * SG_METER_TO_FEET;
200 const std::vector<std::string>& names = material->get_names();
202 _solid = material->get_solid();
205 props->setStringValue("material/name", names[0].c_str());
207 props->setStringValue("material/name", "");
209 //cout << "material " << names[0].c_str()
210 // << " _elevation_m " << _elevation_m
211 // << " solid " << _solid
212 // << " load " << _load_resistance
213 // << " frictionFactor " << _frictionFactor
225 void FGAIEscort::setParent()
227 double lat = _selected_ac->getDoubleValue("position/latitude-deg");
228 double lon = _selected_ac->getDoubleValue("position/longitude-deg");
229 double elevation = _selected_ac->getDoubleValue("position/altitude-ft");
230 _MPControl = _selected_ac->getBoolValue("controls/mp-control");
232 _selectedpos.setLatitudeDeg(lat);
233 _selectedpos.setLongitudeDeg(lon);
234 _selectedpos.setElevationFt(elevation);
236 _parent_speed = _selected_ac->getDoubleValue("velocities/speed-kts");
237 _parent_hdg = _selected_ac->getDoubleValue("orientation/true-heading-deg");
240 _stn_truebrg = calcTrueBearingDeg(_stn_brg, _parent_hdg);
241 _stn_relbrg = _stn_brg;
242 //cout << _name <<" set rel"<<endl;
244 _stn_truebrg = _stn_brg;
245 _stn_relbrg = calcRelBearingDeg(_stn_brg, _parent_hdg);
246 //cout << _name << " set true"<<endl;
251 SGGeodesy::direct( _selectedpos, _stn_truebrg, _stn_range * SG_NM_TO_METER,
254 _tgtpos.setElevationFt(_stn_height);
256 calcRangeBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(),
257 _tgtpos.getLatitudeDeg(), _tgtpos.getLongitudeDeg(), _tgtrange, _tgtbrg);
259 _relbrg = calcRelBearingDeg(_tgtbrg, hdg);
263 void FGAIEscort::calcRangeBearing(double lat, double lon, double lat2, double lon2,
264 double &range, double &bearing) const
266 // calculate the bearing and range of the second pos from the first
267 double az2, distance;
268 geo_inverse_wgs_84(lat, lon, lat2, lon2, &bearing, &az2, &distance);
269 range = distance * SG_METER_TO_NM;
272 double FGAIEscort::calcTrueBearingDeg(double bearing, double heading)
274 double angle = bearing + heading;
275 SG_NORMALIZE_RANGE(angle, 0.0, 360.0);
279 SGVec3d FGAIEscort::getCartHitchPosAt(const SGVec3d& _off) const {
280 double hdg = _selected_ac->getDoubleValue("orientation/true-heading-deg");
281 double pitch = _selected_ac->getDoubleValue("orientation/pitch-deg");
282 double roll = _selected_ac->getDoubleValue("orientation/roll-deg");
284 // Transform that one to the horizontal local coordinate system.
285 SGQuatd hlTrans = SGQuatd::fromLonLat(_selectedpos);
287 // and postrotate the orientation of the AIModel wrt the horizontal
289 hlTrans *= SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
291 // The offset converted to the usual body fixed coordinate system
292 // rotated to the earth fiexed coordinates axis
293 SGVec3d off = hlTrans.backTransform(_off);
295 // Add the position offset of the AIModel to gain the earth centered position
296 SGVec3d cartPos = SGVec3d::fromGeod(_selectedpos);
298 return cartPos + off;
302 void FGAIEscort::setStationSpeed(){
307 // these are the AI rules for the manoeuvring of escorts
309 if (_MPControl && _tgtrange > 4 * _stn_limit){
310 SG_LOG(SG_AI, SG_ALERT, "AIEscort: " << _name
311 << " re-aligning to MP pos");
315 }else if ((_relbrg < -90 || _relbrg > 90) && _tgtrange > _stn_limit ){
318 if(_tgtrange > 4 * _stn_limit)
319 speed = 4 * -_stn_speed;
323 }else if ((_relbrg >= -90 || _relbrg <= 90) && _tgtrange > _stn_limit){
326 if(_tgtrange > 4 * _stn_limit)
327 speed = 4 * _stn_speed;
334 angle = 15 * sg_random();
335 speed = 5 * sg_random();
343 double station_speed = _parent_speed + speed;
345 SG_CLAMP_RANGE(station_speed, 5.0, _max_speed);
346 SG_CLAMP_RANGE(angle, -_stn_angle_limit, _stn_angle_limit);
348 AccelTo(station_speed);
349 TurnTo(_parent_hdg + angle);
350 ClimbTo(_stn_height);
354 void FGAIEscort::RunEscort(double dt){
360 ///////////////////////////////////////////////////////////////////////////
361 // Check execution time (currently once every 0.05 sec or 20 fps)
362 // Add a bit of randomization to prevent the execution of all flight plans
363 // in synchrony, which can add significant periodic framerate flutter.
364 // Randomization removed to get better appearance
365 ///////////////////////////////////////////////////////////////////////////
367 //cout << "_start_sec " << _start_sec << " time_sec " << time_sec << endl;
368 if (_dt_count < _next_run)
370 _next_run = _interval /*+ (0.015 * sg_random())*/;