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