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