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
68 namespace simgear { namespace pkg {
73 * Bucket for subsystem pointers representing the sim's state.
81 // properties, destroy last
82 SGPropertyNode_ptr props;
88 SGSubsystemMgr *subsystem_mgr;
89 SGEventMgr *event_mgr;
91 // Number of milliseconds elapsed since the start of the program.
94 // Root of FlightGear data tree
98 * locations to search for (non-scenery) data.
100 PathList additional_data_paths;
102 // Users home directory for data
105 // Roots of FlightGear scenery tree
106 string_list fg_scenery;
107 string_list secure_fg_scenery;
114 // Material properties library
115 SGSharedPtr<SGMaterialLib> matlib;
117 SGCommandMgr *commands;
119 // list of serial port-like configurations
120 string_list *channel_options_list;
122 // A list of initial waypoints that are read from the command line
123 // and or flight-plan file during initialization
124 string_list *initial_waypoints;
127 FGTACANList *channellist;
129 /// roots of Aircraft trees
130 string_list fg_aircraft_dirs;
131 SGPath catalog_aircraft_dir;
133 bool haveUserSettings;
135 SGPropertyNode_ptr positionLon, positionLat, positionAlt;
136 SGPropertyNode_ptr viewLon, viewLat, viewAlt;
137 SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
140 * helper to initialise standard properties on a new property tree
142 void initProperties();
144 SGSharedPtr<FGSampleQueue> _chatter_queue;
146 void cleanupListeners();
148 typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
149 SGPropertyChangeListenerVec _listeners_to_cleanup;
151 SGSharedPtr<simgear::pkg::Root> _packageRoot;
155 virtual ~FGGlobals();
157 virtual FGRenderer *get_renderer () const;
158 void set_renderer(FGRenderer* render);
160 SGSubsystemMgr *get_subsystem_mgr () const;
162 SGSubsystem *get_subsystem (const char * name) const;
165 T* get_subsystem() const
167 return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
171 void add_subsystem (const char * name,
172 SGSubsystem * subsystem,
173 SGSubsystemMgr::GroupType
174 type = SGSubsystemMgr::GENERAL,
175 double min_time_sec = 0);
178 T* add_new_subsystem (SGSubsystemMgr::GroupType
179 type = SGSubsystemMgr::GENERAL,
180 double min_time_sec = 0)
183 add_subsystem(T::subsystemName(), sub, type, min_time_sec);
187 SGEventMgr *get_event_mgr () const;
189 inline double get_sim_time_sec () const { return sim_time_sec; }
190 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
191 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
193 inline const std::string &get_fg_root () const { return fg_root; }
194 void set_fg_root (const std::string &root);
197 * Get list of data locations. fg_root is always the final item in the
200 PathList get_data_paths() const;
203 * Get data locations which contain the file path suffix. Eg pass ing
204 * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
206 PathList get_data_paths(const std::string& suffix) const;
208 void append_data_path(const SGPath& path);
211 * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
212 * first data directory which defines it.
214 SGPath find_data_dir(const std::string& pathSuffix) const;
216 inline const std::string &get_fg_home () const { return fg_home; }
217 void set_fg_home (const std::string &home);
219 inline const string_list &get_fg_scenery () const { return fg_scenery; }
220 inline const string_list &get_secure_fg_scenery () const { return secure_fg_scenery; }
222 * Add a scenery directory
224 * secure = allow Nasal to read this directory; to avoid
225 * can-read-any-file security holes, do NOT set this on directories
226 * obtained from the property tree (e.g. /sim/terrasync/scenery-dir)
227 * or other Nasal-writable places
229 void append_fg_scenery (const std::string &scenery, bool secure = false);
231 void clear_fg_scenery();
234 * specify a path we'll prepend to the aircraft paths list if non-empty.
235 * This is used with packaged aircraft, to ensure their catalog (and hence,
236 * dependency packages) are found correctly.
238 void set_catalog_aircraft_path(const SGPath& path);
240 string_list get_aircraft_paths() const;
242 void append_aircraft_path(const std::string& path);
243 void append_aircraft_paths(const std::string& path);
246 * Given a path to an aircraft-related resource file, resolve it
247 * against the appropriate root. This means looking at the location
248 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
249 * finishing with fg_root/Aircraft.
251 * if the path could not be resolved, an empty path is returned.
253 SGPath resolve_aircraft_path(const std::string& branch) const;
256 * Same as above, but test for non 'Aircraft/' branch paths, and
257 * always resolve them against fg_root.
259 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
262 * Search in the following directories:
264 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
265 * 2. All aircraft directories if branch starts with Aircraft/
266 * 3. fg_data directory
268 SGPath resolve_resource_path(const std::string& branch) const;
270 inline const std::string &get_browser () const { return browser; }
271 void set_browser (const std::string &b) { browser = b; }
273 long int get_warp() const;
274 void set_warp( long int w );
276 long int get_warp_delta() const;
277 void set_warp_delta( long int d );
279 inline SGTime *get_time_params() const { return time_params; }
280 inline void set_time_params( SGTime *t ) { time_params = t; }
282 inline SGMaterialLib *get_matlib() const { return matlib; }
283 void set_matlib( SGMaterialLib *m );
285 inline SGPropertyNode *get_props () { return props; }
288 * @brief reset the property tree to new, empty tree. Ensure all
289 * subsystems are shutdown and unbound before call this.
291 void resetPropertyRoot();
293 inline FGLocale* get_locale () { return locale; }
295 inline SGCommandMgr *get_commands () { return commands; }
297 SGGeod get_aircraft_position() const;
299 SGVec3d get_aircraft_position_cart() const;
301 void get_aircraft_orientation(double& heading, double& pitch, double& roll);
303 SGGeod get_view_position() const;
305 SGVec3d get_view_position_cart() const;
307 inline string_list *get_channel_options_list () {
308 return channel_options_list;
310 inline void set_channel_options_list( string_list *l ) {
311 channel_options_list = l;
314 inline string_list *get_initial_waypoints () {
315 return initial_waypoints;
318 inline void set_initial_waypoints (string_list *list) {
319 initial_waypoints = list;
322 FGViewMgr *get_viewmgr() const;
323 FGViewer *get_current_view() const;
325 FGControls *get_controls() const;
327 FGScenery * get_scenery () const;
329 FGTileMgr * get_tile_mgr () const;
331 inline FGTACANList *get_channellist() const { return channellist; }
332 inline void set_channellist( FGTACANList *c ) { channellist = c; }
335 * Load user settings from autosave.xml
337 void loadUserSettings(const SGPath& datapath);
340 * Save user settings in autosave.xml
342 void saveUserSettings();
344 FGSampleQueue* get_chatter_queue() const;
345 void set_chatter_queue(FGSampleQueue* queue);
347 void addListenerToCleanup(SGPropertyChangeListener* l);
349 simgear::pkg::Root* packageRoot();
350 void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
354 extern FGGlobals *globals;
357 #endif // _GLOBALS_HXX