1 // options.hxx -- class to handle command line options
3 // Written by Curtis Olson, started April 1998.
5 // Copyright (C) 1998 Curtis L. Olson - curt@me.umn.edu
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., 675 Mass Ave, Cambridge, MA 02139, USA.
29 # error This library requires C++
36 #include <simgear/compiler.h>
43 #include <simgear/xgl/xgl.h>
45 #if defined(FX) && defined(XMESA)
46 extern bool global_fullscreen;
49 #include <simgear/math/fg_types.hxx>
50 #include <simgear/timing/sg_time.hxx>
58 #define NEW_DEFAULT_MODEL_HZ 120
100 FG_VIEW_PILOT = 0, // Pilot perspective
101 FG_VIEW_FOLLOW = 1, // Following in the "foot steps" so to speak
102 FG_VIEW_CHASE = 2, // Chase
103 FG_VIEW_CIRCLING = 3, // Circling
104 FG_VIEW_SATELLITE = 4, // From high above
105 FG_VIEW_ANCHOR = 5, // Drop an anchor and watch from there
106 FG_VIEW_TOWER = 6, // From nearest tower?
107 FG_VIEW_SPOTTER = 7 // Fron a ground spotter
112 FG_AUTO_COORD_NOT_SPECIFIED = 0,
113 FG_AUTO_COORD_DISABLED = 1,
114 FG_AUTO_COORD_ENABLED = 2
117 enum fgTimingOffsetType {
118 FG_TIME_SYS_OFFSET = 0,
119 FG_TIME_GMT_OFFSET = 1,
120 FG_TIME_LAT_OFFSET = 2,
121 FG_TIME_SYS_ABSOLUTE = 3,
122 FG_TIME_GMT_ABSOLUTE = 4,
123 FG_TIME_LAT_ABSOLUTE = 5
128 // The flight gear "root" directory
131 // The scenery "root" directory
134 // Starting position and orientation
135 string airport_id; // ID of initial starting airport
136 double lon; // starting longitude in degrees (west = -)
137 double lat; // starting latitude in degrees (south = -)
138 double altitude; // starting altitude in meters
139 double heading; // heading (yaw) angle in degress (Psi)
140 double roll; // roll angle in degrees (Phi)
141 double pitch; // pitch angle in degrees (Theta)
142 double uBody; // Body axis X velocity (U)
143 double vBody; // Body axis Y velocity (V)
144 double wBody; // Body axis Z velocity (W)
145 double vkcas; // Calibrated airspeed, knots
146 double mach; // Mach number
149 bool game_mode; // Game mode enabled/disabled
150 bool splash_screen; // show splash screen
151 bool intro_music; // play introductory music
152 int mouse_pointer; // show mouse pointer
153 fgControlMode control_mode; // primary control mode
154 fgAutoCoordMode auto_coordination; // enable auto coordination
157 bool hud_status; // HUD on/off
158 bool panel_status; // Panel on/off
159 bool sound; // play sound effects
162 // Flight Model options
163 int flight_model; // Core flight model code: jsb, larcsim, magic, etc.
164 string aircraft; // Aircraft to model
165 int model_hz; // number of FDM iterations per second
166 int speed_up; // Sim mechanics run this much faster than normal speed
167 int trim; // use the FDM trimming routine during init
168 // <0 --notrim set, 0 no trim, >0 trim
169 // default behavior is to enable trimming for jsbsim
170 // disable for all other fdm's
173 fgFogKind fog; // Fog nicest/fastest/disabled
174 bool clouds; // Enable clouds
175 double clouds_asl; // Cloud layer height above sea level
176 double fov; // Field of View
177 bool fullscreen; // Full screen mode enabled/disabled
178 int shading; // shading method, 0 = Flat, 1 = Smooth
179 bool skyblend; // Blend sky to haze (using polygons) or just clear
180 bool textures; // Textures enabled/disabled
181 bool wireframe; // Wireframe mode enabled/disabled
182 int xsize, ysize; // window size derived from geometry string
183 int bpp; // bits per pixel
184 fgViewMode view_mode; // view mode
187 int tile_radius; // Square radius of rendered tiles (around center
189 int tile_diameter; // Diameter of rendered tiles. for instance
190 // if tile_diameter = 3 then a 3 x 3 grid of tiles will
191 // be drawn. Increase this to see terrain that is
195 int units; // feet or meters
199 int time_offset; // Use this value to change time.
200 fgTimingOffsetType time_offset_type; // Will be set to one of the
201 // FG_TIME_* enums, to deterine how
202 // time_offset should be used
204 // Serial port configuration strings
205 string_list channel_options_list;
216 // Parse a single option
217 int parse_option( const string& arg );
219 // Parse the command line options
220 int parse_command_line( int argc, char **argv );
222 // Parse the command line options
223 int parse_config_file( const string& path );
225 // Print usage message
229 inline string get_fg_root() const { return fg_root; }
230 inline string get_fg_scenery() const { return fg_scenery; }
231 inline string get_airport_id() const { return airport_id; }
232 inline double get_lon() const { return lon; }
233 inline double get_lat() const { return lat; }
234 inline double get_altitude() const { return altitude; }
235 inline double get_heading() const { return heading; }
236 inline double get_roll() const { return roll; }
237 inline double get_pitch() const { return pitch; }
238 inline double get_uBody() const {return uBody;}
239 inline double get_vBody() const {return vBody;}
240 inline double get_wBody() const {return wBody;}
241 inline double get_vc() const {return vkcas;}
242 inline double get_mach() const {return mach;}
244 inline bool get_game_mode() const { return game_mode; }
245 inline bool get_splash_screen() const { return splash_screen; }
246 inline bool get_intro_music() const { return intro_music; }
247 inline int get_mouse_pointer() const { return mouse_pointer; }
248 inline bool get_anti_alias_hud() const { return anti_alias_hud; }
249 inline fgControlMode get_control_mode() const { return control_mode; }
250 inline void set_control_mode( fgControlMode mode ) { control_mode = mode; }
251 inline fgAutoCoordMode get_auto_coordination() const {
252 return auto_coordination;
254 inline void set_auto_coordination(fgAutoCoordMode m) {
255 auto_coordination = m;
257 inline bool get_hud_status() const { return hud_status; }
258 inline bool get_panel_status() const { return panel_status; }
259 inline bool get_sound() const { return sound; }
260 inline int get_flight_model() const { return flight_model; }
261 inline string get_aircraft() const { return aircraft; }
262 inline int get_model_hz() const { return model_hz; }
263 inline int get_speed_up() const { return speed_up; }
264 inline void set_speed_up( int speed ) { speed_up = speed; }
265 inline int get_trim_mode(void) { return trim; }
267 inline bool fog_enabled() const { return fog != FG_FOG_DISABLED; }
268 inline fgFogKind get_fog() const { return fog; }
269 inline bool get_clouds() const { return clouds; }
270 inline double get_clouds_asl() const { return clouds_asl; }
271 inline double get_fov() const { return fov; }
272 inline bool get_fullscreen() const { return fullscreen; }
273 inline int get_shading() const { return shading; }
274 inline bool get_skyblend() const { return skyblend; }
275 inline bool get_textures() const { return textures; }
276 inline bool get_wireframe() const { return wireframe; }
277 inline int get_xsize() const { return xsize; }
278 inline int get_ysize() const { return ysize; }
279 inline int get_bpp() const { return bpp; }
280 inline fgViewMode get_view_mode() const { return view_mode; }
281 inline int get_tile_radius() const { return tile_radius; }
282 inline int get_tile_diameter() const { return tile_diameter; }
284 inline int get_units() const { return units; }
285 inline int get_tris_or_culled() const { return tris_or_culled; }
287 inline int get_time_offset() const { return time_offset; }
288 inline fgTimingOffsetType get_time_offset_type() const {
289 return time_offset_type;
292 inline string_list get_channel_options_list() const {
293 return channel_options_list;
296 inline bool get_network_olk() const { return network_olk; }
297 inline string get_net_id() const { return net_id; }
300 inline void set_fg_root (const string value) { fg_root = value; }
301 inline void set_fg_scenery (const string value) { fg_scenery = value; }
302 inline void set_airport_id( const string id ) { airport_id = id; }
303 inline void set_lon (double value) { lon = value; }
304 inline void set_lat (double value) { lat = value; }
305 inline void set_altitude (double value) { altitude = value; }
306 inline void set_heading (double value) { heading = value; }
307 inline void set_roll (double value) { roll = value; }
308 inline void set_pitch (double value) { pitch = value; }
309 inline void set_uBody (double value) { uBody = value; }
310 inline void set_vBody (double value) { vBody = value; }
311 inline void set_wBody (double value) { wBody = value; }
312 inline void set_vc (double value) { vkcas = value; }
313 inline void set_mach(double value) { mach = value; }
314 inline void set_game_mode (bool value) { game_mode = value; }
315 inline void set_splash_screen (bool value) { splash_screen = value; }
316 inline void set_intro_music (bool value) { intro_music = value; }
317 inline void set_mouse_pointer (int value) { mouse_pointer = value; }
318 inline void set_anti_alias_hud (bool value) { anti_alias_hud = value; }
319 inline void set_hud_status( bool status ) { hud_status = status; }
320 inline void set_sound (bool value) { sound = value; }
321 inline void set_flight_model (int value) { flight_model = value; }
322 inline void set_aircraft (const string &ac) { aircraft = ac; }
323 inline void set_model_hz (int value) { model_hz = value; }
324 inline void set_trim_mode(int value) { trim = value; }
325 inline void set_fog (fgFogKind value) { fog = value; }
326 inline void set_clouds( bool value ) { clouds = value; }
327 inline void set_clouds_asl( double value ) { clouds_asl = value; }
328 inline void set_fov( double amount ) { fov = amount; }
329 inline void set_fullscreen (bool value) { fullscreen = value; }
330 inline void set_shading (int value) { shading = value; }
331 inline void set_skyblend (bool value) { skyblend = value; }
332 inline void set_textures( bool status ) { textures = status; }
333 inline void set_wireframe (bool status) { wireframe = status; }
334 inline void cycle_fog( void ) {
335 if ( fog == FG_FOG_DISABLED ) {
336 fog = FG_FOG_FASTEST;
337 } else if ( fog == FG_FOG_FASTEST ) {
339 xglHint ( GL_FOG_HINT, GL_NICEST );
340 } else if ( fog == FG_FOG_NICEST ) {
341 fog = FG_FOG_DISABLED;
342 xglHint ( GL_FOG_HINT, GL_FASTEST );
346 inline void set_xsize( int x ) { xsize = x; }
347 inline void set_ysize( int y ) { ysize = y; }
348 inline void set_view_mode (fgViewMode value) { view_mode = value; }
349 inline void set_tile_radius (int value) { tile_radius = value; }
350 inline void set_tile_diameter (int value) { tile_diameter = value; }
351 inline void set_units (int value) { units = value; }
352 inline void set_tris_or_culled (int value) { tris_or_culled = value; }
353 inline void set_time_offset (int value) { time_offset = value; }
354 inline void set_time_offset_type (fgTimingOffsetType value) {
355 time_offset_type = value;
357 inline void cycle_view_mode() {
358 if ( view_mode == FG_VIEW_PILOT ) {
359 view_mode = FG_VIEW_FOLLOW;
360 } else if ( view_mode == FG_VIEW_FOLLOW ) {
361 view_mode = FG_VIEW_PILOT;
365 inline void set_network_olk( bool net ) { network_olk = net; }
366 inline void set_net_id( const string id ) { net_id = id; }
370 void parse_control( const string& mode );
371 double parse_time( const string& time_str );
372 long int parse_date( const string& date_str );
373 double parse_degree( const string& degree_str );
374 int parse_time_offset( const string& time_str );
375 int parse_tile_radius( const string& arg );
376 int parse_fdm( const string& fm );
377 double parse_fov( const string& arg );
378 bool parse_channel( const string& type, const string& channel_str );
382 extern fgOPTIONS current_options;
385 #endif /* _OPTIONS_HXX */