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>
32 #include "viewmgr.hxx"
34 SG_USING_STD( vector );
35 SG_USING_STD( string );
37 typedef vector<string> string_list;
40 // Forward declarations
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
58 class FGEnvironmentMgr;
70 * Bucket for subsystem pointers representing the sim's state.
77 // Number of milliseconds elapsed since the start of the program.
80 // Root of FlightGear data tree
83 // Root of FlightGear scenery tree
91 // Fullscreen mode for old 3DFX cards.
92 #if defined(FX) && defined(XMESA)
96 // An offset in seconds from the true time. Allows us to adjust
97 // the effective time of day.
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.)
113 // Magnetic Variation
117 FGAutopilot *autopilot;
119 // Global autopilot "route"
123 FGSoundMgr *soundmgr;
125 // sound-effects manager
128 // environment information
129 FGEnvironmentMgr * environment_mgr;
135 FGATCDisplay *ATC_display;
137 // control input state
138 FGControls *controls;
144 SGPropertyNode *props;
145 SGPropertyNode *initial_state;
147 SGCommandMgr *commands;
149 // list of serial port-like configurations
150 string_list *channel_options_list;
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; }
160 inline const string &get_fg_root () const { return fg_root; }
161 inline void set_fg_root (const string &root) { fg_root = root; }
163 inline const string &get_fg_scenery () const { return fg_scenery; }
164 inline void set_fg_scenery (const string &scenery) {
165 fg_scenery = scenery;
169 inline bool get_freeze() const { return freeze; }
170 inline void set_freeze( bool f ) { freeze = f; }
173 #if defined(FX) && defined(XMESA)
174 inline bool get_fullscreen() const { return fullscreen; }
175 inline bool set_fullscreen( bool f ) { fullscreen = f; }
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; }
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; }
186 inline FGLogger * get_logger () { return logger; }
187 inline void set_logger (FGLogger * l) { logger = l; }
189 inline SGTime *get_time_params() const { return time_params; }
190 inline void set_time_params( SGTime *t ) { time_params = t; }
192 inline SGEphemeris *get_ephem() const { return ephem; }
193 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
195 inline SGMagVar *get_mag() const { return mag; }
196 inline void set_mag( SGMagVar *m ) { mag = m; }
198 inline FGAutopilot *get_autopilot() const { return autopilot; }
199 inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
201 inline SGRoute *get_route() const { return route; }
202 inline void set_route( SGRoute *r ) { route = r; }
204 inline FGEnvironmentMgr * get_environment_mgr() {
205 return environment_mgr;
207 inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
208 environment_mgr = mgr;
210 const FGEnvironment * get_environment() const;
211 const FGEnvironment * get_environment(double lat, double lon,
214 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
215 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
217 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
218 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
220 inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
221 inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
223 inline FGFX *get_fx() const { return fx; }
224 inline void set_fx( FGFX *x ) { fx = x; }
226 inline FGControls *get_controls() const { return controls; }
227 inline void set_controls( FGControls *c ) { controls = c; }
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();
235 inline SGPropertyNode *get_props () { return props; }
236 inline void set_props( SGPropertyNode *n ) { props = n; }
238 inline SGCommandMgr *get_commands () { return commands; }
240 inline string_list *get_channel_options_list () {
241 return channel_options_list;
243 inline void set_channel_options_list( string_list *l ) {
244 channel_options_list = l;
249 * Save the current state as the initial state.
251 void saveInitialState ();
255 * Restore the saved initial state, if any.
257 void restoreInitialState ();
262 extern FGGlobals *globals;
265 #endif // _GLOBALS_HXX