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