1 // globals.hxx -- Global state that needs to be shared among the sim modules
3 // Written by Curtis Olson, started July 2000.
5 // Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org
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.
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.
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.
27 #include <simgear/compiler.h>
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>
40 SG_USING_STD( vector );
41 SG_USING_STD( string );
43 typedef vector<string> string_list;
46 // Forward declarations
57 // Root of FlightGear data tree
60 // Root of FlightGear scenery tree
66 // An offset in seconds from the true time. Allows us to adjust
67 // the effective time of day.
70 // How much to change the value of warp each iteration. Allows us
71 // to make time progress faster than normal (or even run in reverse.)
83 // Global autopilot "route"
89 // sound-effects manager
92 // control input state
97 FGViewer *current_view;
100 SGPropertyNode *props;
101 SGPropertyNode *initial_state;
103 SGCommandMgr *commands;
105 // list of serial port-like configurations
106 string_list *channel_options_list;
113 inline const string &get_fg_root () const { return fg_root; }
114 inline void set_fg_root (const string &root) { fg_root = root; }
116 inline const string &get_fg_scenery () const { return fg_scenery; }
117 inline void set_fg_scenery (const string &scenery) {
118 fg_scenery = scenery;
121 inline bool get_freeze() const { return freeze; }
122 inline void set_freeze( bool f ) { freeze = f; }
124 inline long int get_warp() const { return warp; }
125 inline void set_warp( long int w ) { warp = w; }
126 inline void inc_warp( long int w ) { warp += w; }
128 inline long int get_warp_delta() const { return warp_delta; }
129 inline void set_warp_delta( long int d ) { warp_delta = d; }
130 inline void inc_warp_delta( long int d ) { warp_delta += d; }
132 inline SGTime *get_time_params() const { return time_params; }
133 inline void set_time_params( SGTime *t ) { time_params = t; }
135 inline SGEphemeris *get_ephem() const { return ephem; }
136 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
138 inline SGMagVar *get_mag() const { return mag; }
139 inline void set_mag( SGMagVar *m ) { mag = m; }
141 inline SGRoute *get_route() const { return route; }
142 inline void set_route( SGRoute *r ) { route = r; }
144 inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
145 inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
147 inline FGFX *get_fx() const { return fx; }
148 inline void set_fx( FGFX *x ) { fx = x; }
150 inline FGControls *get_controls() const { return controls; }
151 inline void set_controls( FGControls *c ) { controls = c; }
153 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
154 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
155 inline FGViewer *get_current_view() const { return current_view; }
156 inline void set_current_view( FGViewer *v ) { current_view = v; }
158 inline SGPropertyNode *get_props () { return props; }
159 inline void set_props( SGPropertyNode *n ) { props = n; }
161 inline SGCommandMgr *get_commands () { return commands; }
163 inline string_list *get_channel_options_list () {
164 return channel_options_list;
166 inline void set_channel_options_list( string_list *l ) {
167 channel_options_list = l;
172 * Save the current state as the initial state.
174 void saveInitialState ();
178 * Restore the saved initial state, if any.
180 void restoreInitialState ();
185 extern FGGlobals *globals;
188 #endif // _GLOBALS_HXX