All Classes Functions
AutopilotBase.hpp
1 // ==============================================================
2 // ORBITER MODULE: LaunchMFD
3 // Part of the ORBITER SDK
4 //
5 // Copyright (C) 2004 rjcroy - robust time based pitch autopilot (borrowed code)
6 // Copyright (C) 2004 Dave "Daver" Rowbotham - conversion of rjcroy's autopolot to C++ (borrowed code)
7 // Copyright (C) 2004 Erik H. "Sputnik" Anderson - conversion of the autopilot to energy based (borrowed code)
8 // Copyright (C) 2007 "Vanguard" - dressing up azimuth calcualtions into an MFD (author)
9 // Copyright (C) 2007 Pawel "She'da'Lier" Stiasny - yaw error visual representation (contributor)
10 // Copyright (C) 2008 Mohd "Computerex" Ali - borrowed his code (multiple vessels support) (borrowed code)
11 // Copyright (C) 2008 Chris "Kwan" Jeppesen - borrowed his code (peg guidance) (borrowed code)
12 // Copyright (C) 2008 Steve "agentgonzo" Arch - peg integration, offplane correction, compass, hud display (co-developer)
13 // Copyright (C) 2007-2012 Szymon "Enjo" Ender - everything else ;> (author and maintainer)
14 // All rights reserved
15 //
16 // Authors - Szymon "Enjo" Ender
17 //
18 // This module calculates the appropriate launch azimuth given
19 // desired orbital inclination and desired orbit altitude. This
20 // MFD takes the planets rotation into account, which provides a
21 // much more accurate azimuth. The calculations are performed
22 // 'on the fly' (technically and methaphorically), meaning that
23 // you get info about necessary course corrections.
24 //
25 // This file is part of LaunchMFD.
26 //
27 // LaunchMFD is free software: you can redistribute it and/or modify
28 // it under the terms of the GNU General Public License as published by
29 // the Free Software Foundation, either version 3 of the License, or
30 // (at your option) any later version.
31 //
32 // LaunchMFD is distributed in the hope that it will be useful,
33 // but WITHOUT ANY WARRANTY; without even the implied warranty of
34 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 // GNU General Public License for more details.
36 //
37 // You should have received a copy of the GNU General Public License
38 // along with LaunchMFD. If not, see <http://www.gnu.org/licenses/>.
39 // ==============================================================
40 
41 #ifndef AUTOPILOTBASE_HPP_INCLUDED
42 #define AUTOPILOTBASE_HPP_INCLUDED
43 
44 #include <orbitersdk.h>
45 #include <string>
46 
47 namespace EnjoLib
48 {
49  struct Point;
50  namespace MFDGoodies
51  {
52  class SimulationTimeData;
53  }
54 }
55 
56 
57 class MFDDataLaunchMFD;
59 {
60 public:
61  AutopilotBase();
62  virtual bool Guide( MFDDataLaunchMFD * data, double dt ) const;
63  virtual std::string GetIdentifier() const = 0;
64 
65 protected:
66 
67  virtual bool NeedPitch( MFDDataLaunchMFD * data ) const = 0;
68  virtual bool NeedPullUp( MFDDataLaunchMFD * data ) const = 0;
69  virtual bool NeedYaw( MFDDataLaunchMFD * data ) const = 0;
70  virtual bool NeedMECO( MFDDataLaunchMFD * data ) const = 0;
71  virtual bool TerminationRequested( MFDDataLaunchMFD * data ) const = 0;
72 
73 private:
74  bool NeedPitchMain( MFDDataLaunchMFD * data ) const;
75  double UpdateBankUpsideDown( MFDDataLaunchMFD * data, double inputBank ) const;
76  void SpaceAutopilot( MFDDataLaunchMFD * data, double dt, const EnjoLib::Point & targetVector2D, const VECTOR3 & accRatio ) const;
77  void AtmoAutopilot( MFDDataLaunchMFD * data, double dt, const EnjoLib::Point & targetVector2D, const VECTOR3 & accRatio ) const;
78  double CalculateRatioKdForAtmAP( const MFDDataLaunchMFD * data ) const;
79 };
80 
81 #endif // AUTOPILOTBASE_HPP_INCLUDED