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