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
58 class FGAircraftModel;
60 class FGFlightPlanDispatcher;
75 * Bucket for subsystem pointers representing the sim's state.
83 // properties, destroy last
84 SGPropertyNode_ptr props;
85 SGPropertyNode_ptr initial_state;
91 SGSubsystemMgr *subsystem_mgr;
92 SGEventMgr *event_mgr;
94 // Number of milliseconds elapsed since the start of the program.
97 // Root of FlightGear data tree
100 // Users home directory for data
103 // Roots of FlightGear scenery tree
104 string_list fg_scenery;
114 // Material properties library
115 SGMaterialLib *matlib;
117 // Global autopilot "route"
118 FGRouteMgr *route_mgr;
123 // control input state
124 FGControls *controls;
129 SGCommandMgr *commands;
131 //FGFlightPlanDispatcher *fpDispatcher;
133 FGAircraftModel *acmodel;
135 FGModelMgr * model_mgr;
137 // list of serial port-like configurations
138 string_list *channel_options_list;
140 // A list of initial waypoints that are read from the command line
141 // and or flight-plan file during initialization
142 string_list *initial_waypoints;
144 // FlightGear scenery manager
150 FGFontCache *fontcache;
157 FGNavList *tacanlist;
158 FGNavList *carrierlist;
159 FGTACANList *channellist;
161 /// roots of Aircraft trees
162 string_list fg_aircraft_dirs;
164 bool haveUserSettings;
169 virtual ~FGGlobals();
171 virtual FGRenderer *get_renderer () const;
173 virtual SGSubsystemMgr *get_subsystem_mgr () const;
175 virtual SGSubsystem *get_subsystem (const char * name);
177 virtual void add_subsystem (const char * name,
178 SGSubsystem * subsystem,
179 SGSubsystemMgr::GroupType
180 type = SGSubsystemMgr::GENERAL,
181 double min_time_sec = 0);
183 virtual SGEventMgr *get_event_mgr () const;
185 virtual SGSoundMgr *get_soundmgr () const;
187 inline double get_sim_time_sec () const { return sim_time_sec; }
188 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
189 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
191 inline const std::string &get_fg_root () const { return fg_root; }
192 void set_fg_root (const std::string &root);
194 inline const std::string &get_fg_home () const { return fg_home; }
195 void set_fg_home (const std::string &home);
197 inline const string_list &get_fg_scenery () const { return fg_scenery; }
198 void append_fg_scenery (const std::string &scenery);
200 const string_list& get_aircraft_paths() const { return fg_aircraft_dirs; }
201 void append_aircraft_path(const std::string& path);
202 void append_aircraft_paths(const std::string& path);
205 * Given a path to an aircraft-related resource file, resolve it
206 * against the appropriate root. This means looking at the location
207 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
208 * finishing with fg_root/Aircraft.
210 * if the path could not be resolved, an empty path is returned.
212 SGPath resolve_aircraft_path(const std::string& branch) const;
215 * Same as above, but test for non 'Aircraft/' branch paths, and
216 * always resolve them against fg_root.
218 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
221 * Search in the following directories:
223 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
224 * 2. All aircraft directories if branch starts with Aircraft/
225 * 3. fg_data directory
227 SGPath resolve_ressource_path(const std::string& branch) const;
229 inline const std::string &get_browser () const { return browser; }
230 void set_browser (const std::string &b) { browser = b; }
232 long int get_warp() const;
233 void set_warp( long int w );
235 long int get_warp_delta() const;
236 void set_warp_delta( long int 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 SGMaterialLib *get_matlib() const { return matlib; }
245 inline void set_matlib( SGMaterialLib *m ) { matlib = m; }
247 inline FGATISMgr *get_ATIS_mgr() const { return ATIS_mgr; }
248 inline void set_ATIS_mgr( FGATISMgr *a ) {ATIS_mgr = a; }
250 inline FGControls *get_controls() const { return controls; }
251 inline void set_controls( FGControls *c ) { controls = c; }
253 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
254 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
255 FGViewer *get_current_view() const;
257 inline SGPropertyNode *get_props () { return props; }
258 inline void set_props( SGPropertyNode *n ) { props = n; }
260 inline FGLocale* get_locale () { return locale; }
262 inline SGCommandMgr *get_commands () { return commands; }
264 inline FGAircraftModel *get_aircraft_model () { return acmodel; }
266 inline void set_aircraft_model (FGAircraftModel * model)
271 SGGeod get_aircraft_position() const;
273 SGVec3d get_aircraft_positon_cart() const;
275 inline FGModelMgr *get_model_mgr () { return model_mgr; }
277 inline void set_model_mgr (FGModelMgr * mgr)
282 inline string_list *get_channel_options_list () {
283 return channel_options_list;
285 inline void set_channel_options_list( string_list *l ) {
286 channel_options_list = l;
289 inline string_list *get_initial_waypoints () {
290 return initial_waypoints;
293 inline void set_initial_waypoints (string_list *list) {
294 initial_waypoints = list;
297 inline FGScenery * get_scenery () const { return scenery; }
298 inline void set_scenery ( FGScenery *s ) { scenery = s; }
300 inline FGTileMgr * get_tile_mgr () const { return tile_mgr; }
301 inline void set_tile_mgr ( FGTileMgr *t ) { tile_mgr = t; }
303 inline FGFontCache *get_fontcache() const { return fontcache; }
306 inline FGNavList *get_navlist() const { return navlist; }
307 inline void set_navlist( FGNavList *n ) { navlist = n; }
308 inline FGNavList *get_loclist() const { return loclist; }
309 inline void set_loclist( FGNavList *n ) { loclist = n; }
310 inline FGNavList *get_gslist() const { return gslist; }
311 inline void set_gslist( FGNavList *n ) { gslist = n; }
312 inline FGNavList *get_dmelist() const { return dmelist; }
313 inline void set_dmelist( FGNavList *n ) { dmelist = n; }
314 inline FGNavList *get_tacanlist() const { return tacanlist; }
315 inline void set_tacanlist( FGNavList *n ) { tacanlist = n; }
316 inline FGNavList *get_carrierlist() const { return carrierlist; }
317 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 ();
335 * Load user settings from autosave.xml
337 void loadUserSettings(const SGPath& datapath);
340 * Save user settings in autosave.xml
342 void saveUserSettings();
346 extern FGGlobals *globals;
349 #endif // _GLOBALS_HXX