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 SGCommandMgr *commands;
125 // list of serial port-like configurations
126 string_list *channel_options_list;
128 // A list of initial waypoints that are read from the command line
129 // and or flight-plan file during initialization
130 string_list *initial_waypoints;
132 FGFontCache *fontcache;
135 FGTACANList *channellist;
137 /// roots of Aircraft trees
138 string_list fg_aircraft_dirs;
139 SGPath catalog_aircraft_dir;
141 bool haveUserSettings;
143 SGPropertyNode_ptr positionLon, positionLat, positionAlt;
144 SGPropertyNode_ptr viewLon, viewLat, viewAlt;
145 SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
148 * helper to initialise standard properties on a new property tree
150 void initProperties();
152 SGSharedPtr<FGSampleQueue> _chatter_queue;
154 void cleanupListeners();
156 typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
157 SGPropertyChangeListenerVec _listeners_to_cleanup;
159 SGSharedPtr<simgear::pkg::Root> _packageRoot;
163 virtual ~FGGlobals();
165 virtual FGRenderer *get_renderer () const;
166 void set_renderer(FGRenderer* render);
168 SGSubsystemMgr *get_subsystem_mgr () const;
170 SGSubsystem *get_subsystem (const char * name) const;
173 T* get_subsystem() const
175 return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
179 void add_subsystem (const char * name,
180 SGSubsystem * subsystem,
181 SGSubsystemMgr::GroupType
182 type = SGSubsystemMgr::GENERAL,
183 double min_time_sec = 0);
186 T* add_new_subsystem (SGSubsystemMgr::GroupType
187 type = SGSubsystemMgr::GENERAL,
188 double min_time_sec = 0)
191 add_subsystem(T::subsystemName(), sub, type, min_time_sec);
195 SGEventMgr *get_event_mgr () const;
197 SGSoundMgr *get_soundmgr () const;
199 inline double get_sim_time_sec () const { return sim_time_sec; }
200 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
201 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
203 inline const std::string &get_fg_root () const { return fg_root; }
204 void set_fg_root (const std::string &root);
207 * Get list of data locations. fg_root is always the final item in the
210 PathList get_data_paths() const;
213 * Get data locations which contain the file path suffix. Eg pass ing
214 * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
216 PathList get_data_paths(const std::string& suffix) const;
218 void append_data_path(const SGPath& path);
221 * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
222 * first data directory which defines it.
224 SGPath find_data_dir(const std::string& pathSuffix) const;
226 inline const std::string &get_fg_home () const { return fg_home; }
227 void set_fg_home (const std::string &home);
229 inline const string_list &get_fg_scenery () const { return fg_scenery; }
230 inline const string_list &get_secure_fg_scenery () const { return secure_fg_scenery; }
232 * Add a scenery directory
234 * secure = allow Nasal to read this directory; to avoid
235 * can-read-any-file security holes, do NOT set this on directories
236 * obtained from the property tree (e.g. /sim/terrasync/scenery-dir)
237 * or other Nasal-writable places
239 void append_fg_scenery (const std::string &scenery, bool secure = false);
241 void clear_fg_scenery();
244 * specify a path we'll prepend to the aircraft paths list if non-empty.
245 * This is used with packaged aircraft, to ensure their catalog (and hence,
246 * dependency packages) are found correctly.
248 void set_catalog_aircraft_path(const SGPath& path);
250 string_list get_aircraft_paths() const;
252 void append_aircraft_path(const std::string& path);
253 void append_aircraft_paths(const std::string& path);
256 * Given a path to an aircraft-related resource file, resolve it
257 * against the appropriate root. This means looking at the location
258 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
259 * finishing with fg_root/Aircraft.
261 * if the path could not be resolved, an empty path is returned.
263 SGPath resolve_aircraft_path(const std::string& branch) const;
266 * Same as above, but test for non 'Aircraft/' branch paths, and
267 * always resolve them against fg_root.
269 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
272 * Search in the following directories:
274 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
275 * 2. All aircraft directories if branch starts with Aircraft/
276 * 3. fg_data directory
278 SGPath resolve_resource_path(const std::string& branch) const;
280 inline const std::string &get_browser () const { return browser; }
281 void set_browser (const std::string &b) { browser = b; }
283 long int get_warp() const;
284 void set_warp( long int w );
286 long int get_warp_delta() const;
287 void set_warp_delta( long int d );
289 inline SGTime *get_time_params() const { return time_params; }
290 inline void set_time_params( SGTime *t ) { time_params = t; }
292 inline SGEphemeris *get_ephem() const { return ephem; }
293 inline void set_ephem( SGEphemeris *e ) { ephem = e; }
295 inline SGMaterialLib *get_matlib() const { return matlib; }
296 void set_matlib( SGMaterialLib *m );
298 inline SGPropertyNode *get_props () { return props; }
301 * @brief reset the property tree to new, empty tree. Ensure all
302 * subsystems are shutdown and unbound before call this.
304 void resetPropertyRoot();
306 inline FGLocale* get_locale () { return locale; }
308 inline SGCommandMgr *get_commands () { return commands; }
310 SGGeod get_aircraft_position() const;
312 SGVec3d get_aircraft_position_cart() const;
314 void get_aircraft_orientation(double& heading, double& pitch, double& roll);
316 SGGeod get_view_position() const;
318 SGVec3d get_view_position_cart() const;
320 inline string_list *get_channel_options_list () {
321 return channel_options_list;
323 inline void set_channel_options_list( string_list *l ) {
324 channel_options_list = l;
327 inline string_list *get_initial_waypoints () {
328 return initial_waypoints;
331 inline void set_initial_waypoints (string_list *list) {
332 initial_waypoints = list;
335 FGViewMgr *get_viewmgr() const;
336 FGViewer *get_current_view() const;
338 FGControls *get_controls() const;
340 FGScenery * get_scenery () const;
342 FGTileMgr * get_tile_mgr () const;
344 inline FGFontCache *get_fontcache() const { return fontcache; }
346 inline FGTACANList *get_channellist() const { return channellist; }
347 inline void set_channellist( FGTACANList *c ) { channellist = c; }
350 * Load user settings from autosave.xml
352 void loadUserSettings(const SGPath& datapath);
355 * Save user settings in autosave.xml
357 void saveUserSettings();
359 FGSampleQueue* get_chatter_queue() const;
360 void set_chatter_queue(FGSampleQueue* queue);
362 void addListenerToCleanup(SGPropertyChangeListener* l);
364 simgear::pkg::Root* packageRoot();
365 void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
369 extern FGGlobals *globals;
372 #endif // _GLOBALS_HXX