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 #include "viewmgr.hxx"
34 SG_USING_STD( vector );
35 SG_USING_STD( string );
37 typedef vector<string> string_list;
40 // Forward declarations
42 // This file is included, directly or indirectly, almost everywhere in
43 // FlightGear, so if any of its dependencies changes, most of the sim
44 // has to be recompiled. Using these forward declarations helps us to
45 // avoid including a lot of header files (and thus, a lot of
46 // dependencies). Since Most of the methods simply set or return
47 // pointers, we don't need to know anything about the class details
58 class FGEnvironmentMgr;
71 * Bucket for subsystem pointers representing the sim's state.
78 // Number of milliseconds elapsed since the start of the program.
81 // Root of FlightGear data tree
84 // Root of FlightGear scenery tree
92 // Fullscreen mode for old 3DFX cards.
93 #if defined(FX) && defined(XMESA)
97 // An offset in seconds from the true time. Allows us to adjust
98 // the effective time of day.
101 // How much to change the value of warp each iteration. Allows us
102 // to make time progress faster than normal (or even run in reverse.)
114 // Magnetic Variation
118 FGAutopilot *autopilot;
120 // Global autopilot "route"
124 FGSoundMgr *soundmgr;
126 // sound-effects manager
129 // environment information
130 FGEnvironmentMgr * environment_mgr;
136 FGATCDisplay *ATC_display;
141 // control input state
142 FGControls *controls;
148 SGPropertyNode *props;
149 SGPropertyNode *initial_state;
151 SGCommandMgr *commands;
153 // list of serial port-like configurations
154 string_list *channel_options_list;
161 inline long get_elapsed_time_ms () const { return elapsed_time_ms; }
162 inline void set_elapsed_time_ms (long t) { elapsed_time_ms = t; }
164 inline const string &get_fg_root () const { return fg_root; }
165 inline void set_fg_root (const string &root) { fg_root = root; }
167 inline const string &get_fg_scenery () const { return fg_scenery; }
168 inline void set_fg_scenery (const string &scenery) {
169 fg_scenery = scenery;
173 inline bool get_freeze() const { return freeze; }
174 inline void set_freeze( bool f ) { freeze = f; }
177 #if defined(FX) && defined(XMESA)
178 inline bool get_fullscreen() const { return fullscreen; }
179 inline bool set_fullscreen( bool f ) { fullscreen = f; }
182 inline long int get_warp() const { return warp; }
183 inline void set_warp( long int w ) { warp = w; }
184 inline void inc_warp( long int w ) { warp += w; }
186 inline long int get_warp_delta() const { return warp_delta; }
187 inline void set_warp_delta( long int d ) { warp_delta = d; }
188 inline void inc_warp_delta( long int d ) { warp_delta += d; }
190 inline FGLogger * get_logger () { return logger; }
191 inline void set_logger (FGLogger * l) { logger = l; }
193 inline SGTime *get_time_params() const { return time_params; }
194 inline void set_time_params( SGTime *t ) { time_params = t; }
196 inline SGEphemeris *get_ephem() const { return ephem; }
197 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
199 inline SGMagVar *get_mag() const { return mag; }
200 inline void set_mag( SGMagVar *m ) { mag = m; }
202 inline FGAutopilot *get_autopilot() const { return autopilot; }
203 inline void set_autopilot( FGAutopilot *ap) { autopilot = ap; }
205 inline SGRoute *get_route() const { return route; }
206 inline void set_route( SGRoute *r ) { route = r; }
208 inline FGEnvironmentMgr * get_environment_mgr() {
209 return environment_mgr;
211 inline void set_environment_mgr(FGEnvironmentMgr * mgr) {
212 environment_mgr = mgr;
214 const FGEnvironment * get_environment() const;
215 const FGEnvironment * get_environment(double lat, double lon,
218 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
219 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
221 inline FGATCDisplay *get_ATC_display() const { return ATC_display; }
222 inline void set_ATC_display( FGATCDisplay *d ) {ATC_display = d; }
224 inline FGAIMgr *get_AI_mgr() const { return AI_mgr; }
225 inline void set_AI_mgr( FGAIMgr *a ) {AI_mgr = a; }
227 inline FGSoundMgr *get_soundmgr() const { return soundmgr; }
228 inline void set_soundmgr( FGSoundMgr *sm ) { soundmgr = sm; }
230 inline FGFX *get_fx() const { return fx; }
231 inline void set_fx( FGFX *x ) { fx = x; }
233 inline FGControls *get_controls() const { return controls; }
234 inline void set_controls( FGControls *c ) { controls = c; }
236 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
237 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
238 inline FGViewer *get_current_view() const {
239 return viewmgr->get_current_view();
242 inline SGPropertyNode *get_props () { return props; }
243 inline void set_props( SGPropertyNode *n ) { props = n; }
245 inline SGCommandMgr *get_commands () { return commands; }
247 inline string_list *get_channel_options_list () {
248 return channel_options_list;
250 inline void set_channel_options_list( string_list *l ) {
251 channel_options_list = l;
256 * Save the current state as the initial state.
258 void saveInitialState ();
262 * Restore the saved initial state, if any.
264 void restoreInitialState ();
269 extern FGGlobals *globals;
272 #endif // _GLOBALS_HXX