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/sg_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
135 // The flight gear "root" directory
138 // The scenery "root" directory
141 // Starting position and orientation
142 string airport_id; // ID of initial starting airport
143 double lon; // starting longitude in degrees (west = -)
144 double lat; // starting latitude in degrees (south = -)
145 double altitude; // starting altitude in meters
146 double heading; // heading (yaw) angle in degress (Psi)
147 double roll; // roll angle in degrees (Phi)
148 double pitch; // pitch angle in degrees (Theta)
149 fgSpeedSet speedset; // which speed does the user want
150 double uBody; // Body axis X velocity (U)
151 double vBody; // Body axis Y velocity (V)
152 double wBody; // Body axis Z velocity (W)
153 double vNorth; // North component of vt
154 double vEast; // East component of vt
155 double vDown; // Down component of vt
156 double vkcas; // Calibrated airspeed, knots
157 double mach; // Mach number
160 bool game_mode; // Game mode enabled/disabled
161 bool splash_screen; // show splash screen
162 bool intro_music; // play introductory music
163 int mouse_pointer; // show mouse pointer
164 fgControlMode control_mode; // primary control mode
165 fgAutoCoordMode auto_coordination; // enable auto coordination
168 bool hud_status; // HUD on/off
169 bool panel_status; // Panel on/off
170 bool sound; // play sound effects
173 // Flight Model options
174 int flight_model; // Core flight model code: jsb, larcsim, magic, etc.
175 string aircraft; // Aircraft to model
176 int model_hz; // number of FDM iterations per second
177 int speed_up; // Sim mechanics run this much faster than normal speed
178 int trim; // use the FDM trimming routine during init
179 // <0 --notrim set, 0 no trim, >0 trim
180 // default behavior is to enable trimming for jsbsim
181 // disable for all other fdm's
184 fgFogKind fog; // Fog nicest/fastest/disabled
185 bool clouds; // Enable clouds
186 double clouds_asl; // Cloud layer height above sea level
187 double fov; // Field of View
188 bool fullscreen; // Full screen mode enabled/disabled
189 int shading; // shading method, 0 = Flat, 1 = Smooth
190 bool skyblend; // Blend sky to haze (using polygons) or just clear
191 bool textures; // Textures enabled/disabled
192 bool wireframe; // Wireframe mode enabled/disabled
193 int xsize, ysize; // window size derived from geometry string
194 double win_ratio; // ratio of x and y fov's; fov(y) = fov(x) * win_ratio
195 int bpp; // bits per pixel
196 fgViewMode view_mode; // view mode
197 double default_view_offset; // default forward view offset (for use by
198 // multi-display configuration
201 int tile_radius; // Square radius of rendered tiles (around center
203 int tile_diameter; // Diameter of rendered tiles. for instance
204 // if tile_diameter = 3 then a 3 x 3 grid of tiles will
205 // be drawn. Increase this to see terrain that is
209 int units; // feet or meters
213 int time_offset; // Use this value to change time.
214 fgTimingOffsetType time_offset_type; // Will be set to one of the
215 // FG_TIME_* enums, to deterine how
216 // time_offset should be used
218 // Serial port configuration strings
219 string_list channel_options_list;
230 // Parse a single option
231 int parse_option( const string& arg );
233 // Scan the command line options for an fg_root definition and set
235 int scan_command_line_for_root( int argc, char **argv );
237 // Scan the config file for an fg_root definition and set just
239 int scan_config_file_for_root( const string& path );
241 // Parse the command line options
242 int parse_command_line( int argc, char **argv );
244 // Parse the command line options
245 int parse_config_file( const string& path );
247 // Print usage message
251 inline string get_fg_root() const { return fg_root; }
252 inline string get_fg_scenery() const { return fg_scenery; }
253 inline string get_airport_id() const { return airport_id; }
254 inline double get_lon() const { return lon; }
255 inline double get_lat() const { return lat; }
256 inline double get_altitude() const { return altitude; }
257 inline double get_heading() const { return heading; }
258 inline double get_roll() const { return roll; }
259 inline double get_pitch() const { return pitch; }
260 inline fgSpeedSet get_speedset() const { return speedset; }
261 inline double get_uBody() const {return uBody;}
262 inline double get_vBody() const {return vBody;}
263 inline double get_wBody() const {return wBody;}
264 inline double get_vNorth() const {return vNorth;}
265 inline double get_vEast() const {return vEast;}
266 inline double get_vDown() const {return vDown;}
267 inline double get_vc() const {return vkcas;}
268 inline double get_mach() const {return mach;}
270 inline bool get_game_mode() const { return game_mode; }
271 inline bool get_splash_screen() const { return splash_screen; }
272 inline bool get_intro_music() const { return intro_music; }
273 inline int get_mouse_pointer() const { return mouse_pointer; }
274 inline bool get_anti_alias_hud() const { return anti_alias_hud; }
275 inline fgControlMode get_control_mode() const { return control_mode; }
276 inline void set_control_mode( fgControlMode mode ) { control_mode = mode; }
277 inline fgAutoCoordMode get_auto_coordination() const {
278 return auto_coordination;
280 inline void set_auto_coordination(fgAutoCoordMode m) {
281 auto_coordination = m;
283 inline bool get_hud_status() const { return hud_status; }
284 inline bool get_panel_status() const { return panel_status; }
285 inline bool get_sound() const { return sound; }
286 inline int get_flight_model() const { return flight_model; }
287 inline string get_aircraft() const { return aircraft; }
288 inline int get_model_hz() const { return model_hz; }
289 inline int get_speed_up() const { return speed_up; }
290 inline void set_speed_up( int speed ) { speed_up = speed; }
291 inline int get_trim_mode(void) { return trim; }
293 inline bool fog_enabled() const { return fog != FG_FOG_DISABLED; }
294 inline fgFogKind get_fog() const { return fog; }
295 inline bool get_clouds() const { return clouds; }
296 inline double get_clouds_asl() const { return clouds_asl; }
297 inline double get_fov() const { return fov; }
298 inline bool get_fullscreen() const { return fullscreen; }
299 inline int get_shading() const { return shading; }
300 inline bool get_skyblend() const { return skyblend; }
301 inline bool get_textures() const { return textures; }
302 inline bool get_wireframe() const { return wireframe; }
303 inline int get_xsize() const { return xsize; }
304 inline int get_ysize() const { return ysize; }
305 inline double get_win_ratio() const { return win_ratio; }
306 inline int get_bpp() const { return bpp; }
307 inline fgViewMode get_view_mode() const { return view_mode; }
308 inline double get_default_view_offset() const {
309 return default_view_offset;
313 inline int get_tile_radius() const { return tile_radius; }
314 inline int get_tile_diameter() const { return tile_diameter; }
316 inline int get_units() const { return units; }
317 inline int get_tris_or_culled() const { return tris_or_culled; }
319 inline int get_time_offset() const { return time_offset; }
320 inline fgTimingOffsetType get_time_offset_type() const {
321 return time_offset_type;
324 inline string_list get_channel_options_list() const {
325 return channel_options_list;
328 inline bool get_network_olk() const { return network_olk; }
329 inline string get_net_id() const { return net_id; }
332 inline void set_fg_root (const string value) { fg_root = value; }
333 inline void set_fg_scenery (const string value) { fg_scenery = value; }
334 inline void set_airport_id( const string id ) { airport_id = id; }
335 inline void set_lon (double value) { lon = value; }
336 inline void set_lat (double value) { lat = value; }
337 inline void set_altitude (double value) { altitude = value; }
338 inline void set_heading (double value) { heading = value; }
339 inline void set_roll (double value) { roll = value; }
340 inline void set_pitch (double value) { pitch = value; }
341 inline void set_uBody (double value) { uBody = value; }
342 inline void set_vBody (double value) { vBody = value; }
343 inline void set_wBody (double value) { wBody = value; }
344 inline void set_vc (double value) { vkcas = value; }
345 inline void set_mach(double value) { mach = value; }
346 inline void set_game_mode (bool value) { game_mode = value; }
347 inline void set_splash_screen (bool value) { splash_screen = value; }
348 inline void set_intro_music (bool value) { intro_music = value; }
349 inline void set_mouse_pointer (int value) { mouse_pointer = value; }
350 inline void set_anti_alias_hud (bool value) { anti_alias_hud = value; }
351 inline void set_hud_status( bool status ) { hud_status = status; }
352 inline void set_sound (bool value) { sound = value; }
353 inline void set_flight_model (int value) { flight_model = value; }
354 inline void set_aircraft (const string &ac) { aircraft = ac; }
355 inline void set_model_hz (int value) { model_hz = value; }
356 inline void set_trim_mode(int value) { trim = value; }
357 inline void set_fog (fgFogKind value) { fog = value; }
358 inline void set_clouds( bool value ) { clouds = value; }
359 inline void set_clouds_asl( double value ) { clouds_asl = value; }
360 inline void set_fov( double amount ) { fov = amount; }
361 inline void set_fullscreen (bool value) { fullscreen = value; }
362 inline void set_shading (int value) { shading = value; }
363 inline void set_skyblend (bool value) { skyblend = value; }
364 inline void set_textures( bool status ) { textures = status; }
365 inline void set_wireframe (bool status) { wireframe = status; }
366 inline void cycle_fog( void ) {
367 if ( fog == FG_FOG_DISABLED ) {
368 fog = FG_FOG_FASTEST;
369 } else if ( fog == FG_FOG_FASTEST ) {
371 xglHint ( GL_FOG_HINT, GL_NICEST );
372 } else if ( fog == FG_FOG_NICEST ) {
373 fog = FG_FOG_DISABLED;
374 xglHint ( GL_FOG_HINT, GL_FASTEST );
378 inline void set_xsize( int x ) { xsize = x; }
379 inline void set_ysize( int y ) { ysize = y; }
380 inline void set_win_ratio( double r ) { win_ratio = r; }
381 inline void set_view_mode (fgViewMode value) { view_mode = value; }
382 inline void set_tile_radius (int value) { tile_radius = value; }
383 inline void set_tile_diameter (int value) { tile_diameter = value; }
384 inline void set_units (int value) { units = value; }
385 inline void set_tris_or_culled (int value) { tris_or_culled = value; }
386 inline void set_time_offset (int value) { time_offset = value; }
387 inline void set_time_offset_type (fgTimingOffsetType value) {
388 time_offset_type = value;
390 inline void cycle_view_mode() {
391 if ( view_mode == FG_VIEW_PILOT ) {
392 view_mode = FG_VIEW_FOLLOW;
393 } else if ( view_mode == FG_VIEW_FOLLOW ) {
394 view_mode = FG_VIEW_PILOT;
398 inline void set_network_olk( bool net ) { network_olk = net; }
399 inline void set_net_id( const string id ) { net_id = id; }
403 void parse_control( const string& mode );
404 double parse_time( const string& time_str );
405 long int parse_date( const string& date_str );
406 double parse_degree( const string& degree_str );
407 int parse_time_offset( const string& time_str );
408 int parse_tile_radius( const string& arg );
409 int parse_fdm( const string& fm );
410 double parse_fov( const string& arg );
411 bool parse_channel( const string& type, const string& channel_str );
412 bool parse_wp( const string& arg );
416 // extern FGOptions current_options;
419 #endif /* _OPTIONS_HXX */