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
70 class FGAircraftModel;
76 class FGMarkerBeacons;
82 class FGMultiplayRxMgr;
83 class FGMultiplayTxMgr;
92 * Bucket for subsystem pointers representing the sim's state.
100 SGSubsystemMgr * subsystem_mgr;
101 SGEventMgr * event_mgr;
103 // Number of milliseconds elapsed since the start of the program.
106 // Root of FlightGear data tree
109 // Root of FlightGear scenery tree
112 // Fullscreen mode for old 3DFX cards.
113 #if defined(FX) && defined(XMESA)
117 // An offset in seconds from the true time. Allows us to adjust
118 // the effective time of day.
121 // How much to change the value of warp each iteration. Allows us
122 // to make time progress faster than normal (or even run in reverse.)
131 // Magnetic Variation
134 // Material properties library
135 SGMaterialLib *matlib;
137 // Global autopilot "route"
138 FGRouteMgr *route_mgr;
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 // A list of initial waypoints that are read from the command line
186 // and or flight-plan file during initialization
187 string_list *initial_waypoints;
189 // FlightGear scenery manager
195 // Input/Ouput subsystem
202 FGMarkerBeacons *beacons;
205 //Mulitplayer managers
206 FGMultiplayTxMgr *multiplayer_tx_mgr;
208 FGMultiplayRxMgr *multiplayer_rx_mgr;
214 virtual ~FGGlobals();
216 virtual SGSubsystemMgr * get_subsystem_mgr () const;
218 virtual SGSubsystem * get_subsystem (const char * name);
220 virtual void add_subsystem (const char * name,
221 SGSubsystem * subsystem,
222 SGSubsystemMgr::GroupType
223 type = SGSubsystemMgr::GENERAL,
224 double min_time_sec = 0);
226 virtual SGEventMgr * get_event_mgr () const;
228 inline double get_sim_time_sec () const { return sim_time_sec; }
229 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
230 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
232 inline const string &get_fg_root () const { return fg_root; }
233 void set_fg_root (const string &root);
235 inline const string &get_fg_scenery () const { return fg_scenery; }
236 inline void set_fg_scenery (const string &scenery) {
237 fg_scenery = scenery;
240 #if defined(FX) && defined(XMESA)
241 inline bool get_fullscreen() const { return fullscreen; }
242 inline bool set_fullscreen( bool f ) { fullscreen = f; }
245 inline long int get_warp() const { return warp; }
246 inline void set_warp( long int w ) { warp = w; }
247 inline void inc_warp( long int w ) { warp += w; }
249 inline long int get_warp_delta() const { return warp_delta; }
250 inline void set_warp_delta( long int d ) { warp_delta = d; }
251 inline void inc_warp_delta( long int d ) { warp_delta += d; }
253 inline SGTime *get_time_params() const { return time_params; }
254 inline void set_time_params( SGTime *t ) { time_params = t; }
256 inline SGEphemeris *get_ephem() const { return ephem; }
257 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
259 inline SGMagVar *get_mag() const { return mag; }
260 inline void set_mag( SGMagVar *m ) { mag = m; }
262 inline SGMaterialLib *get_matlib() const { return matlib; }
263 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
265 inline FGAirportList *get_airports() const { return airports; }
266 inline void set_airports( FGAirportList *a ) {airports = a; }
268 inline FGRunwayList *get_runways() const { return runways; }
269 inline void set_runways( FGRunwayList *r ) {runways = r; }
271 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
272 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
274 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
275 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
277 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
278 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
280 inline FGPanel *get_current_panel() const { return current_panel; }
281 inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
283 inline SGSoundMgr *get_soundmgr() const { return soundmgr; }
284 inline void set_soundmgr( SGSoundMgr *sm ) { soundmgr = sm; }
286 inline FGControls *get_controls() const { return controls; }
287 inline void set_controls( FGControls *c ) { controls = c; }
289 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
290 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
291 FGViewer *get_current_view() const;
293 inline SGPropertyNode *get_props () { return props; }
294 inline void set_props( SGPropertyNode *n ) { props = n; }
296 inline SGPropertyNode *get_locale () { return locale; }
297 inline void set_locale( SGPropertyNode *n ) { locale = n; }
299 inline SGCommandMgr *get_commands () { return commands; }
301 inline SGModelLib * get_model_lib () { return model_lib; }
303 inline void set_model_lib (SGModelLib *m) {
307 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
309 inline void set_aircraft_model (FGAircraftModel * model)
314 inline FGModelMgr *get_model_mgr () { return model_mgr; }
316 inline void set_model_mgr (FGModelMgr * mgr)
322 inline FGMultiplayTxMgr *get_multiplayer_tx_mgr () { return multiplayer_tx_mgr; }
324 inline void set_multiplayer_tx_mgr (FGMultiplayTxMgr * mgr)
326 multiplayer_tx_mgr = mgr;
329 inline FGMultiplayRxMgr *get_multiplayer_rx_mgr () { return multiplayer_rx_mgr; }
331 inline void set_multiplayer_rx_mgr (FGMultiplayRxMgr * mgr)
333 multiplayer_rx_mgr = mgr;
337 inline string_list *get_channel_options_list () {
338 return channel_options_list;
340 inline void set_channel_options_list( string_list *l ) {
341 channel_options_list = l;
344 inline string_list *get_initial_waypoints () {
345 return initial_waypoints;
348 inline void set_initial_waypoints (string_list *list) {
349 initial_waypoints = list;
352 inline FGScenery * get_scenery () const { return scenery; }
353 inline void set_scenery ( FGScenery *s ) { scenery = s; }
355 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
356 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
358 inline FGIO* get_io() const { return io; }
360 inline FGNavList *get_navlist() const { return navlist; }
361 inline void set_navlist( FGNavList *n ) { navlist = n; }
363 inline FGFixList *get_fixlist() const { return fixlist; }
364 inline void set_fixlist( FGFixList *f ) { fixlist = f; }
366 inline FGILSList *get_ilslist() const { return ilslist; }
367 inline void set_ilslist( FGILSList *i ) { ilslist = i; }
369 inline FGMarkerBeacons *get_beacons() const { return beacons; }
370 inline void set_beacons( FGMarkerBeacons *b ) { beacons = b; }
374 * Save the current state as the initial state.
376 void saveInitialState ();
380 * Restore the saved initial state, if any.
382 void restoreInitialState ();
387 extern FGGlobals *globals;
390 #endif // _GLOBALS_HXX