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;
36 typedef std::vector<SGPath> PathList;
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
71 * Bucket for subsystem pointers representing the sim's state.
79 // properties, destroy last
80 SGPropertyNode_ptr props;
81 SGPropertyNode_ptr initial_state;
87 SGSubsystemMgr *subsystem_mgr;
88 SGEventMgr *event_mgr;
90 // Number of milliseconds elapsed since the start of the program.
93 // Root of FlightGear data tree
97 * locations to search for (non-scenery) data.
99 PathList additional_data_paths;
101 // Users home directory for data
104 // Roots of FlightGear scenery tree
105 string_list fg_scenery;
115 // Material properties library
116 SGSharedPtr<SGMaterialLib> matlib;
118 // Global autopilot "route"
119 FGRouteMgr *route_mgr;
121 // control input state
122 FGControls *controls;
127 SGCommandMgr *commands;
129 // list of serial port-like configurations
130 string_list *channel_options_list;
132 // A list of initial waypoints that are read from the command line
133 // and or flight-plan file during initialization
134 string_list *initial_waypoints;
136 // FlightGear scenery manager
137 SGSharedPtr<FGScenery> _scenery;
140 SGSharedPtr<FGTileMgr> _tile_mgr;
142 FGFontCache *fontcache;
145 FGTACANList *channellist;
147 /// roots of Aircraft trees
148 string_list fg_aircraft_dirs;
150 bool haveUserSettings;
152 SGPropertyNode_ptr positionLon, positionLat, positionAlt;
153 SGPropertyNode_ptr viewLon, viewLat, viewAlt;
154 SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
157 * helper to initialise standard properties on a new property tree
159 void initProperties();
161 SGSharedPtr<FGSampleQueue> _chatter_queue;
163 void cleanupListeners();
165 typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
166 SGPropertyChangeListenerVec _listeners_to_cleanup;
171 virtual ~FGGlobals();
173 virtual FGRenderer *get_renderer () const;
174 void set_renderer(FGRenderer* render);
176 virtual SGSubsystemMgr *get_subsystem_mgr () const;
178 virtual SGSubsystem *get_subsystem (const char * name);
180 virtual void add_subsystem (const char * name,
181 SGSubsystem * subsystem,
182 SGSubsystemMgr::GroupType
183 type = SGSubsystemMgr::GENERAL,
184 double min_time_sec = 0);
186 virtual SGEventMgr *get_event_mgr () const;
188 virtual SGSoundMgr *get_soundmgr () const;
190 inline double get_sim_time_sec () const { return sim_time_sec; }
191 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
192 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
194 inline const std::string &get_fg_root () const { return fg_root; }
195 void set_fg_root (const std::string &root);
198 * Get list of data locations. fg_root is always the final item in the
201 PathList get_data_paths() const;
204 * Get data locations which contain the file path suffix. Eg pass ing
205 * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
207 PathList get_data_paths(const std::string& suffix) const;
209 void append_data_path(const SGPath& path);
212 * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
213 * first data directory which defines it.
215 SGPath find_data_dir(const std::string& pathSuffix) const;
217 inline const std::string &get_fg_home () const { return fg_home; }
218 void set_fg_home (const std::string &home);
220 inline const string_list &get_fg_scenery () const { return fg_scenery; }
221 void append_fg_scenery (const std::string &scenery);
223 const string_list& get_aircraft_paths() const { return fg_aircraft_dirs; }
224 void append_aircraft_path(const std::string& path);
225 void append_aircraft_paths(const std::string& path);
228 * Given a path to an aircraft-related resource file, resolve it
229 * against the appropriate root. This means looking at the location
230 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
231 * finishing with fg_root/Aircraft.
233 * if the path could not be resolved, an empty path is returned.
235 SGPath resolve_aircraft_path(const std::string& branch) const;
238 * Same as above, but test for non 'Aircraft/' branch paths, and
239 * always resolve them against fg_root.
241 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
244 * Search in the following directories:
246 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
247 * 2. All aircraft directories if branch starts with Aircraft/
248 * 3. fg_data directory
250 SGPath resolve_resource_path(const std::string& branch) const;
252 inline const std::string &get_browser () const { return browser; }
253 void set_browser (const std::string &b) { browser = b; }
255 long int get_warp() const;
256 void set_warp( long int w );
258 long int get_warp_delta() const;
259 void set_warp_delta( long int d );
261 inline SGTime *get_time_params() const { return time_params; }
262 inline void set_time_params( SGTime *t ) { time_params = t; }
264 inline SGEphemeris *get_ephem() const { return ephem; }
265 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
267 inline SGMaterialLib *get_matlib() const { return matlib; }
268 void set_matlib( SGMaterialLib *m );
270 inline FGControls *get_controls() const { return controls; }
271 inline void set_controls( FGControls *c ) { controls = c; }
273 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
274 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
275 FGViewer *get_current_view() const;
277 inline SGPropertyNode *get_props () { return props; }
280 * @brief reset the property tree to new, empty tree. Ensure all
281 * subsystems are shutdown and unbound before call this.
283 void resetPropertyRoot();
285 inline FGLocale* get_locale () { return locale; }
287 inline SGCommandMgr *get_commands () { return commands; }
289 SGGeod get_aircraft_position() const;
291 SGVec3d get_aircraft_position_cart() const;
293 void get_aircraft_orientation(double& heading, double& pitch, double& roll);
295 SGGeod get_view_position() const;
297 SGVec3d get_view_position_cart() const;
299 inline string_list *get_channel_options_list () {
300 return channel_options_list;
302 inline void set_channel_options_list( string_list *l ) {
303 channel_options_list = l;
306 inline string_list *get_initial_waypoints () {
307 return initial_waypoints;
310 inline void set_initial_waypoints (string_list *list) {
311 initial_waypoints = list;
314 FGScenery * get_scenery () const;
315 void set_scenery ( FGScenery *s );
317 FGTileMgr * get_tile_mgr () const;
318 void set_tile_mgr ( FGTileMgr *t );
320 inline FGFontCache *get_fontcache() const { return fontcache; }
322 inline FGTACANList *get_channellist() const { return channellist; }
323 inline void set_channellist( FGTACANList *c ) { channellist = c; }
326 * Save the current state as the initial state.
328 void saveInitialState ();
332 * Restore the saved initial state, if any.
334 void restoreInitialState ();
337 * Load user settings from autosave.xml
339 void loadUserSettings(const SGPath& datapath);
342 * Save user settings in autosave.xml
344 void saveUserSettings();
346 FGSampleQueue* get_chatter_queue() const;
347 void set_chatter_queue(FGSampleQueue* queue);
349 void addListenerToCleanup(SGPropertyChangeListener* l);
353 extern FGGlobals *globals;
356 #endif // _GLOBALS_HXX