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>
36 typedef std::vector<std::string> string_list;
37 typedef std::vector<SGPath> PathList;
39 // Forward declarations
41 // This file is included, directly or indirectly, almost everywhere in
42 // FlightGear, so if any of its dependencies changes, most of the sim
43 // has to be recompiled. Using these forward declarations helps us to
44 // avoid including a lot of header files (and thus, a lot of
45 // dependencies). Since Most of the methods simply set or return
46 // pointers, we don't need to know anything about the class details
71 namespace simgear { namespace pkg {
76 * Bucket for subsystem pointers representing the sim's state.
84 // properties, destroy last
85 SGPropertyNode_ptr props;
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
101 * locations to search for (non-scenery) data.
103 PathList additional_data_paths;
105 // Users home directory for data
108 // Roots of FlightGear scenery tree
109 string_list fg_scenery;
110 string_list secure_fg_scenery;
120 // Material properties library
121 SGSharedPtr<SGMaterialLib> matlib;
123 // Global autopilot "route"
124 FGRouteMgr *route_mgr;
129 SGCommandMgr *commands;
131 // list of serial port-like configurations
132 string_list *channel_options_list;
134 // A list of initial waypoints that are read from the command line
135 // and or flight-plan file during initialization
136 string_list *initial_waypoints;
138 // FlightGear scenery manager
139 SGSharedPtr<FGScenery> _scenery;
142 SGSharedPtr<FGTileMgr> _tile_mgr;
144 FGFontCache *fontcache;
147 FGTACANList *channellist;
149 /// roots of Aircraft trees
150 string_list fg_aircraft_dirs;
151 SGPath catalog_aircraft_dir;
153 bool haveUserSettings;
155 SGPropertyNode_ptr positionLon, positionLat, positionAlt;
156 SGPropertyNode_ptr viewLon, viewLat, viewAlt;
157 SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
160 * helper to initialise standard properties on a new property tree
162 void initProperties();
164 SGSharedPtr<FGSampleQueue> _chatter_queue;
166 void cleanupListeners();
168 typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
169 SGPropertyChangeListenerVec _listeners_to_cleanup;
171 SGSharedPtr<simgear::pkg::Root> _packageRoot;
175 virtual ~FGGlobals();
177 virtual FGRenderer *get_renderer () const;
178 void set_renderer(FGRenderer* render);
180 SGSubsystemMgr *get_subsystem_mgr () const;
182 SGSubsystem *get_subsystem (const char * name) const;
185 T* get_subsystem() const
187 return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
191 void add_subsystem (const char * name,
192 SGSubsystem * subsystem,
193 SGSubsystemMgr::GroupType
194 type = SGSubsystemMgr::GENERAL,
195 double min_time_sec = 0);
198 T* add_new_subsystem (SGSubsystemMgr::GroupType
199 type = SGSubsystemMgr::GENERAL,
200 double min_time_sec = 0)
203 add_subsystem(T::subsystemName(), sub, type, min_time_sec);
207 SGEventMgr *get_event_mgr () const;
209 SGSoundMgr *get_soundmgr () const;
211 inline double get_sim_time_sec () const { return sim_time_sec; }
212 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
213 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
215 inline const std::string &get_fg_root () const { return fg_root; }
216 void set_fg_root (const std::string &root);
219 * Get list of data locations. fg_root is always the final item in the
222 PathList get_data_paths() const;
225 * Get data locations which contain the file path suffix. Eg pass ing
226 * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
228 PathList get_data_paths(const std::string& suffix) const;
230 void append_data_path(const SGPath& path);
233 * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
234 * first data directory which defines it.
236 SGPath find_data_dir(const std::string& pathSuffix) const;
238 inline const std::string &get_fg_home () const { return fg_home; }
239 void set_fg_home (const std::string &home);
241 inline const string_list &get_fg_scenery () const { return fg_scenery; }
242 inline const string_list &get_secure_fg_scenery () const { return secure_fg_scenery; }
244 * Add a scenery directory
246 * secure = allow Nasal to read this directory; to avoid
247 * can-read-any-file security holes, do NOT set this on directories
248 * obtained from the property tree (e.g. /sim/terrasync/scenery-dir)
249 * or other Nasal-writable places
251 void append_fg_scenery (const std::string &scenery, bool secure = false);
253 void clear_fg_scenery();
256 * specify a path we'll prepend to the aircraft paths list if non-empty.
257 * This is used with packaged aircraft, to ensure their catalog (and hence,
258 * dependency packages) are found correctly.
260 void set_catalog_aircraft_path(const SGPath& path);
262 string_list get_aircraft_paths() const;
264 void append_aircraft_path(const std::string& path);
265 void append_aircraft_paths(const std::string& path);
268 * Given a path to an aircraft-related resource file, resolve it
269 * against the appropriate root. This means looking at the location
270 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
271 * finishing with fg_root/Aircraft.
273 * if the path could not be resolved, an empty path is returned.
275 SGPath resolve_aircraft_path(const std::string& branch) const;
278 * Same as above, but test for non 'Aircraft/' branch paths, and
279 * always resolve them against fg_root.
281 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
284 * Search in the following directories:
286 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
287 * 2. All aircraft directories if branch starts with Aircraft/
288 * 3. fg_data directory
290 SGPath resolve_resource_path(const std::string& branch) const;
292 inline const std::string &get_browser () const { return browser; }
293 void set_browser (const std::string &b) { browser = b; }
295 long int get_warp() const;
296 void set_warp( long int w );
298 long int get_warp_delta() const;
299 void set_warp_delta( long int d );
301 inline SGTime *get_time_params() const { return time_params; }
302 inline void set_time_params( SGTime *t ) { time_params = t; }
304 inline SGEphemeris *get_ephem() const { return ephem; }
305 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
307 inline SGMaterialLib *get_matlib() const { return matlib; }
308 void set_matlib( SGMaterialLib *m );
310 inline FGViewMgr *get_viewmgr() const { return viewmgr; }
311 inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
312 FGViewer *get_current_view() const;
314 inline SGPropertyNode *get_props () { return props; }
317 * @brief reset the property tree to new, empty tree. Ensure all
318 * subsystems are shutdown and unbound before call this.
320 void resetPropertyRoot();
322 inline FGLocale* get_locale () { return locale; }
324 inline SGCommandMgr *get_commands () { return commands; }
326 SGGeod get_aircraft_position() const;
328 SGVec3d get_aircraft_position_cart() const;
330 void get_aircraft_orientation(double& heading, double& pitch, double& roll);
332 SGGeod get_view_position() const;
334 SGVec3d get_view_position_cart() const;
336 inline string_list *get_channel_options_list () {
337 return channel_options_list;
339 inline void set_channel_options_list( string_list *l ) {
340 channel_options_list = l;
343 inline string_list *get_initial_waypoints () {
344 return initial_waypoints;
347 inline void set_initial_waypoints (string_list *list) {
348 initial_waypoints = list;
351 FGControls *get_controls() const;
353 FGScenery * get_scenery () const;
354 void set_scenery ( FGScenery *s );
356 FGTileMgr * get_tile_mgr () const;
357 void set_tile_mgr ( FGTileMgr *t );
359 inline FGFontCache *get_fontcache() const { return fontcache; }
361 inline FGTACANList *get_channellist() const { return channellist; }
362 inline void set_channellist( FGTACANList *c ) { channellist = c; }
365 * Load user settings from autosave.xml
367 void loadUserSettings(const SGPath& datapath);
370 * Save user settings in autosave.xml
372 void saveUserSettings();
374 FGSampleQueue* get_chatter_queue() const;
375 void set_chatter_queue(FGSampleQueue* queue);
377 void addListenerToCleanup(SGPropertyChangeListener* l);
379 simgear::pkg::Root* packageRoot();
380 void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
384 extern FGGlobals *globals;
387 #endif // _GLOBALS_HXX