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 #include "fgfs.hxx"
  33
  34
  35 SG_USING_STD( vector );
  36 SG_USING_STD( string );
  37
  38 typedef vector<string> string_list;
  39
  40
  41 // Forward declarations
  42
  43 // This file is included, directly or indirectly, almost everywhere in
  44 // FlightGear, so if any of its dependencies changes, most of the sim
  45 // has to be recompiled.  Using these forward declarations helps us to
  46 // avoid including a lot of header files (and thus, a lot of
  47 // dependencies).  Since Most of the methods simply set or return
  48 // pointers, we don't need to know anything about the class details
  49 // anyway.
  50
  51 class SGEphemeris;
  52
  53 class SGCommandMgr;
  54 class SGMagVar;
  55 class SGMaterialLib;
  56 class SGModelLib;
  57 class SGPropertyNode;
  58 class SGRoute;
  59 class SGTime;
  60 class SGSoundMgr;
  61
  62 class FGAIMgr;
  63 class FGATCMgr;
  64 class FGATCDisplay;
  65 class FGAircraftModel;
  66 class FGAutopilot;
  67 class FGControls;
  68 class FGEnvironment;
  69 class FGEnvironmentMgr;
  70 class FGIO;
  71 class FGModelMgr;
  72 class FGScenery;
  73 #ifdef FG_MPLAYER_AS
  74 class FGMultiplayRxMgr;
  75 class FGMultiplayTxMgr;
  76 #endif
  77 class FGPanel;
  78 class FGTileMgr;
  79 class FGViewMgr;
  80 class FGViewer;
  81
  82
  83 /**
  84  * Bucket for subsystem pointers representing the sim's state.
  85  */
  86 class FGGlobals
  87 {
  88
  89 private:
  90
  91     FGSubsystemMgr * subsystem_mgr;
  92
  93     // Number of milliseconds elapsed since the start of the program.
  94     double sim_time_sec;
  95
  96     // Root of FlightGear data tree
  97     string fg_root;
  98
  99     // Root of FlightGear scenery tree
 100     string fg_scenery;
 101
 102     // Fullscreen mode for old 3DFX cards.
 103 #if defined(FX) && defined(XMESA)
 104     bool fullscreen;
 105 #endif
 106
 107     // An offset in seconds from the true time.  Allows us to adjust
 108     // the effective time of day.
 109     long int warp;
 110
 111     // How much to change the value of warp each iteration.  Allows us
 112     // to make time progress faster than normal (or even run in reverse.)
 113     long int warp_delta;
 114
 115     // Time structure
 116     SGTime *time_params;
 117
 118     // Sky structures
 119     SGEphemeris *ephem;
 120
 121     // Magnetic Variation
 122     SGMagVar *mag;
 123
 124     // Material properties library
 125     SGMaterialLib *matlib;
 126
 127     // Current autopilot
 128     FGAutopilot *autopilot;
 129
 130     // Global autopilot "route"
 131     SGRoute *route;
 132
 133     // 2D panel
 134     FGPanel *current_panel;
 135
 136     // sound manager
 137     SGSoundMgr *soundmgr;
 138
 139     // environment information
 140     FGEnvironmentMgr * environment_mgr;
 141
 142     // ATC manager
 143     FGATCMgr *ATC_mgr;
 144
 145     // ATC Renderer
 146     FGATCDisplay *ATC_display;
 147
 148     // AI manager
 149     FGAIMgr *AI_mgr;
 150
 151     // control input state
 152     FGControls *controls;
 153
 154     // viewer manager
 155     FGViewMgr *viewmgr;
 156
 157     // properties
 158     SGPropertyNode *props;
 159     SGPropertyNode *initial_state;
 160
 161     // localization
 162     SGPropertyNode *locale;
 163
 164     SGCommandMgr *commands;
 165
 166     SGModelLib *model_lib;
 167
 168     FGAircraftModel *acmodel;
 169
 170     FGModelMgr * model_mgr;
 171
 172     // list of serial port-like configurations
 173     string_list *channel_options_list;
 174
 175     // FlightGear scenery manager
 176     FGScenery *scenery;
 177
 178     // Tile manager
 179     FGTileMgr *tile_mgr;
 180
 181     FGIO* io;
 182
 183 #ifdef FG_MPLAYER_AS
 184     //Mulitplayer managers
 185     FGMultiplayTxMgr *multiplayer_tx_mgr;
 186
 187     FGMultiplayRxMgr *multiplayer_rx_mgr;
 188 #endif
 189
 190 public:
 191
 192     FGGlobals();
 193     virtual ~FGGlobals();
 194
 195     virtual FGSubsystemMgr * get_subsystem_mgr () const;
 196
 197     virtual FGSubsystem * get_subsystem (const char * name);
 198
 199     virtual void add_subsystem (const char * name,
 200                                 FGSubsystem * subsystem,
 201                                 FGSubsystemMgr::GroupType
 202                                   type = FGSubsystemMgr::GENERAL,
 203                                 double min_time_sec = 0);
 204
 205     inline double get_sim_time_sec () const { return sim_time_sec; }
 206     inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
 207     inline void set_sim_time_sec (double t) { sim_time_sec = t; }
 208
 209     inline const string &get_fg_root () const { return fg_root; }
 210     void set_fg_root (const string &root);
 211
 212     inline const string &get_fg_scenery () const { return fg_scenery; }
 213     inline void set_fg_scenery (const string &scenery) {
 214       fg_scenery = scenery;
 215     }
 216
 217 #if defined(FX) && defined(XMESA)
 218     inline bool get_fullscreen() const { return fullscreen; }
 219     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 220 #endif
 221
 222     inline long int get_warp() const { return warp; }
 223     inline void set_warp( long int w ) { warp = w; }
 224     inline void inc_warp( long int w ) { warp += w; }
 225
 226     inline long int get_warp_delta() const { return warp_delta; }
 227     inline void set_warp_delta( long int d ) { warp_delta = d; }
 228     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 229
 230     inline SGTime *get_time_params() const { return time_params; }
 231     inline void set_time_params( SGTime *t ) { time_params = t; }
 232
 233     inline SGEphemeris *get_ephem() const { return ephem; }
 234     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 235
 236     inline SGMagVar *get_mag() const { return mag; }
 237     inline void set_mag( SGMagVar *m ) { mag = m; }
 238
 239     inline SGMaterialLib *get_matlib() const { return matlib; }
 240     inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
 241
 242     inline FGAutopilot *get_autopilot() const { return autopilot; }
 243     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 244
 245     inline SGRoute *get_route() const { return route; }
 246     inline void set_route( SGRoute *r ) { route = r; }
 247
 248     inline FGEnvironmentMgr * get_environment_mgr() {
 249       return environment_mgr;
 250     }
 251     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 252       environment_mgr = mgr;
 253     }
 254
 255     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 256     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 257
 258     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 259     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 260
 261     inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
 262     inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
 263
 264     inline FGPanel *get_current_panel() const { return current_panel; }
 265     inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
 266
 267     inline SGSoundMgr *get_soundmgr() const { return soundmgr; }
 268     inline void set_soundmgr( SGSoundMgr *sm ) { soundmgr = sm; }
 269
 270     inline FGControls *get_controls() const { return controls; }
 271     inline void set_controls( FGControls *c ) { controls = c; }
 272
 273     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 274     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 275     FGViewer *get_current_view() const;
 276
 277     inline SGPropertyNode *get_props () { return props; }
 278     inline void set_props( SGPropertyNode *n ) { props = n; }
 279
 280     inline SGPropertyNode *get_locale () { return locale; }
 281     inline void set_locale( SGPropertyNode *n ) { locale = n; }
 282
 283     inline SGCommandMgr *get_commands () { return commands; }
 284
 285     inline SGModelLib * get_model_lib () { return model_lib; }
 286
 287     inline void set_model_lib (SGModelLib *m) {
 288         model_lib = m;
 289     }
 290
 291     inline FGAircraftModel *get_aircraft_model () { return acmodel; }
 292
 293     inline void set_aircraft_model (FGAircraftModel * model)
 294     {
 295         acmodel = model;
 296     }
 297
 298     inline FGModelMgr *get_model_mgr () { return model_mgr; }
 299
 300     inline void set_model_mgr (FGModelMgr * mgr)
 301     {
 302       model_mgr = mgr;
 303     }
 304
 305 #ifdef FG_MPLAYER_AS
 306     inline FGMultiplayTxMgr *get_multiplayer_tx_mgr () { return multiplayer_tx_mgr; }
 307
 308     inline void set_multiplayer_tx_mgr (FGMultiplayTxMgr * mgr)
 309     {
 310       multiplayer_tx_mgr = mgr;
 311     }
 312
 313     inline FGMultiplayRxMgr *get_multiplayer_rx_mgr () { return multiplayer_rx_mgr; }
 314
 315     inline void set_multiplayer_rx_mgr (FGMultiplayRxMgr * mgr)
 316     {
 317       multiplayer_rx_mgr = mgr;
 318     }
 319 #endif
 320
 321     inline string_list *get_channel_options_list () {
 322         return channel_options_list;
 323     }
 324     inline void set_channel_options_list( string_list *l ) {
 325         channel_options_list = l;
 326     }
 327
 328     inline FGScenery * get_scenery () const { return scenery; }
 329     inline void set_scenery ( FGScenery *s ) { scenery = s; }
 330
 331     inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
 332     inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
 333
 334     FGIO* get_io() const { return io; }
 335
 336
 337     /**
 338      * Save the current state as the initial state.
 339      */
 340     void saveInitialState ();
 341
 342
 343     /**
 344      * Restore the saved initial state, if any.
 345      */
 346     void restoreInitialState ();
 347
 348 };
 349
 350
 351 extern FGGlobals *globals;
 352
 353
 354 #endif // _GLOBALS_HXX