]> git.mxchange.org Git - flightgear.git/blob - src/AIModel/AICarrier.cxx
fae5d26bc38b91b76ee9028d99b8d091a117ca78
[flightgear.git] / src / AIModel / AICarrier.cxx
1 // FGAICarrier - FGAIShip-derived class creates an AI aircraft carrier
2 //
3 // Written by David Culp, started October 2004.
4 // - davidculp2@comcast.net
5 //
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.
10 //
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.
15 //
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.
19
20 #ifdef HAVE_CONFIG_H
21 #  include <config.h>
22 #endif
23
24 #include <algorithm>
25 #include <string>
26 #include <vector>
27
28 #include <simgear/sg_inlines.h>
29 #include <simgear/math/sg_geodesy.hxx>
30
31 #include <math.h>
32 #include <Main/util.hxx>
33
34 #include "AICarrier.hxx"
35
36 FGAICarrier::FGAICarrier() : FGAIShip(otCarrier) {
37 }
38
39 FGAICarrier::~FGAICarrier() {
40 }
41
42 void FGAICarrier::readFromScenario(SGPropertyNode* scFileNode) {
43   if (!scFileNode)
44     return;
45
46   FGAIShip::readFromScenario(scFileNode);
47
48   setRadius(scFileNode->getDoubleValue("turn-radius-ft", 2000));
49   setSign(scFileNode->getStringValue("pennant-number"));
50   setWind_from_east(scFileNode->getDoubleValue("wind_from_east", 0));
51   setWind_from_north(scFileNode->getDoubleValue("wind_from_north", 0));
52   setTACANChannelID(scFileNode->getStringValue("TACAN-channel-ID", "029Y"));
53   setMaxLat(scFileNode->getDoubleValue("max-lat", 0));
54   setMinLat(scFileNode->getDoubleValue("min-lat", 0));
55   setMaxLong(scFileNode->getDoubleValue("max-long", 0));
56   setMinLong(scFileNode->getDoubleValue("min-long", 0));
57   setMPControl(scFileNode->getBoolValue("mp-control", false));
58   setAIControl(scFileNode->getBoolValue("ai-control", false));
59   setCallSign(scFileNode->getStringValue("callsign", ""));
60
61
62   SGPropertyNode* flols = scFileNode->getChild("flols-pos");
63   if (flols) {
64     // Transform to the right coordinate frame, configuration is done in
65     // the usual x-back, y-right, z-up coordinates, computations
66     // in the simulation usual body x-forward, y-right, z-down coordinates
67     flols_off(0) = - flols->getDoubleValue("x-offset-m", 0);
68     flols_off(1) = flols->getDoubleValue("y-offset-m", 0);
69     flols_off(2) = - flols->getDoubleValue("z-offset-m", 0);
70   } else
71     flols_off = SGVec3d::zeros();
72
73   std::vector<SGPropertyNode_ptr> props = scFileNode->getChildren("parking-pos");
74   std::vector<SGPropertyNode_ptr>::const_iterator it;
75   for (it = props.begin(); it != props.end(); ++it) {
76     const string name = (*it)->getStringValue("name", "unnamed");
77     // Transform to the right coordinate frame, configuration is done in
78     // the usual x-back, y-right, z-up coordinates, computations
79     // in the simulation usual body x-forward, y-right, z-down coordinates
80     double offset_x = -(*it)->getDoubleValue("x-offset-m", 0);
81     double offset_y = (*it)->getDoubleValue("y-offset-m", 0);
82     double offset_z = -(*it)->getDoubleValue("z-offset-m", 0);
83     double hd = (*it)->getDoubleValue("heading-offset-deg", 0);
84     ParkPosition pp(name, SGVec3d(offset_x, offset_y, offset_z), hd);
85     ppositions.push_back(pp);
86   }
87 }
88
89 void FGAICarrier::setWind_from_east(double fps) {
90     wind_from_east = fps;
91 }
92
93 void FGAICarrier::setWind_from_north(double fps) {
94     wind_from_north = fps;
95 }
96
97 void FGAICarrier::setMaxLat(double deg) {
98     max_lat = fabs(deg);
99 }
100
101 void FGAICarrier::setMinLat(double deg) {
102     min_lat = fabs(deg);
103 }
104
105 void FGAICarrier::setMaxLong(double deg) {
106     max_long = fabs(deg);
107 }
108
109 void FGAICarrier::setMinLong(double deg) {
110     min_long = fabs(deg);
111 }
112
113 void FGAICarrier::setSign(const string& s) {
114     sign = s;
115 }
116
117 void FGAICarrier::setTACANChannelID(const string& id) {
118     TACAN_channel_id = id;
119 }
120
121 void FGAICarrier::setMPControl(bool c) {
122     MPControl = c;
123 }
124
125 void FGAICarrier::setAIControl(bool c) {
126     AIControl = c;
127 }
128
129 void FGAICarrier::update(double dt) {
130     // Now update the position and heading. This will compute new hdg and
131     // roll values required for the rotation speed computation.
132     FGAIShip::update(dt);
133
134     //automatic turn into wind with a target wind of 25 kts otd
135     //SG_LOG(SG_AI, SG_ALERT, "AICarrier: MPControl " << MPControl << " AIControl " << AIControl);
136     if (!MPControl && AIControl){
137
138         if(turn_to_launch_hdg){
139             TurnToLaunch();
140         } else if(turn_to_recovery_hdg ){
141             TurnToRecover();
142         } else if(OutsideBox() || returning ) {// check that the carrier is inside
143             ReturnToBox();                     // the operating box,
144         } else {
145             TurnToBase();
146         }
147
148     } else {
149         FGAIShip::TurnTo(tgt_heading);
150         FGAIShip::AccelTo(tgt_speed);
151     }
152
153     UpdateWind(dt);
154     UpdateElevator(dt, transition_time);
155     UpdateJBD(dt, jbd_transition_time);
156
157     // Transform that one to the horizontal local coordinate system.
158     SGQuatd ec2hl = SGQuatd::fromLonLat(pos);
159     // The orientation of the carrier wrt the horizontal local frame
160     SGQuatd hl2body = SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
161     // and postrotate the orientation of the AIModel wrt the horizontal
162     // local frame
163     SGQuatd ec2body = ec2hl*hl2body;
164     // The cartesian position of the carrier in the wgs84 world
165     SGVec3d cartPos = SGVec3d::fromGeod(pos);
166
167     // The position of the eyepoint - at least near that ...
168     SGVec3d eyePos(globals->get_view_position_cart());
169     // Add the position offset of the AIModel to gain the earth
170     // centered position
171     SGVec3d eyeWrtCarrier = eyePos - cartPos;
172     // rotate the eyepoint wrt carrier vector into the carriers frame
173     eyeWrtCarrier = ec2body.transform(eyeWrtCarrier);
174     // the eyepoints vector wrt the flols position
175     SGVec3d eyeWrtFlols = eyeWrtCarrier - flols_off;
176
177     // the distance from the eyepoint to the flols
178     dist = norm(eyeWrtFlols);
179
180     // now the angle, positive angles are upwards
181     if (fabs(dist) < SGLimits<float>::min()) {
182       angle = 0;
183     } else {
184       double sAngle = -eyeWrtFlols(2)/dist;
185       sAngle = SGMiscd::min(1, SGMiscd::max(-1, sAngle));
186       angle = SGMiscd::rad2deg(asin(sAngle));
187     }
188
189     // set the value of source
190     if ( angle <= 4.35 && angle > 4.01 )
191       source = 1;
192     else if ( angle <= 4.01 && angle > 3.670 )
193       source = 2;
194     else if ( angle <= 3.670 && angle > 3.330 )
195       source = 3;
196     else if ( angle <= 3.330 && angle > 2.990 )
197       source = 4;
198     else if ( angle <= 2.990 && angle > 2.650 )
199       source = 5;
200     else if ( angle <= 2.650 )
201       source = 6;
202     else
203       source = 0;
204 } //end update
205
206 bool FGAICarrier::init(bool search_in_AI_path) {
207     if (!FGAIShip::init(search_in_AI_path))
208         return false;
209
210     _longitude_node = fgGetNode("/position/longitude-deg", true);
211     _latitude_node = fgGetNode("/position/latitude-deg", true);
212     _altitude_node = fgGetNode("/position/altitude-ft", true);
213
214     _launchbar_state_node = fgGetNode("/gear/launchbar/state", true);
215
216     _surface_wind_from_deg_node =
217             fgGetNode("/environment/config/boundary/entry[0]/wind-from-heading-deg", true);
218     _surface_wind_speed_node =
219             fgGetNode("/environment/config/boundary/entry[0]/wind-speed-kt", true);
220
221
222     turn_to_launch_hdg = false;
223     turn_to_recovery_hdg = false;
224     turn_to_base_course = true;
225     returning = false;
226     in_to_wind = false;
227
228     mOpBoxPos = pos;
229     base_course = hdg;
230     base_speed = speed;
231
232     pos_norm = raw_pos_norm = 0;
233     elevators = false;
234     transition_time = 150;
235     time_constant = 0.005;
236     jbd_pos_norm = raw_jbd_pos_norm = 0;
237     jbd = false ;
238     jbd_transition_time = 3;
239     jbd_time_constant = 0.1;
240     return true;
241 }
242
243 void FGAICarrier::bind() {
244     FGAIShip::bind();
245
246     props->untie("velocities/true-airspeed-kt");
247
248     tie("controls/flols/source-lights",
249         SGRawValuePointer<int>(&source));
250     tie("controls/flols/distance-m",
251         SGRawValuePointer<double>(&dist));
252     tie("controls/flols/angle-degs",
253         SGRawValuePointer<double>(&angle));
254     tie("controls/turn-to-launch-hdg",
255         SGRawValuePointer<bool>(&turn_to_launch_hdg));
256     tie("controls/in-to-wind",
257         SGRawValuePointer<bool>(&turn_to_launch_hdg));
258     tie("controls/base-course-deg",
259         SGRawValuePointer<double>(&base_course));
260     tie("controls/base-speed-kts",
261         SGRawValuePointer<double>(&base_speed));
262     tie("controls/start-pos-lat-deg",
263         SGRawValueMethods<SGGeod,double>(pos, &SGGeod::getLatitudeDeg));
264     tie("controls/start-pos-long-deg",
265         SGRawValueMethods<SGGeod,double>(pos, &SGGeod::getLongitudeDeg));
266     tie("controls/mp-control",
267         SGRawValuePointer<bool>(&MPControl));
268     tie("controls/ai-control",
269         SGRawValuePointer<bool>(&AIControl));
270     tie("environment/surface-wind-speed-true-kts",
271         SGRawValuePointer<double>(&wind_speed_kts));
272     tie("environment/surface-wind-from-true-degs",
273         SGRawValuePointer<double>(&wind_from_deg));
274     tie("environment/rel-wind-from-degs",
275         SGRawValuePointer<double>(&rel_wind_from_deg));
276     tie("environment/rel-wind-from-carrier-hdg-degs",
277         SGRawValuePointer<double>(&rel_wind));
278     tie("environment/rel-wind-speed-kts",
279         SGRawValuePointer<double>(&rel_wind_speed_kts));
280     tie("environment/in-to-wind",
281         SGRawValuePointer<bool>(&in_to_wind));
282     //tie("controls/flols/wave-off-lights",
283     //    SGRawValuePointer<bool>(&wave_off_lights));
284     tie("controls/elevators",
285         SGRawValuePointer<bool>(&elevators));
286     tie("surface-positions/elevators-pos-norm",
287         SGRawValuePointer<double>(&pos_norm));
288     tie("controls/constants/elevators/trans-time-s",
289         SGRawValuePointer<double>(&transition_time));
290     tie("controls/constants/elevators/time-constant",
291         SGRawValuePointer<double>(&time_constant));
292     tie("controls/jbd",
293         SGRawValuePointer<bool>(&jbd));
294     tie("surface-positions/jbd-pos-norm",
295         SGRawValuePointer<double>(&jbd_pos_norm));
296     tie("controls/constants/jbd/trans-time-s",
297         SGRawValuePointer<double>(&jbd_transition_time));
298     tie("controls/constants/jbd/time-constant",
299         SGRawValuePointer<double>(&jbd_time_constant));
300     tie("controls/turn-to-recovery-hdg",
301         SGRawValuePointer<bool>(&turn_to_recovery_hdg));
302     tie("controls/turn-to-base-course",
303         SGRawValuePointer<bool>(&turn_to_base_course));
304
305     props->setBoolValue("controls/flols/cut-lights", false);
306     props->setBoolValue("controls/flols/wave-off-lights", false);
307     props->setBoolValue("controls/flols/cond-datum-lights", true);
308     props->setBoolValue("controls/crew", false);
309     props->setStringValue("navaids/tacan/channel-ID", TACAN_channel_id.c_str());
310     props->setStringValue("sign", sign.c_str());
311     props->setBoolValue("controls/lighting/deck-lights", false);
312     props->setDoubleValue("controls/lighting/flood-lights-red-norm", 0);
313 }
314
315 bool FGAICarrier::getParkPosition(const string& id, SGGeod& geodPos,
316                                   double& hdng, SGVec3d& uvw)
317 {
318
319     // FIXME: does not yet cover rotation speeds.
320     list<ParkPosition>::iterator it = ppositions.begin();
321     while (it != ppositions.end()) {
322         // Take either the specified one or the first one ...
323         if ((*it).name == id || id.empty()) {
324             ParkPosition ppos = *it;
325             SGVec3d cartPos = getCartPosAt(ppos.offset);
326             geodPos = SGGeod::fromCart(cartPos);
327             hdng = hdg + ppos.heading_deg;
328             double shdng = sin(ppos.heading_deg * SGD_DEGREES_TO_RADIANS);
329             double chdng = cos(ppos.heading_deg * SGD_DEGREES_TO_RADIANS);
330             double speed_fps = speed*1.6878099;
331             uvw = SGVec3d(chdng*speed_fps, shdng*speed_fps, 0);
332             return true;
333         }
334         ++it;
335     }
336
337     return false;
338 }
339
340 // find relative wind
341 void FGAICarrier::UpdateWind( double dt) {
342
343     //get the surface wind speed and direction
344     wind_from_deg = _surface_wind_from_deg_node->getDoubleValue();
345     wind_speed_kts  = _surface_wind_speed_node->getDoubleValue();
346
347     //calculate the surface wind speed north and east in kts
348     double wind_speed_from_north_kts = cos( wind_from_deg / SGD_RADIANS_TO_DEGREES )* wind_speed_kts ;
349     double wind_speed_from_east_kts  = sin( wind_from_deg / SGD_RADIANS_TO_DEGREES )* wind_speed_kts ;
350
351     //calculate the carrier speed north and east in kts
352     double speed_north_kts = cos( hdg / SGD_RADIANS_TO_DEGREES )* speed ;
353     double speed_east_kts  = sin( hdg / SGD_RADIANS_TO_DEGREES )* speed ;
354
355     //calculate the relative wind speed north and east in kts
356     double rel_wind_speed_from_east_kts = wind_speed_from_east_kts + speed_east_kts;
357     double rel_wind_speed_from_north_kts = wind_speed_from_north_kts + speed_north_kts;
358
359     //combine relative speeds north and east to get relative windspeed in kts
360     rel_wind_speed_kts = sqrt((rel_wind_speed_from_east_kts * rel_wind_speed_from_east_kts)
361     + (rel_wind_speed_from_north_kts * rel_wind_speed_from_north_kts));
362
363     //calculate the relative wind direction
364     rel_wind_from_deg = atan2(rel_wind_speed_from_east_kts, rel_wind_speed_from_north_kts)
365                             * SG_RADIANS_TO_DEGREES;
366
367     //calculate rel wind
368     rel_wind = rel_wind_from_deg - hdg;
369     SG_NORMALIZE_RANGE(rel_wind, -180.0, 180.0);
370
371     //set in to wind property
372     InToWind();
373
374     //switch the wave-off lights
375     //if (InToWind())
376     //   wave_off_lights = false;
377     //else
378     //   wave_off_lights = true;
379
380     // cout << "rel wind: " << rel_wind << endl;
381
382 }// end update wind
383
384
385 void FGAICarrier::TurnToLaunch(){
386
387     // calculate tgt heading
388     if (wind_speed_kts < 3){
389         tgt_heading = base_course;
390     } else {
391         tgt_heading = wind_from_deg;
392     }
393
394     //calculate tgt speed
395     double tgt_speed = 25 - wind_speed_kts;
396     if (tgt_speed < 10)
397         tgt_speed = 10;
398
399     //turn the carrier
400     FGAIShip::TurnTo(tgt_heading);
401     FGAIShip::AccelTo(tgt_speed);
402
403 }
404
405 void FGAICarrier::TurnToRecover(){
406
407     //these are the rules for adjusting heading to provide a relative wind
408     //down the angled flightdeck
409
410     if (wind_speed_kts < 3){
411         tgt_heading = base_course + 60;
412     } else if (rel_wind < -9 && rel_wind >= -180){
413         tgt_heading = wind_from_deg;
414     } else if (rel_wind > -7 && rel_wind < 45){
415         tgt_heading = wind_from_deg + 60;
416     } else if (rel_wind >=45 && rel_wind < 180){
417         tgt_heading = wind_from_deg + 45;
418     } else
419         tgt_heading = hdg;
420
421     SG_NORMALIZE_RANGE(tgt_heading, 0.0, 360.0);
422
423     //calculate tgt speed
424     double tgt_speed = 26 - wind_speed_kts;
425     if (tgt_speed < 10)
426         tgt_speed = 10;
427
428     //turn the carrier
429     FGAIShip::TurnTo(tgt_heading);
430     FGAIShip::AccelTo(tgt_speed);
431
432 }
433 void FGAICarrier::TurnToBase(){
434
435     //turn the carrier
436     FGAIShip::TurnTo(base_course);
437     FGAIShip::AccelTo(base_speed);
438
439 }
440
441
442 void FGAICarrier::ReturnToBox(){
443     double course, distance, az2;
444
445     //calculate the bearing and range of the initial position from the carrier
446     geo_inverse_wgs_84(pos, mOpBoxPos, &course, &az2, &distance);
447
448     distance *= SG_METER_TO_NM;
449
450     //cout << "return course: " << course << " distance: " << distance << endl;
451     //turn the carrier
452     FGAIShip::TurnTo(course);
453     FGAIShip::AccelTo(base_speed);
454
455     if (distance >= 1)
456         returning = true;
457     else
458         returning = false;
459
460 } //  end turn to base
461
462
463 bool FGAICarrier::OutsideBox() { //returns true if the carrier is outside operating box
464
465     if ( max_lat == 0 && min_lat == 0 && max_long == 0 && min_long == 0) {
466         SG_LOG(SG_AI, SG_DEBUG, "AICarrier: No Operating Box defined" );
467         return false;
468     }
469
470     if (mOpBoxPos.getLatitudeDeg() >= 0) { //northern hemisphere
471         if (pos.getLatitudeDeg() >= mOpBoxPos.getLatitudeDeg() + max_lat)
472             return true;
473
474         if (pos.getLatitudeDeg() <= mOpBoxPos.getLatitudeDeg() - min_lat)
475             return true;
476
477     } else {                  //southern hemisphere
478         if (pos.getLatitudeDeg() <= mOpBoxPos.getLatitudeDeg() - max_lat)
479             return true;
480
481         if (pos.getLatitudeDeg() >= mOpBoxPos.getLatitudeDeg() + min_lat)
482             return true;
483     }
484
485     if (mOpBoxPos.getLongitudeDeg() >=0) { //eastern hemisphere
486         if (pos.getLongitudeDeg() >= mOpBoxPos.getLongitudeDeg() + max_long)
487             return true;
488
489         if (pos.getLongitudeDeg() <= mOpBoxPos.getLongitudeDeg() - min_long)
490             return true;
491
492     } else {                 //western hemisphere
493         if (pos.getLongitudeDeg() <= mOpBoxPos.getLongitudeDeg() - max_long)
494             return true;
495
496         if (pos.getLongitudeDeg() >= mOpBoxPos.getLongitudeDeg() + min_long)
497             return true;
498     }
499
500     return false;
501
502 } // end OutsideBox
503
504
505 bool FGAICarrier::InToWind() {
506     in_to_wind = false;
507
508     if ( fabs(rel_wind) < 10 ){
509         in_to_wind = true;
510         return true;
511     }
512     return false;
513 }
514
515
516 void FGAICarrier::UpdateElevator(double dt, double transition_time) {
517
518     double step = 0;
519
520     if ((elevators && pos_norm >= 1 ) || (!elevators && pos_norm <= 0 ))
521         return;
522
523     // move the elevators
524     if ( elevators ) {
525         step = dt/transition_time;
526         if ( step > 1 )
527             step = 1;
528     } else {
529         step = -dt/transition_time;
530         if ( step < -1 )
531             step = -1;
532     }
533     // assume a linear relationship
534     raw_pos_norm += step;
535
536     //low pass filter
537     pos_norm = (raw_pos_norm * time_constant) + (pos_norm * (1 - time_constant));
538
539     //sanitise the output
540     if (raw_pos_norm >= 1) {
541         raw_pos_norm = 1;
542     } else if (raw_pos_norm <= 0) {
543         raw_pos_norm = 0;
544     }
545     return;
546
547 } // end UpdateElevator
548
549 void FGAICarrier::UpdateJBD(double dt, double jbd_transition_time) {
550
551     const string launchbar_state = _launchbar_state_node->getStringValue();
552     double step = 0;
553
554     if (launchbar_state == "Engaged"){
555         jbd = true;
556     } else {
557         jbd = false;
558     }
559
560     if (( jbd && jbd_pos_norm >= 1 ) || ( !jbd && jbd_pos_norm <= 0 )){
561         return;
562     }
563
564     // move the jbds
565     if ( jbd ) {
566         step = dt/jbd_transition_time;
567         if ( step > 1 )
568             step = 1;
569     } else {
570         step = -dt/jbd_transition_time;
571         if ( step < -1 )
572             step = -1;
573     }
574
575     // assume a linear relationship
576     raw_jbd_pos_norm += step;
577
578     //low pass filter
579     jbd_pos_norm = (raw_jbd_pos_norm * jbd_time_constant) + (jbd_pos_norm * (1 - jbd_time_constant));
580
581     //sanitise the output
582     if (jbd_pos_norm >= 1) {
583         jbd_pos_norm = 1;
584     } else if (jbd_pos_norm <= 0) {
585         jbd_pos_norm = 0;
586     }
587
588     return;
589
590 } // end UpdateJBD