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 FGSteam;
  60 class FGSoundMgr;
  61 class FGAutopilot;
  62 class FGFX;
  63 class FGViewMgr;
  64 class FGViewer;
  65 class FGATCMgr;
  66 class FGATCDisplay;
  67 class FGAIMgr;
  68 class FGAircraftModel;
  69 class FGModelMgr;
  70 class FGScenery;
  71
  72
  73 /**
  74  * Bucket for subsystem pointers representing the sim's state.
  75  */
  76 class FGGlobals
  77 {
  78
  79 private:
  80
  81     // Number of milliseconds elapsed since the start of the program.
  82     double sim_time_sec;
  83
  84     // Root of FlightGear data tree
  85     string fg_root;
  86
  87     // Root of FlightGear scenery tree
  88     string fg_scenery;
  89
  90 #if 0
  91     // Freeze sim
  92     bool freeze;
  93 #endif
  94
  95     // Fullscreen mode for old 3DFX cards.
  96 #if defined(FX) && defined(XMESA)
  97     bool fullscreen;
  98 #endif
  99
 100     // An offset in seconds from the true time.  Allows us to adjust
 101     // the effective time of day.
 102     long int warp;
 103
 104     // How much to change the value of warp each iteration.  Allows us
 105     // to make time progress faster than normal (or even run in reverse.)
 106     long int warp_delta;
 107
 108     // Logger
 109     FGLogger *logger;
 110
 111     // Time structure
 112     SGTime *time_params;
 113
 114     // Sky structures
 115     SGEphemeris *ephem;
 116
 117     // Magnetic Variation
 118     SGMagVar *mag;
 119
 120     // Current autopilot
 121     FGAutopilot *autopilot;
 122
 123     // Global autopilot "route"
 124     SGRoute *route;
 125
 126     // sound manager
 127     FGSoundMgr *soundmgr;
 128
 129     // sound-effects manager
 130     FGFX *fx;
 131
 132     // environment information
 133     FGEnvironmentMgr * environment_mgr;
 134
 135     // ATC manager
 136     FGATCMgr *ATC_mgr;
 137
 138     // ATC Renderer
 139     FGATCDisplay *ATC_display;
 140
 141     // AI manager
 142     FGAIMgr *AI_mgr;
 143
 144     // control input state
 145     FGControls *controls;
 146
 147     // Steam instruments
 148     FGSteam *steam;
 149
 150     // viewer manager
 151     FGViewMgr *viewmgr;
 152
 153     // properties
 154     SGPropertyNode *props;
 155     SGPropertyNode *initial_state;
 156
 157     SGCommandMgr *commands;
 158
 159     FGAircraftModel *acmodel;
 160
 161     FGModelMgr * model_mgr;
 162
 163     // list of serial port-like configurations
 164     string_list *channel_options_list;
 165
 166     // FlightGear scenery manager
 167     FGScenery *scenery;
 168
 169 public:
 170
 171     FGGlobals();
 172     ~FGGlobals();
 173
 174     inline double get_sim_time_sec () const { return sim_time_sec; }
 175     inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
 176     inline void set_sim_time_sec (double t) { sim_time_sec = t; }
 177
 178     inline const string &get_fg_root () const { return fg_root; }
 179     inline void set_fg_root (const string &root) { fg_root = root; }
 180
 181     inline const string &get_fg_scenery () const { return fg_scenery; }
 182     inline void set_fg_scenery (const string &scenery) {
 183       fg_scenery = scenery;
 184     }
 185
 186 #if 0
 187     inline bool get_freeze() const { return freeze; }
 188     inline void set_freeze( bool f ) { freeze = f; }
 189 #endif
 190
 191 #if defined(FX) && defined(XMESA)
 192     inline bool get_fullscreen() const { return fullscreen; }
 193     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 194 #endif
 195
 196     inline long int get_warp() const { return warp; }
 197     inline void set_warp( long int w ) { warp = w; }
 198     inline void inc_warp( long int w ) { warp += w; }
 199
 200     inline long int get_warp_delta() const { return warp_delta; }
 201     inline void set_warp_delta( long int d ) { warp_delta = d; }
 202     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 203
 204     inline FGLogger * get_logger () { return logger; }
 205     inline void set_logger (FGLogger * l) { logger = l; }
 206
 207     inline SGTime *get_time_params() const { return time_params; }
 208     inline void set_time_params( SGTime *t ) { time_params = t; }
 209
 210     inline SGEphemeris *get_ephem() const { return ephem; }
 211     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 212
 213     inline SGMagVar *get_mag() const { return mag; }
 214     inline void set_mag( SGMagVar *m ) { mag = m; }
 215
 216     inline FGAutopilot *get_autopilot() const { return autopilot; }
 217     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 218
 219     inline SGRoute *get_route() const { return route; }
 220     inline void set_route( SGRoute *r ) { route = r; }
 221
 222     inline FGEnvironmentMgr * get_environment_mgr() {
 223       return environment_mgr;
 224     }
 225     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 226       environment_mgr = mgr;
 227     }
 228
 229     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 230     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 231
 232     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 233     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 234
 235     inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
 236     inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
 237
 238     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 239     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 240
 241     inline FGFX *get_fx() const { return fx; }
 242     inline void set_fx( FGFX *x ) { fx = x; }
 243
 244     inline FGControls *get_controls() const { return controls; }
 245     inline void set_controls( FGControls *c ) { controls = c; }
 246
 247     inline FGSteam *get_steam() const { return steam; }
 248     inline void set_steam( FGSteam *s ) { steam = s; }
 249
 250     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 251     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 252     FGViewer *get_current_view() const;
 253
 254     inline SGPropertyNode *get_props () { return props; }
 255     inline void set_props( SGPropertyNode *n ) { props = n; }
 256
 257     inline SGCommandMgr *get_commands () { return commands; }
 258
 259     inline FGAircraftModel *get_aircraft_model () { return acmodel; }
 260
 261     inline void set_aircraft_model (FGAircraftModel * model)
 262     {
 263         acmodel = model;
 264     }
 265
 266     inline FGModelMgr *get_model_mgr () { return model_mgr; }
 267
 268     inline void set_model_mgr (FGModelMgr * mgr)
 269     {
 270       model_mgr = mgr;
 271     }
 272
 273     inline string_list *get_channel_options_list () {
 274         return channel_options_list;
 275     }
 276     inline void set_channel_options_list( string_list *l ) {
 277         channel_options_list = l;
 278     }
 279
 280     inline FGScenery * get_scenery () const { return scenery; }
 281     inline void set_scenery ( FGScenery *s ) { scenery = s; }
 282
 283     /**
 284      * Save the current state as the initial state.
 285      */
 286     void saveInitialState ();
 287
 288
 289     /**
 290      * Restore the saved initial state, if any.
 291      */
 292     void restoreInitialState ();
 293
 294 };
 295
 296
 297 extern FGGlobals *globals;
 298
 299
 300 #endif // _GLOBALS_HXX