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