1 // FGAIPlane - abstract base class for an AI plane
3 // Written by David Luff, started 2002.
5 // Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk
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., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef _FG_AI_PLANE_HXX
22 #define _FG_AI_PLANE_HXX
26 #include <simgear/math/point3d.hxx>
27 #include <simgear/scene/model/model.hxx>
29 #include "AIEntity.hxx"
47 ostream& operator << (ostream& os, PatternLeg pl);
56 ostream& operator << (ostream& os, LandingType lt);
58 /*****************************************************************
60 * FGAIPlane - this class is derived from FGAIEntity and adds the
61 * practical requirement for an AI plane - the ability to send radio
62 * communication, and simple performance details for the actual AI
63 * implementation to use. The AI implementation is expected to be
64 * in derived classes - this class does nothing useful on its own.
66 ******************************************************************/
67 class FGAIPlane : public FGAIEntity {
74 // Run the internal calculations
75 virtual void Update(double dt);
77 // Send a transmission *TO* the AIPlane.
78 // FIXME int code is a hack - eventually this will receive Alexander's coded messages.
79 virtual void RegisterTransmission(int code);
81 // Return the current pattern leg the plane is flying.
82 inline PatternLeg GetLeg() {return leg;}
84 // Return what type of landing we're doing on this circuit
85 LandingType GetLandingOption();
90 double mag_hdg; // degrees - the heading that the physical aircraft is *pointing*
91 double track; // track that the physical aircraft is *following* - degrees relative to *true* north
92 double crab; // Difference between heading and track due to wind.
93 double mag_var; // degrees
94 double IAS; // Indicated airspeed in knots
95 double vel; // velocity along track in knots
96 double vel_si; // velocity along track in m/s
97 double slope; // Actual slope that the plane is flying (degrees) - +ve is uphill
98 double AoA; // degrees - difference between slope and pitch
99 // We'll assume that the plane doesn't yaw or slip - the track/heading difference is to allow for wind
101 double freq; // The comm frequency that we're operating on
103 // We need some way for this class to display its radio transmissions if on the
104 // same frequency and in the vicinity of the user's aircraft
105 // This may need to be done independently of ATC eg CTAF
106 // Make radio transmission - this simply sends the transmission for physical rendering if the users
107 // aircraft is on the same frequency and in range. It is up to the derived classes to let ATC know
109 void Transmit(string msg);
111 void Bank(double angle);
112 void LevelWings(void);
117 #endif // _FG_AI_PLANE_HXX