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
  33 #include <simgear/ephemeris/ephemeris.hxx>
  34 #include <simgear/magvar/magvar.hxx>
  35 #include <simgear/route/route.hxx>
  36 #include <simgear/timing/sg_time.hxx>
  37 #include <simgear/misc/commands.hxx>
  38 #include <simgear/misc/props.hxx>
  39
  40 SG_USING_STD( vector );
  41 SG_USING_STD( string );
  42
  43 typedef vector<string> string_list;
  44
  45
  46 // Forward declarations
  47 class FGLogger;
  48 class FGEnvironmentMgr;
  49 class FGEnvironment;
  50 class FGControls;
  51 class FGSoundMgr;
  52 class FGAutopilot;
  53 class FGFX;
  54 class FGViewMgr;
  55 class FGViewer;
  56 class FGATCMgr;
  57 class FGATCDisplay;
  58
  59 class FGGlobals {
  60
  61 private:
  62
  63     // Number of milliseconds elapsed since the start of the program.
  64     long elapsed_time_ms;
  65
  66     // Root of FlightGear data tree
  67     string fg_root;
  68
  69     // Root of FlightGear scenery tree
  70     string fg_scenery;
  71
  72 #if 0
  73     // Freeze sim
  74     bool freeze;
  75 #endif
  76
  77     // Fullscreen mode for old 3DFX cards.
  78 #if defined(FX) && defined(XMESA)
  79     bool fullscreen;
  80 #endif
  81
  82     // An offset in seconds from the true time.  Allows us to adjust
  83     // the effective time of day.
  84     long int warp;
  85
  86     // How much to change the value of warp each iteration.  Allows us
  87     // to make time progress faster than normal (or even run in reverse.)
  88     long int warp_delta;
  89
  90     // Logger
  91     FGLogger * logger;
  92
  93     // Time structure
  94     SGTime *time_params;
  95
  96     // Sky structures
  97     SGEphemeris *ephem;
  98
  99     // Magnetic Variation
 100     SGMagVar *mag;
 101
 102     // Current autopilot
 103     FGAutopilot *autopilot;
 104
 105     // Global autopilot "route"
 106     SGRoute *route;
 107
 108     // sound manager
 109     FGSoundMgr *soundmgr;
 110
 111     // sound-effects manager
 112     FGFX *fx;
 113
 114     // environment information
 115     FGEnvironmentMgr * environment_mgr;
 116
 117     // ATC manager
 118     FGATCMgr *ATC_mgr;
 119
 120     // ATC Renderer
 121     FGATCDisplay *ATC_display;
 122
 123     // control input state
 124     FGControls *controls;
 125
 126     // viewer manager
 127     FGViewMgr *viewmgr;
 128     FGViewer *current_view;
 129
 130     // properties
 131     SGPropertyNode *props;
 132     SGPropertyNode *initial_state;
 133
 134     SGCommandMgr *commands;
 135
 136     // list of serial port-like configurations
 137     string_list *channel_options_list;
 138
 139 public:
 140
 141     FGGlobals();
 142     ~FGGlobals();
 143
 144     inline long get_elapsed_time_ms () const { return elapsed_time_ms; }
 145     inline void set_elapsed_time_ms (long t) { elapsed_time_ms = t; }
 146
 147     inline const string &get_fg_root () const { return fg_root; }
 148     inline void set_fg_root (const string &root) { fg_root = root; }
 149
 150     inline const string &get_fg_scenery () const { return fg_scenery; }
 151     inline void set_fg_scenery (const string &scenery) {
 152       fg_scenery = scenery;
 153     }
 154
 155 #if 0
 156     inline bool get_freeze() const { return freeze; }
 157     inline void set_freeze( bool f ) { freeze = f; }
 158 #endif
 159
 160 #if defined(FX) && defined(XMESA)
 161     inline bool get_fullscreen() const { return fullscreen; }
 162     inline bool set_fullscreen( bool f ) { fullscreen = f; }
 163 #endif
 164
 165     inline long int get_warp() const { return warp; }
 166     inline void set_warp( long int w ) { warp = w; }
 167     inline void inc_warp( long int w ) { warp += w; }
 168
 169     inline long int get_warp_delta() const { return warp_delta; }
 170     inline void set_warp_delta( long int d ) { warp_delta = d; }
 171     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 172
 173     inline FGLogger * get_logger () { return logger; }
 174     inline void set_logger (FGLogger * l) { logger = l; }
 175
 176     inline SGTime *get_time_params() const { return time_params; }
 177     inline void set_time_params( SGTime *t ) { time_params = t; }
 178
 179     inline SGEphemeris *get_ephem() const { return ephem; }
 180     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 181
 182     inline SGMagVar *get_mag() const { return mag; }
 183     inline void set_mag( SGMagVar *m ) { mag = m; }
 184
 185     inline FGAutopilot *get_autopilot() const { return autopilot; }
 186     inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
 187
 188     inline SGRoute *get_route() const { return route; }
 189     inline void set_route( SGRoute *r ) { route = r; }
 190
 191     inline FGEnvironmentMgr * get_environment_mgr() {
 192       return environment_mgr;
 193     }
 194     inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
 195       environment_mgr = mgr;
 196     }
 197     const FGEnvironment * get_environment() const;
 198     const FGEnvironment * get_environment(double lat, double lon,
 199                                           double alt) const;
 200
 201     inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
 202     inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
 203
 204     inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
 205     inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
 206
 207     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 208     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 209
 210     inline FGFX *get_fx() const { return fx; }
 211     inline void set_fx( FGFX *x ) { fx = x; }
 212
 213     inline FGControls *get_controls() const { return controls; }
 214     inline void set_controls( FGControls *c ) { controls = c; }
 215
 216     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 217     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 218     inline FGViewer *get_current_view() const { return current_view; }
 219     inline void set_current_view( FGViewer *v ) { current_view = v; }
 220
 221     inline SGPropertyNode *get_props () { return props; }
 222     inline void set_props( SGPropertyNode *n ) { props = n; }
 223
 224     inline SGCommandMgr *get_commands () { return commands; }
 225
 226     inline string_list *get_channel_options_list () {
 227         return channel_options_list;
 228     }
 229     inline void set_channel_options_list( string_list *l ) {
 230         channel_options_list = l;
 231     }
 232
 233
 234     /**
 235      * Save the current state as the initial state.
 236      */
 237     void saveInitialState ();
 238
 239
 240     /**
 241      * Restore the saved initial state, if any.
 242      */
 243     void restoreInitialState ();
 244
 245 };
 246
 247
 248 extern FGGlobals *globals;
 249
 250
 251 #endif // _GLOBALS_HXX