src/Main/globals.hxx

   1 // globals.hxx -- Global state that needs to be shared among the sim modules
   2 //
   3 // Written by Curtis Olson, started July 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _GLOBALS_HXX
  25 #define _GLOBALS_HXX
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <vector>
  30 #include STL_STRING
  31
  32 SG_USING_STD( vector );
  33 SG_USING_STD( string );
  34
  35 typedef vector<string> string_list;
  36
  37
  38 // Forward declarations
  39
  40 // This file is included, directly or indirectly, almost everywhere in
  41 // FlightGear, so if any of its dependencies changes, most of the sim
  42 // has to be recompiled.  Using these forward declarations helps us to
  43 // avoid including a lot of header files (and thus, a lot of
  44 // dependencies).  Since Most of the methods simply set or return
  45 // pointers, we don't need to know anything about the class details
  46 // anyway.
  47
  48 class SGEphemeris;
  49 class SGMagVar;
  50 class SGRoute;
  51 class SGTime;
  52 class SGPropertyNode;
  53 class SGCommandMgr;
  54
  55 class FGLogger;
  56 class FGEnvironmentMgr;
  57 class FGEnvironment;
  58 class FGControls;
  59 class FGSoundMgr;
  60 class FGAutopilot;
  61 class FGFX;
  62 class FGViewMgr;
  63 class FGViewer;
  64 class FGATCMgr;
  65 class FGATCDisplay;
  66 class FGAIMgr;
  67 class FGAircraftModel;
  68
  69
  70 /**
  71  * Bucket for subsystem pointers representing the sim's state.
  72  */
  73 class FGGlobals
  74 {
  75
  76 private:
  77
  78     // Number of milliseconds elapsed since the start of the program.
  79     long elapsed_time_ms;
  80
  81     // Root of FlightGear data tree
  82     string fg_root;
  83
  84     // Root of FlightGear scenery tree
  85     string fg_scenery;
  86
  87 #if 0
  88     // Freeze sim
  89     bool freeze;
  90 #endif
  91
  92     // Fullscreen mode for old 3DFX cards.
  93 #if defined(FX) && defined(XMESA)
  94     bool fullscreen;
  95 #endif
  96
  97     // An offset in seconds from the true time.  Allows us to adjust
  98     // the effective time of day.
  99     long int warp;
 100
 101     // How much to change the value of warp each iteration.  Allows us
 102     // to make time progress faster than normal (or even run in reverse.)
 103     long int warp_delta;
 104
 105     // Logger
 106     FGLogger *logger;
 107
 108     // Time structure
 109     SGTime *time_params;
 110
 111     // Sky structures
 112     SGEphemeris *ephem;
 113
 114     // Magnetic Variation
 115     SGMagVar *mag;
 116
 117     // Current autopilot
 118     FGAutopilot *autopilot;
 119
 120     // Global autopilot "route"
 121     SGRoute *route;
 122
 123     // sound manager
 124     FGSoundMgr *soundmgr;
 125
 126     // sound-effects manager
 127     FGFX *fx;
 128
 129     // environment information
 130     FGEnvironmentMgr * environment_mgr;
 131
 132     // ATC manager
 133     FGATCMgr *ATC_mgr;
 134
 135     // ATC Renderer
 136     FGATCDisplay *ATC_display;
 137
 138     // AI manager
 139     FGAIMgr *AI_mgr;
 140
 141     // control input state
 142     FGControls *controls;
 143
 144     // viewer manager
 145     FGViewMgr *viewmgr;
 146
 147     // properties
 148     SGPropertyNode *props;
 149     SGPropertyNode *initial_state;
 150
 151     SGCommandMgr *commands;
 152
 153     FGAircraftModel *acmodel;
 154
 155     // list of serial port-like configurations
 156     string_list *channel_options_list;
 157
 158 public:
 159
 160     FGGlobals();
 161     ~FGGlobals();
 162
 163     inline long get_elapsed_time_ms () const { return elapsed_time_ms; }
 164     inline void set_elapsed_time_ms (long t) { elapsed_time_ms = t; }
 165
 166     inline const string &get_fg_root () const { return fg_root; }
 167     inline void set_fg_root (const string &root) { fg_root = root; }
 168
 169     inline const string &get_fg_scenery () const { return fg_scenery; }
 170     inline void set_fg_scenery (const string &scenery) {
 171       fg_scenery = scenery;
 172     }
 173
 174 #if 0
 175     inline bool get_freeze() const { return freeze; }
 176     inline void set_freeze( bool f ) { freeze = f; }
 177 #endif
 178
 179 #if defined(FX) && defined(XMESA)
 180     inline bool get_fullscreen() const { return fullscreen; }
 181     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 182 #endif
 183
 184     inline long int get_warp() const { return warp; }
 185     inline void set_warp( long int w ) { warp = w; }
 186     inline void inc_warp( long int w ) { warp += w; }
 187
 188     inline long int get_warp_delta() const { return warp_delta; }
 189     inline void set_warp_delta( long int d ) { warp_delta = d; }
 190     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 191
 192     inline FGLogger * get_logger () { return logger; }
 193     inline void set_logger (FGLogger * l) { logger = l; }
 194
 195     inline SGTime *get_time_params() const { return time_params; }
 196     inline void set_time_params( SGTime *t ) { time_params = t; }
 197
 198     inline SGEphemeris *get_ephem() const { return ephem; }
 199     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 200
 201     inline SGMagVar *get_mag() const { return mag; }
 202     inline void set_mag( SGMagVar *m ) { mag = m; }
 203
 204     inline FGAutopilot *get_autopilot() const { return autopilot; }
 205     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 206
 207     inline SGRoute *get_route() const { return route; }
 208     inline void set_route( SGRoute *r ) { route = r; }
 209
 210     inline FGEnvironmentMgr * get_environment_mgr() {
 211       return environment_mgr;
 212     }
 213     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 214       environment_mgr = mgr;
 215     }
 216     const FGEnvironment * get_environment() const;
 217     const FGEnvironment * get_environment(double lat, double lon,
 218                                           double alt) const;
 219
 220     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 221     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 222
 223     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 224     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 225
 226     inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
 227     inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
 228
 229     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 230     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 231
 232     inline FGFX *get_fx() const { return fx; }
 233     inline void set_fx( FGFX *x ) { fx = x; }
 234
 235     inline FGControls *get_controls() const { return controls; }
 236     inline void set_controls( FGControls *c ) { controls = c; }
 237
 238     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 239     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 240     FGViewer *get_current_view() const;
 241
 242     inline SGPropertyNode *get_props () { return props; }
 243     inline void set_props( SGPropertyNode *n ) { props = n; }
 244
 245     inline SGCommandMgr *get_commands () { return commands; }
 246
 247     inline FGAircraftModel *get_aircraft_model () { return acmodel; }
 248
 249     inline void set_aircraft_model (FGAircraftModel * model)
 250     {
 251         acmodel = model;
 252     }
 253
 254     inline string_list *get_channel_options_list () {
 255         return channel_options_list;
 256     }
 257     inline void set_channel_options_list( string_list *l ) {
 258         channel_options_list = l;
 259     }
 260
 261
 262     /**
 263      * Save the current state as the initial state.
 264      */
 265     void saveInitialState ();
 266
 267
 268     /**
 269      * Restore the saved initial state, if any.
 270      */
 271     void restoreInitialState ();
 272
 273 };
 274
 275
 276 extern FGGlobals *globals;
 277
 278
 279 #endif // _GLOBALS_HXX