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