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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
28 #include <simgear/props/props.hxx>
29 #include <simgear/structure/subsystem_mgr.hxx>
30 #include <simgear/misc/sg_path.hxx>
35 typedef std::vector<std::string> string_list;
37 // Forward declarations
39 // This file is included, directly or indirectly, almost everywhere in
40 // FlightGear, so if any of its dependencies changes, most of the sim
41 // has to be recompiled. Using these forward declarations helps us to
42 // avoid including a lot of header files (and thus, a lot of
43 // dependencies). Since Most of the methods simply set or return
44 // pointers, we don't need to know anything about the class details
59 class FGAircraftModel;
61 class FGFlightPlanDispatcher;
76 * Bucket for subsystem pointers representing the sim's state.
84 // properties, destroy last
85 SGPropertyNode_ptr props;
86 SGPropertyNode_ptr initial_state;
89 SGPropertyNode_ptr locale;
92 SGSubsystemMgr *subsystem_mgr;
93 SGEventMgr *event_mgr;
96 // Number of milliseconds elapsed since the start of the program.
99 // Root of FlightGear data tree
102 // Roots of FlightGear scenery tree
103 string_list fg_scenery;
107 // An offset in seconds from the true time. Allows us to adjust
108 // the effective time of day.
111 // How much to change the value of warp each iteration. Allows us
112 // to make time progress faster than normal (or even run in reverse.)
121 // Magnetic Variation
124 // Material properties library
125 SGMaterialLib *matlib;
127 // Global autopilot "route"
128 FGRouteMgr *route_mgr;
131 FGPanel *current_panel;
136 // control input state
137 FGControls *controls;
142 SGCommandMgr *commands;
144 //FGFlightPlanDispatcher *fpDispatcher;
146 FGAircraftModel *acmodel;
148 FGModelMgr * model_mgr;
150 // list of serial port-like configurations
151 string_list *channel_options_list;
153 // A list of initial waypoints that are read from the command line
154 // and or flight-plan file during initialization
155 string_list *initial_waypoints;
157 // FlightGear scenery manager
163 FGFontCache *fontcache;
170 FGNavList *tacanlist;
171 FGNavList *carrierlist;
172 FGTACANList *channellist;
174 /// roots of Aircraft trees
175 string_list fg_aircraft_dirs;
179 virtual ~FGGlobals();
181 virtual FGRenderer *get_renderer () const;
183 virtual SGSubsystemMgr *get_subsystem_mgr () const;
185 virtual SGSubsystem *get_subsystem (const char * name);
187 virtual void add_subsystem (const char * name,
188 SGSubsystem * subsystem,
189 SGSubsystemMgr::GroupType
190 type = SGSubsystemMgr::GENERAL,
191 double min_time_sec = 0);
193 virtual SGEventMgr *get_event_mgr () const;
195 virtual SGSoundMgr *get_soundmgr () const;
197 inline double get_sim_time_sec () const { return sim_time_sec; }
198 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
199 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
201 inline const std::string &get_fg_root () const { return fg_root; }
202 void set_fg_root (const std::string &root);
204 inline const string_list &get_fg_scenery () const { return fg_scenery; }
205 void set_fg_scenery (const std::string &scenery);
207 const string_list& get_aircraft_paths() const { return fg_aircraft_dirs; }
208 void append_aircraft_path(const std::string& path);
209 void append_aircraft_paths(const std::string& path);
212 * Given a path to an aircraft-related resource file, resolve it
213 * against the appropriate root. This means looking at the location
214 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
215 * finishing with fg_root/Aircraft.
217 * if the path could not be resolved, an empty path is returned.
219 SGPath resolve_aircraft_path(const std::string& branch) const;
222 * Same as above, but test for non 'Aircraft/' branch paths, and
223 * always resolve them against fg_root.
225 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
227 inline const std::string &get_browser () const { return browser; }
228 void set_browser (const std::string &b) { browser = b; }
230 inline long int get_warp() const { return warp; }
231 inline void set_warp( long int w ) { warp = w; }
232 inline void inc_warp( long int w ) { warp += w; }
234 inline long int get_warp_delta() const { return warp_delta; }
235 inline void set_warp_delta( long int d ) { warp_delta = d; }
236 inline void inc_warp_delta( long int d ) { warp_delta += d; }
238 inline SGTime *get_time_params() const { return time_params; }
239 inline void set_time_params( SGTime *t ) { time_params = t; }
241 inline SGEphemeris *get_ephem() const { return ephem; }
242 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
244 inline SGMagVar *get_mag() const { return mag; }
245 inline void set_mag( SGMagVar *m ) { mag = m; }
247 inline SGMaterialLib *get_matlib() const { return matlib; }
248 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
250 inline FGATCMgr *get_ATC_mgr() const { return ATC_mgr; }
251 inline void set_ATC_mgr( FGATCMgr *a ) {ATC_mgr = a; }
253 inline FGPanel *get_current_panel() const { return current_panel; }
254 inline void set_current_panel( FGPanel *cp ) { current_panel = cp; }
256 inline FGControls *get_controls() const { return controls; }
257 inline void set_controls( FGControls *c ) { controls = c; }
259 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
260 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
261 FGViewer *get_current_view() const;
263 inline SGPropertyNode *get_props () { return props; }
264 inline void set_props( SGPropertyNode *n ) { props = n; }
266 inline SGPropertyNode *get_locale () { return locale; }
267 inline void set_locale( SGPropertyNode *n ) { locale = n; }
269 inline SGCommandMgr *get_commands () { return commands; }
271 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
273 inline void set_aircraft_model (FGAircraftModel * model)
278 inline FGModelMgr *get_model_mgr () { return model_mgr; }
280 inline void set_model_mgr (FGModelMgr * mgr)
285 inline string_list *get_channel_options_list () {
286 return channel_options_list;
288 inline void set_channel_options_list( string_list *l ) {
289 channel_options_list = l;
292 inline string_list *get_initial_waypoints () {
293 return initial_waypoints;
296 inline void set_initial_waypoints (string_list *list) {
297 initial_waypoints = list;
300 inline FGScenery * get_scenery () const { return scenery; }
301 inline void set_scenery ( FGScenery *s ) { scenery = s; }
303 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
304 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
306 inline FGFontCache *get_fontcache() const { return fontcache; }
308 inline FGNavList *get_navlist() const { return navlist; }
309 inline void set_navlist( FGNavList *n ) { navlist = n; }
310 inline FGNavList *get_loclist() const { return loclist; }
311 inline void set_loclist( FGNavList *n ) { loclist = n; }
312 inline FGNavList *get_gslist() const { return gslist; }
313 inline void set_gslist( FGNavList *n ) { gslist = n; }
314 inline FGNavList *get_dmelist() const { return dmelist; }
315 inline void set_dmelist( FGNavList *n ) { dmelist = n; }
316 inline FGNavList *get_tacanlist() const { return tacanlist; }
317 inline void set_tacanlist( FGNavList *n ) { tacanlist = n; }
318 inline FGNavList *get_carrierlist() const { return carrierlist; }
319 inline void set_carrierlist( FGNavList *n ) { carrierlist = n; }
320 inline FGTACANList *get_channellist() const { return channellist; }
321 inline void set_channellist( FGTACANList *c ) { channellist = c; }
324 * Save the current state as the initial state.
326 void saveInitialState ();
330 * Restore the saved initial state, if any.
332 void restoreInitialState ();
337 extern FGGlobals *globals;
340 #endif // _GLOBALS_HXX