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