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>
35 SG_USING_STD( vector );
36 SG_USING_STD( string );
38 typedef vector<string> string_list;
41 // Forward declarations
43 // This file is included, directly or indirectly, almost everywhere in
44 // FlightGear, so if any of its dependencies changes, most of the sim
45 // has to be recompiled. Using these forward declarations helps us to
46 // avoid including a lot of header files (and thus, a lot of
47 // dependencies). Since Most of the methods simply set or return
48 // pointers, we don't need to know anything about the class details
65 class FGAircraftModel;
69 class FGEnvironmentMgr;
74 class FGMultiplayRxMgr;
75 class FGMultiplayTxMgr;
84 * Bucket for subsystem pointers representing the sim's state.
91 FGSubsystemMgr * subsystem_mgr;
93 // Number of milliseconds elapsed since the start of the program.
96 // Root of FlightGear data tree
99 // Root of FlightGear scenery tree
102 // Fullscreen mode for old 3DFX cards.
103 #if defined(FX) && defined(XMESA)
107 // An offset in seconds from the true time. Allows us to adjust
108 // the effective time of day.
111 // How much to change the value of warp each iteration. Allows us
112 // to make time progress faster than normal (or even run in reverse.)
121 // Magnetic Variation
124 // Material properties library
125 SGMaterialLib *matlib;
128 FGAutopilot *autopilot;
130 // Global autopilot "route"
134 FGPanel *current_panel;
137 SGSoundMgr *soundmgr;
139 // environment information
140 FGEnvironmentMgr * environment_mgr;
146 FGATCDisplay *ATC_display;
151 // control input state
152 FGControls *controls;
158 SGPropertyNode *props;
159 SGPropertyNode *initial_state;
162 SGPropertyNode *locale;
164 SGCommandMgr *commands;
166 SGModelLib *model_lib;
168 FGAircraftModel *acmodel;
170 FGModelMgr * model_mgr;
172 // list of serial port-like configurations
173 string_list *channel_options_list;
175 // FlightGear scenery manager
184 //Mulitplayer managers
185 FGMultiplayTxMgr *multiplayer_tx_mgr;
187 FGMultiplayRxMgr *multiplayer_rx_mgr;
193 virtual ~FGGlobals();
195 virtual FGSubsystemMgr * get_subsystem_mgr () const;
197 virtual FGSubsystem * get_subsystem (const char * name);
199 virtual void add_subsystem (const char * name,
200 FGSubsystem * subsystem,
201 FGSubsystemMgr::GroupType
202 type = FGSubsystemMgr::GENERAL,
203 double min_time_sec = 0);
205 inline double get_sim_time_sec () const { return sim_time_sec; }
206 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
207 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
209 inline const string &get_fg_root () const { return fg_root; }
210 void set_fg_root (const string &root);
212 inline const string &get_fg_scenery () const { return fg_scenery; }
213 inline void set_fg_scenery (const string &scenery) {
214 fg_scenery = scenery;
217 #if defined(FX) && defined(XMESA)
218 inline bool get_fullscreen() const { return fullscreen; }
219 inline bool set_fullscreen( bool f ) { fullscreen = f; }
222 inline long int get_warp() const { return warp; }
223 inline void set_warp( long int w ) { warp = w; }
224 inline void inc_warp( long int w ) { warp += w; }
226 inline long int get_warp_delta() const { return warp_delta; }
227 inline void set_warp_delta( long int d ) { warp_delta = d; }
228 inline void inc_warp_delta( long int d ) { warp_delta += d; }
230 inline SGTime *get_time_params() const { return time_params; }
231 inline void set_time_params( SGTime *t ) { time_params = t; }
233 inline SGEphemeris *get_ephem() const { return ephem; }
234 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
236 inline SGMagVar *get_mag() const { return mag; }
237 inline void set_mag( SGMagVar *m ) { mag = m; }
239 inline SGMaterialLib *get_matlib() const { return matlib; }
240 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
242 inline FGAutopilot *get_autopilot() const { return autopilot; }
243 inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
245 inline SGRoute *get_route() const { return route; }
246 inline void set_route( SGRoute *r ) { route = r; }
248 inline FGEnvironmentMgr * get_environment_mgr() {
249 return environment_mgr;
251 inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
252 environment_mgr = mgr;
255 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
256 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
258 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
259 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
261 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
262 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
264 inline FGPanel *get_current_panel() const { return current_panel; }
265 inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
267 inline SGSoundMgr *get_soundmgr() const { return soundmgr; }
268 inline void set_soundmgr( SGSoundMgr *sm ) { soundmgr = sm; }
270 inline FGControls *get_controls() const { return controls; }
271 inline void set_controls( FGControls *c ) { controls = c; }
273 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
274 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
275 FGViewer *get_current_view() const;
277 inline SGPropertyNode *get_props () { return props; }
278 inline void set_props( SGPropertyNode *n ) { props = n; }
280 inline SGPropertyNode *get_locale () { return locale; }
281 inline void set_locale( SGPropertyNode *n ) { locale = n; }
283 inline SGCommandMgr *get_commands () { return commands; }
285 inline SGModelLib * get_model_lib () { return model_lib; }
287 inline void set_model_lib (SGModelLib *m) {
291 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
293 inline void set_aircraft_model (FGAircraftModel * model)
298 inline FGModelMgr *get_model_mgr () { return model_mgr; }
300 inline void set_model_mgr (FGModelMgr * mgr)
306 inline FGMultiplayTxMgr *get_multiplayer_tx_mgr () { return multiplayer_tx_mgr; }
308 inline void set_multiplayer_tx_mgr (FGMultiplayTxMgr * mgr)
310 multiplayer_tx_mgr = mgr;
313 inline FGMultiplayRxMgr *get_multiplayer_rx_mgr () { return multiplayer_rx_mgr; }
315 inline void set_multiplayer_rx_mgr (FGMultiplayRxMgr * mgr)
317 multiplayer_rx_mgr = mgr;
321 inline string_list *get_channel_options_list () {
322 return channel_options_list;
324 inline void set_channel_options_list( string_list *l ) {
325 channel_options_list = l;
328 inline FGScenery * get_scenery () const { return scenery; }
329 inline void set_scenery ( FGScenery *s ) { scenery = s; }
331 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
332 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
334 FGIO* get_io() const { return io; }
338 * Save the current state as the initial state.
340 void saveInitialState ();
344 * Restore the saved initial state, if any.
346 void restoreInitialState ();
351 extern FGGlobals *globals;
354 #endif // _GLOBALS_HXX