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 - http://www.flightgear.org/~curt
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;
73 class FGFlightPlanDispatcher;
94 * Bucket for subsystem pointers representing the sim's state.
102 FGRenderer *renderer;
103 SGSubsystemMgr *subsystem_mgr;
104 SGEventMgr *event_mgr;
106 // Number of milliseconds elapsed since the start of the program.
109 // Root of FlightGear data tree
112 // Roots of FlightGear scenery tree
113 string_list fg_scenery;
115 // Fullscreen mode for old 3DFX cards.
116 #if defined(FX) && defined(XMESA)
120 // An offset in seconds from the true time. Allows us to adjust
121 // the effective time of day.
124 // How much to change the value of warp each iteration. Allows us
125 // to make time progress faster than normal (or even run in reverse.)
134 // Magnetic Variation
137 // Material properties library
138 SGMaterialLib *matlib;
140 // Global autopilot "route"
141 FGRouteMgr *route_mgr;
144 FGPanel *current_panel;
147 SGSoundMgr *soundmgr;
149 // Simple Airport List
150 FGAirportList *airports;
153 FGRunwayList *runways;
159 FGATCDisplay *ATC_display;
164 // control input state
165 FGControls *controls;
171 SGPropertyNode *props;
172 SGPropertyNode *initial_state;
175 SGPropertyNode *locale;
177 SGCommandMgr *commands;
179 SGModelLib *model_lib;
181 //FGFlightPlanDispatcher *fpDispatcher;
183 FGAircraftModel *acmodel;
185 FGModelMgr * model_mgr;
187 // list of serial port-like configurations
188 string_list *channel_options_list;
190 // A list of initial waypoints that are read from the command line
191 // and or flight-plan file during initialization
192 string_list *initial_waypoints;
194 // FlightGear scenery manager
200 // Input/Ouput subsystem
209 FGNavList *tacanlist;
210 FGNavList *carrierlist;
211 FGTACANList *channellist;
215 FGNasalDisplay * Nasal_display;
219 //Mulitplayer managers
220 FGMultiplayMgr *multiplayer_mgr;
226 virtual ~FGGlobals();
228 virtual FGRenderer *get_renderer () const;
230 virtual SGSubsystemMgr *get_subsystem_mgr () const;
232 virtual SGSubsystem *get_subsystem (const char * name);
234 virtual void add_subsystem (const char * name,
235 SGSubsystem * subsystem,
236 SGSubsystemMgr::GroupType
237 type = SGSubsystemMgr::GENERAL,
238 double min_time_sec = 0);
240 virtual SGEventMgr *get_event_mgr () const;
242 inline double get_sim_time_sec () const { return sim_time_sec; }
243 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
244 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
246 inline const string &get_fg_root () const { return fg_root; }
247 void set_fg_root (const string &root);
249 inline const string_list &get_fg_scenery () const { return fg_scenery; }
250 void set_fg_scenery (const string &scenery);
252 #if defined(FX) && defined(XMESA)
253 inline bool get_fullscreen() const { return fullscreen; }
254 inline bool set_fullscreen( bool f ) { fullscreen = f; }
257 inline long int get_warp() const { return warp; }
258 inline void set_warp( long int w ) { warp = w; }
259 inline void inc_warp( long int w ) { warp += w; }
261 inline long int get_warp_delta() const { return warp_delta; }
262 inline void set_warp_delta( long int d ) { warp_delta = d; }
263 inline void inc_warp_delta( long int d ) { warp_delta += d; }
265 inline SGTime *get_time_params() const { return time_params; }
266 inline void set_time_params( SGTime *t ) { time_params = t; }
268 inline SGEphemeris *get_ephem() const { return ephem; }
269 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
271 inline SGMagVar *get_mag() const { return mag; }
272 inline void set_mag( SGMagVar *m ) { mag = m; }
274 inline SGMaterialLib *get_matlib() const { return matlib; }
275 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
277 inline FGAirportList *get_airports() const { return airports; }
278 inline void set_airports( FGAirportList *a ) {airports = a; }
280 inline FGRunwayList *get_runways() const { return runways; }
281 inline void set_runways( FGRunwayList *r ) {runways = r; }
283 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
284 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
286 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
287 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
289 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
290 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
292 inline FGPanel *get_current_panel() const { return current_panel; }
293 inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
295 inline SGSoundMgr *get_soundmgr() const { return soundmgr; }
296 inline void set_soundmgr( SGSoundMgr *sm ) { soundmgr = sm; }
298 inline FGControls *get_controls() const { return controls; }
299 inline void set_controls( FGControls *c ) { controls = c; }
301 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
302 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
303 FGViewer *get_current_view() const;
305 inline SGPropertyNode *get_props () { return props; }
306 inline void set_props( SGPropertyNode *n ) { props = n; }
308 inline SGPropertyNode *get_locale () { return locale; }
309 inline void set_locale( SGPropertyNode *n ) { locale = n; }
311 inline SGCommandMgr *get_commands () { return commands; }
313 inline SGModelLib * get_model_lib () { return model_lib; }
315 inline void set_model_lib (SGModelLib *m) {
319 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
321 inline void set_aircraft_model (FGAircraftModel * model)
326 inline FGModelMgr *get_model_mgr () { return model_mgr; }
328 inline void set_model_mgr (FGModelMgr * mgr)
334 inline FGMultiplayMgr *get_multiplayer_mgr () { return multiplayer_mgr; }
336 inline void set_multiplayer_mgr (FGMultiplayMgr * mgr)
338 multiplayer_mgr = mgr;
343 inline string_list *get_channel_options_list () {
344 return channel_options_list;
346 inline void set_channel_options_list( string_list *l ) {
347 channel_options_list = l;
350 inline string_list *get_initial_waypoints () {
351 return initial_waypoints;
354 inline void set_initial_waypoints (string_list *list) {
355 initial_waypoints = list;
358 inline FGScenery * get_scenery () const { return scenery; }
359 inline void set_scenery ( FGScenery *s ) { scenery = s; }
361 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
362 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
364 inline FGIO* get_io() const { return io; }
366 inline FGNasalDisplay *get_Nasal_display() const { return Nasal_display; }
367 inline void set_Nasal_display( FGNasalDisplay *d ) {Nasal_display = d; }
369 inline FGNavList *get_navlist() const { return navlist; }
370 inline void set_navlist( FGNavList *n ) { navlist = n; }
371 inline FGNavList *get_loclist() const { return loclist; }
372 inline void set_loclist( FGNavList *n ) { loclist = n; }
373 inline FGNavList *get_gslist() const { return gslist; }
374 inline void set_gslist( FGNavList *n ) { gslist = n; }
375 inline FGNavList *get_dmelist() const { return dmelist; }
376 inline void set_dmelist( FGNavList *n ) { dmelist = n; }
377 inline FGNavList *get_tacanlist() const { return tacanlist; }
378 inline void set_tacanlist( FGNavList *n ) { tacanlist = n; }
379 inline FGNavList *get_carrierlist() const { return carrierlist; }
380 inline void set_carrierlist( FGNavList *n ) { carrierlist = n; }
381 inline FGNavList *get_mkrlist() const { return mkrlist; }
382 inline void set_mkrlist( FGNavList *n ) { mkrlist = n; }
383 inline FGFixList *get_fixlist() const { return fixlist; }
384 inline void set_fixlist( FGFixList *f ) { fixlist = f; }
385 inline FGTACANList *get_channellist() const { return channellist; }
386 inline void set_channellist( FGTACANList *c ) { channellist = c; }
389 * Save the current state as the initial state.
391 void saveInitialState ();
395 * Restore the saved initial state, if any.
397 void restoreInitialState ();
402 extern FGGlobals *globals;
405 #endif // _GLOBALS_HXX