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 SG_USING_STD( vector );
33 SG_USING_STD( string );
35 typedef vector<string> string_list;
38 // Forward declarations
40 // This file is included, directly or indirectly, almost everywhere in
41 // FlightGear, so if any of its dependencies changes, most of the sim
42 // has to be recompiled. Using these forward declarations helps us to
43 // avoid including a lot of header files (and thus, a lot of
44 // dependencies). Since Most of the methods simply set or return
45 // pointers, we don't need to know anything about the class details
57 class FGEnvironmentMgr;
63 class FGInstrumentMgr;
72 class FGTextureLoader;
73 class FGAircraftModel;
79 * Bucket for subsystem pointers representing the sim's state.
86 // Number of milliseconds elapsed since the start of the program.
89 // Root of FlightGear data tree
92 // Root of FlightGear scenery tree
100 // Fullscreen mode for old 3DFX cards.
101 #if defined(FX) && defined(XMESA)
105 // An offset in seconds from the true time. Allows us to adjust
106 // the effective time of day.
109 // How much to change the value of warp each iteration. Allows us
110 // to make time progress faster than normal (or even run in reverse.)
122 // Magnetic Variation
126 FGAutopilot *autopilot;
128 // Global autopilot "route"
132 FGSoundMgr *soundmgr;
134 // sound-effects manager
137 // aircraft system manager
138 FGSystemMgr * systemmgr;
140 // aircraft instrument manager
141 FGInstrumentMgr * instrumentmgr;
143 // environment information
144 FGEnvironmentMgr * environment_mgr;
150 FGATCDisplay *ATC_display;
155 // control input state
156 FGControls *controls;
165 SGPropertyNode *props;
166 SGPropertyNode *initial_state;
169 SGPropertyNode *locale;
171 SGCommandMgr *commands;
173 FGModelLoader * model_loader;
175 FGTextureLoader * texture_loader;
177 FGAircraftModel *acmodel;
179 FGModelMgr * model_mgr;
181 // list of serial port-like configurations
182 string_list *channel_options_list;
184 // FlightGear scenery manager
194 inline double get_sim_time_sec () const { return sim_time_sec; }
195 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
196 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
198 inline const string &get_fg_root () const { return fg_root; }
199 inline void set_fg_root (const string &root) { fg_root = root; }
201 inline const string &get_fg_scenery () const { return fg_scenery; }
202 inline void set_fg_scenery (const string &scenery) {
203 fg_scenery = scenery;
207 inline bool get_freeze() const { return freeze; }
208 inline void set_freeze( bool f ) { freeze = f; }
211 #if defined(FX) && defined(XMESA)
212 inline bool get_fullscreen() const { return fullscreen; }
213 inline bool set_fullscreen( bool f ) { fullscreen = f; }
216 inline long int get_warp() const { return warp; }
217 inline void set_warp( long int w ) { warp = w; }
218 inline void inc_warp( long int w ) { warp += w; }
220 inline long int get_warp_delta() const { return warp_delta; }
221 inline void set_warp_delta( long int d ) { warp_delta = d; }
222 inline void inc_warp_delta( long int d ) { warp_delta += d; }
224 inline FGLogger * get_logger () { return logger; }
225 inline void set_logger (FGLogger * l) { logger = l; }
227 inline SGTime *get_time_params() const { return time_params; }
228 inline void set_time_params( SGTime *t ) { time_params = t; }
230 inline SGEphemeris *get_ephem() const { return ephem; }
231 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
233 inline SGMagVar *get_mag() const { return mag; }
234 inline void set_mag( SGMagVar *m ) { mag = m; }
236 inline FGAutopilot *get_autopilot() const { return autopilot; }
237 inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
239 inline SGRoute *get_route() const { return route; }
240 inline void set_route( SGRoute *r ) { route = r; }
242 inline FGEnvironmentMgr * get_environment_mgr() {
243 return environment_mgr;
245 inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
246 environment_mgr = mgr;
249 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
250 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
252 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
253 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
255 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
256 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
258 inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
259 inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
261 inline FGSystemMgr *get_systemmgr() const { return systemmgr; }
263 inline FGInstrumentMgr *get_instrumentmgr() const { return instrumentmgr; }
265 inline FGFX *get_fx() const { return fx; }
266 inline void set_fx( FGFX *x ) { fx = x; }
268 inline FGControls *get_controls() const { return controls; }
269 inline void set_controls( FGControls *c ) { controls = c; }
271 inline FGSteam *get_steam() const { return steam; }
272 inline void set_steam( FGSteam *s ) { steam = s; }
274 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
275 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
276 FGViewer *get_current_view() const;
278 inline SGPropertyNode *get_props () { return props; }
279 inline void set_props( SGPropertyNode *n ) { props = n; }
281 inline SGPropertyNode *get_locale () { return locale; }
282 inline void set_locale( SGPropertyNode *n ) { locale = n; }
284 inline SGCommandMgr *get_commands () { return commands; }
286 inline FGModelLoader * get_model_loader () { return model_loader; }
288 inline void set_model_loader (FGModelLoader * loader) {
289 model_loader = loader;
292 inline FGTextureLoader * get_texture_loader () { return texture_loader; }
294 inline void set_texture_loader (FGTextureLoader * loader) {
295 texture_loader = loader;
298 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
300 inline void set_aircraft_model (FGAircraftModel * model)
305 inline FGModelMgr *get_model_mgr () { return model_mgr; }
307 inline void set_model_mgr (FGModelMgr * mgr)
312 inline string_list *get_channel_options_list () {
313 return channel_options_list;
315 inline void set_channel_options_list( string_list *l ) {
316 channel_options_list = l;
319 inline FGScenery * get_scenery () const { return scenery; }
320 inline void set_scenery ( FGScenery *s ) { scenery = s; }
322 FGIO* get_io() const { return io; }
325 * Save the current state as the initial state.
327 void saveInitialState ();
331 * Restore the saved initial state, if any.
333 void restoreInitialState ();
338 extern FGGlobals *globals;
341 #endif // _GLOBALS_HXX