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