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
67 namespace simgear { namespace pkg {
72 * Bucket for subsystem pointers representing the sim's state.
80 // properties, destroy last
81 SGPropertyNode_ptr props;
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;
106 string_list secure_fg_scenery;
113 // Material properties library
114 SGSharedPtr<SGMaterialLib> matlib;
116 SGCommandMgr *commands;
118 // list of serial port-like configurations
119 string_list *channel_options_list;
121 // A list of initial waypoints that are read from the command line
122 // and or flight-plan file during initialization
123 string_list *initial_waypoints;
126 FGTACANList *channellist;
128 /// roots of Aircraft trees
129 string_list fg_aircraft_dirs;
130 SGPath catalog_aircraft_dir;
132 bool haveUserSettings;
134 SGPropertyNode_ptr positionLon, positionLat, positionAlt;
135 SGPropertyNode_ptr viewLon, viewLat, viewAlt;
136 SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
139 * helper to initialise standard properties on a new property tree
141 void initProperties();
143 void cleanupListeners();
145 typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
146 SGPropertyChangeListenerVec _listeners_to_cleanup;
148 SGSharedPtr<simgear::pkg::Root> _packageRoot;
152 virtual ~FGGlobals();
154 virtual FGRenderer *get_renderer () const;
155 void set_renderer(FGRenderer* render);
157 SGSubsystemMgr *get_subsystem_mgr () const;
159 SGSubsystem *get_subsystem (const char * name) const;
162 T* get_subsystem() const
164 return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
168 void add_subsystem (const char * name,
169 SGSubsystem * subsystem,
170 SGSubsystemMgr::GroupType
171 type = SGSubsystemMgr::GENERAL,
172 double min_time_sec = 0);
175 T* add_new_subsystem (SGSubsystemMgr::GroupType
176 type = SGSubsystemMgr::GENERAL,
177 double min_time_sec = 0)
180 add_subsystem(T::subsystemName(), sub, type, min_time_sec);
184 SGEventMgr *get_event_mgr () const;
186 inline double get_sim_time_sec () const { return sim_time_sec; }
187 inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
188 inline void set_sim_time_sec (double t) { sim_time_sec = t; }
190 inline const std::string &get_fg_root () const { return fg_root; }
191 void set_fg_root (const std::string &root);
194 * Get list of data locations. fg_root is always the final item in the
197 PathList get_data_paths() const;
200 * Get data locations which contain the file path suffix. Eg pass ing
201 * 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
203 PathList get_data_paths(const std::string& suffix) const;
205 void append_data_path(const SGPath& path);
208 * Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
209 * first data directory which defines it.
211 SGPath find_data_dir(const std::string& pathSuffix) const;
213 inline const std::string &get_fg_home () const { return fg_home; }
214 void set_fg_home (const std::string &home);
216 inline const string_list &get_fg_scenery () const { return fg_scenery; }
217 inline const string_list &get_secure_fg_scenery () const { return secure_fg_scenery; }
219 * Add a scenery directory
221 * secure = allow Nasal to read this directory; to avoid
222 * can-read-any-file security holes, do NOT set this on directories
223 * obtained from the property tree (e.g. /sim/terrasync/scenery-dir)
224 * or other Nasal-writable places
226 void append_fg_scenery (const std::string &scenery, bool secure = false);
228 void clear_fg_scenery();
231 * specify a path we'll prepend to the aircraft paths list if non-empty.
232 * This is used with packaged aircraft, to ensure their catalog (and hence,
233 * dependency packages) are found correctly.
235 void set_catalog_aircraft_path(const SGPath& path);
237 string_list get_aircraft_paths() const;
239 void append_aircraft_path(const std::string& path);
240 void append_aircraft_paths(const std::string& path);
243 * Given a path to an aircraft-related resource file, resolve it
244 * against the appropriate root. This means looking at the location
245 * defined by /sim/aircraft-dir, and then aircraft_path in turn,
246 * finishing with fg_root/Aircraft.
248 * if the path could not be resolved, an empty path is returned.
250 SGPath resolve_aircraft_path(const std::string& branch) const;
253 * Same as above, but test for non 'Aircraft/' branch paths, and
254 * always resolve them against fg_root.
256 SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
259 * Search in the following directories:
261 * 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
262 * 2. All aircraft directories if branch starts with Aircraft/
263 * 3. fg_data directory
265 SGPath resolve_resource_path(const std::string& branch) const;
267 inline const std::string &get_browser () const { return browser; }
268 void set_browser (const std::string &b) { browser = b; }
270 long int get_warp() const;
271 void set_warp( long int w );
273 long int get_warp_delta() const;
274 void set_warp_delta( long int d );
276 inline SGTime *get_time_params() const { return time_params; }
277 inline void set_time_params( SGTime *t ) { time_params = t; }
279 inline SGMaterialLib *get_matlib() const { return matlib; }
280 void set_matlib( SGMaterialLib *m );
282 inline SGPropertyNode *get_props () { return props; }
285 * @brief reset the property tree to new, empty tree. Ensure all
286 * subsystems are shutdown and unbound before call this.
288 void resetPropertyRoot();
290 inline FGLocale* get_locale () { return locale; }
292 inline SGCommandMgr *get_commands () { return commands; }
294 SGGeod get_aircraft_position() const;
296 SGVec3d get_aircraft_position_cart() const;
298 void get_aircraft_orientation(double& heading, double& pitch, double& roll);
300 SGGeod get_view_position() const;
302 SGVec3d get_view_position_cart() const;
304 inline string_list *get_channel_options_list () {
305 return channel_options_list;
307 inline void set_channel_options_list( string_list *l ) {
308 channel_options_list = l;
311 inline string_list *get_initial_waypoints () {
312 return initial_waypoints;
315 inline void set_initial_waypoints (string_list *list) {
316 initial_waypoints = list;
319 FGViewMgr *get_viewmgr() const;
320 FGViewer *get_current_view() const;
322 FGControls *get_controls() const;
324 FGScenery * get_scenery () const;
326 FGTileMgr * get_tile_mgr () const;
328 inline FGTACANList *get_channellist() const { return channellist; }
329 inline void set_channellist( FGTACANList *c ) { channellist = c; }
332 * Load user settings from autosave.xml
334 void loadUserSettings(const SGPath& datapath);
337 * Save user settings in autosave.xml
339 void saveUserSettings();
341 void addListenerToCleanup(SGPropertyChangeListener* l);
343 simgear::pkg::Root* packageRoot();
344 void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
348 extern FGGlobals *globals;
351 #endif // _GLOBALS_HXX