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.
31 #include <simgear/compiler.h>
32 #include <simgear/structure/callback.hxx>
33 #include <simgear/structure/subsystem_mgr.hxx>
34 #include <simgear/structure/event_mgr.hxx>
39 SG_USING_STD( vector );
40 SG_USING_STD( string );
42 typedef vector<string> string_list;
45 // Forward declarations
47 // This file is included, directly or indirectly, almost everywhere in
48 // FlightGear, so if any of its dependencies changes, most of the sim
49 // has to be recompiled. Using these forward declarations helps us to
50 // avoid including a lot of header files (and thus, a lot of
51 // dependencies). Since Most of the methods simply set or return
52 // pointers, we don't need to know anything about the class details
71 class FGAircraftModel;
79 class FGMultiplayRxMgr;
80 class FGMultiplayTxMgr;
89 * Bucket for subsystem pointers representing the sim's state.
97 SGSubsystemMgr * subsystem_mgr;
98 SGEventMgr * event_mgr;
100 // Number of milliseconds elapsed since the start of the program.
103 // Root of FlightGear data tree
106 // Root of FlightGear scenery tree
109 // Fullscreen mode for old 3DFX cards.
110 #if defined(FX) && defined(XMESA)
114 // An offset in seconds from the true time. Allows us to adjust
115 // the effective time of day.
118 // How much to change the value of warp each iteration. Allows us
119 // to make time progress faster than normal (or even run in reverse.)
128 // Magnetic Variation
131 // Material properties library
132 SGMaterialLib *matlib;
135 FGAutopilot *autopilot;
137 // Global autopilot "route"
141 FGPanel *current_panel;
144 SGSoundMgr *soundmgr;
146 // Simple Airport List
147 FGAirportList *airports;
150 FGRunwayList *runways;
156 FGATCDisplay *ATC_display;
161 // control input state
162 FGControls *controls;
168 SGPropertyNode *props;
169 SGPropertyNode *initial_state;
172 SGPropertyNode *locale;
174 SGCommandMgr *commands;
176 SGModelLib *model_lib;
178 FGAircraftModel *acmodel;
180 FGModelMgr * model_mgr;
182 // list of serial port-like configurations
183 string_list *channel_options_list;
185 // FlightGear scenery manager
191 // Input/Ouput subsystem
195 //Mulitplayer managers
196 FGMultiplayTxMgr *multiplayer_tx_mgr;
198 FGMultiplayRxMgr *multiplayer_rx_mgr;
204 virtual ~FGGlobals();
206 virtual SGSubsystemMgr * get_subsystem_mgr () const;
208 virtual SGSubsystem * get_subsystem (const char * name);
210 virtual void add_subsystem (const char * name,
211 SGSubsystem * subsystem,
212 SGSubsystemMgr::GroupType
213 type = SGSubsystemMgr::GENERAL,
214 double min_time_sec = 0);
216 virtual SGEventMgr * get_event_mgr () const;
218 virtual void add_event (const char * name,
220 int initial_value = -1 );
222 virtual void add_event (const char * name,
223 SGSubsystem * subsystem,
225 int initial_value = -1 );
227 template< typename Fun >
228 inline void add_event( const char * name,
230 SGEvent::interval_type repeat_value,
231 SGEvent::interval_type initial_value = -1 )
233 event_mgr->add( name, get_subsystem( name ), func,
234 repeat_value, initial_value);
237 template< typename Fun >
238 inline void add_event( const char * name,
239 SGSubsystem * subsystem,
241 SGEvent::interval_type repeat_value,
242 SGEvent::interval_type initial_value = -1 )
244 event_mgr->add( name, subsystem, func, repeat_value, initial_value);
247 inline double get_sim_time_sec () const { return sim_time_sec; }
248 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
249 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
251 inline const string &get_fg_root () const { return fg_root; }
252 void set_fg_root (const string &root);
254 inline const string &get_fg_scenery () const { return fg_scenery; }
255 inline void set_fg_scenery (const string &scenery) {
256 fg_scenery = scenery;
259 #if defined(FX) && defined(XMESA)
260 inline bool get_fullscreen() const { return fullscreen; }
261 inline bool set_fullscreen( bool f ) { fullscreen = f; }
264 inline long int get_warp() const { return warp; }
265 inline void set_warp( long int w ) { warp = w; }
266 inline void inc_warp( long int w ) { warp += w; }
268 inline long int get_warp_delta() const { return warp_delta; }
269 inline void set_warp_delta( long int d ) { warp_delta = d; }
270 inline void inc_warp_delta( long int d ) { warp_delta += d; }
272 inline SGTime *get_time_params() const { return time_params; }
273 inline void set_time_params( SGTime *t ) { time_params = t; }
275 inline SGEphemeris *get_ephem() const { return ephem; }
276 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
278 inline SGMagVar *get_mag() const { return mag; }
279 inline void set_mag( SGMagVar *m ) { mag = m; }
281 inline SGMaterialLib *get_matlib() const { return matlib; }
282 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
284 inline FGAutopilot *get_autopilot() const { return autopilot; }
285 inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
287 inline SGRoute *get_route() const { return route; }
288 inline void set_route( SGRoute *r ) { route = r; }
290 inline FGAirportList *get_airports() const { return airports; }
291 inline void set_airports( FGAirportList *a ) {airports = a; }
293 inline FGRunwayList *get_runways() const { return runways; }
294 inline void set_runways( FGRunwayList *r ) {runways = r; }
296 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
297 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
299 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
300 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
302 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
303 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
305 inline FGPanel *get_current_panel() const { return current_panel; }
306 inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
308 inline SGSoundMgr *get_soundmgr() const { return soundmgr; }
309 inline void set_soundmgr( SGSoundMgr *sm ) { soundmgr = sm; }
311 inline FGControls *get_controls() const { return controls; }
312 inline void set_controls( FGControls *c ) { controls = c; }
314 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
315 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
316 FGViewer *get_current_view() const;
318 inline SGPropertyNode *get_props () { return props; }
319 inline void set_props( SGPropertyNode *n ) { props = n; }
321 inline SGPropertyNode *get_locale () { return locale; }
322 inline void set_locale( SGPropertyNode *n ) { locale = n; }
324 inline SGCommandMgr *get_commands () { return commands; }
326 inline SGModelLib * get_model_lib () { return model_lib; }
328 inline void set_model_lib (SGModelLib *m) {
332 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
334 inline void set_aircraft_model (FGAircraftModel * model)
339 inline FGModelMgr *get_model_mgr () { return model_mgr; }
341 inline void set_model_mgr (FGModelMgr * mgr)
347 inline FGMultiplayTxMgr *get_multiplayer_tx_mgr () { return multiplayer_tx_mgr; }
349 inline void set_multiplayer_tx_mgr (FGMultiplayTxMgr * mgr)
351 multiplayer_tx_mgr = mgr;
354 inline FGMultiplayRxMgr *get_multiplayer_rx_mgr () { return multiplayer_rx_mgr; }
356 inline void set_multiplayer_rx_mgr (FGMultiplayRxMgr * mgr)
358 multiplayer_rx_mgr = mgr;
362 inline string_list *get_channel_options_list () {
363 return channel_options_list;
365 inline void set_channel_options_list( string_list *l ) {
366 channel_options_list = l;
369 inline FGScenery * get_scenery () const { return scenery; }
370 inline void set_scenery ( FGScenery *s ) { scenery = s; }
372 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
373 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
375 inline FGIO* get_io() const { return io; }
378 * Save the current state as the initial state.
380 void saveInitialState ();
384 * Restore the saved initial state, if any.
386 void restoreInitialState ();
391 extern FGGlobals *globals;
394 #endif // _GLOBALS_HXX