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/props.hxx>
  38
  39 #include <Sound/soundmgr.hxx>
  40 #include "viewmgr.hxx"
  41
  42 SG_USING_STD( vector );
  43 SG_USING_STD( string );
  44
  45 typedef vector<string> string_list;
  46
  47
  48 class FGGlobals {
  49
  50 private:
  51
  52     // Root of FlightGear data tree
  53     string fg_root;
  54
  55     // Root of FlightGear scenery tree
  56     string fg_scenery;
  57
  58     // Freeze sim
  59     bool freeze;
  60
  61     // An offset in seconds from the true time.  Allows us to adjust
  62     // the effective time of day.
  63     long int warp;
  64
  65     // How much to change the value of warp each iteration.  Allows us
  66     // to make time progress faster than normal (or even run in reverse.)
  67     long int warp_delta;
  68
  69     // Time structure
  70     SGTime *time_params;
  71
  72     // Sky structures
  73     SGEphemeris *ephem;
  74
  75     // Magnetic Variation
  76     SGMagVar *mag;
  77
  78     // Global autopilot "route"
  79     SGRoute *route;
  80
  81     // sound manager
  82     FGSoundMgr *soundmgr;
  83
  84     // viewer manager
  85     FGViewMgr *viewmgr;
  86     FGViewer *current_view;
  87
  88     // properties
  89     SGPropertyNode *props;
  90     SGPropertyNode *initial_state;
  91
  92     // list of serial port-like configurations
  93     string_list *channel_options_list;
  94
  95 public:
  96
  97     FGGlobals();
  98     ~FGGlobals();
  99
 100     inline const string &get_fg_root () const { return fg_root; }
 101     inline void set_fg_root (const string &root) { fg_root = root; }
 102
 103     inline const string &get_fg_scenery () const { return fg_scenery; }
 104     inline void set_fg_scenery (const string &scenery) {
 105       fg_scenery = scenery;
 106     }
 107
 108     inline bool get_freeze() const { return freeze; }
 109     inline void set_freeze( bool f ) { freeze = f; }
 110
 111     inline long int get_warp() const { return warp; }
 112     inline void set_warp( long int w ) { warp = w; }
 113     inline void inc_warp( long int w ) { warp += w; }
 114
 115     inline long int get_warp_delta() const { return warp_delta; }
 116     inline void set_warp_delta( long int d ) { warp_delta = d; }
 117     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 118
 119     inline SGTime *get_time_params() const { return time_params; }
 120     inline void set_time_params( SGTime *t ) { time_params = t; }
 121
 122     inline SGEphemeris *get_ephem() const { return ephem; }
 123     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 124
 125     inline SGMagVar *get_mag() const { return mag; }
 126     inline void set_mag( SGMagVar *m ) { mag = m; }
 127
 128     inline SGRoute *get_route() const { return route; }
 129     inline void set_route( SGRoute *r ) { route = r; }
 130
 131     inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
 132     inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
 133
 134     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 135     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 136     inline FGViewer *get_current_view() const { return current_view; }
 137     inline void set_current_view( FGViewer *v ) { current_view = v; }
 138
 139     inline SGPropertyNode *get_props () { return props; }
 140     inline void set_props( SGPropertyNode *n ) { props = n; }
 141
 142     inline string_list *get_channel_options_list () {
 143         return channel_options_list;
 144     }
 145     inline void set_channel_options_list( string_list *l ) {
 146         channel_options_list = l;
 147     }
 148
 149
 150     /**
 151      * Save the current state as the initial state.
 152      */
 153     void saveInitialState ();
 154
 155
 156     /**
 157      * Restore the saved initial state, if any.
 158      */
 159     void restoreInitialState ();
 160
 161 };
 162
 163
 164 extern FGGlobals *globals;
 165
 166
 167 #endif // _GLOBALS_HXX
 168
 169