Main/options.hxx

   1 //
   2 // options.hxx -- class to handle command line options
   3 //
   4 // Written by Curtis Olson, started April 1998.
   5 //
   6 // Copyright (C) 1998  Curtis L. Olson  - curt@me.umn.edu
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 //
  22 // $Id$
  23 // (Log is kept at end of this file)
  24
  25
  26 #ifndef _OPTIONS_HXX
  27 #define _OPTIONS_HXX
  28
  29
  30 #ifndef __cplusplus
  31 # error This library requires C++
  32 #endif
  33
  34
  35 #define FG_OPTIONS_OK 0
  36 #define FG_OPTIONS_HELP 1
  37 #define FG_OPTIONS_ERROR 2
  38
  39
  40 class fgOPTIONS {
  41
  42     // The flight gear "root" directory
  43     char fg_root[256];
  44
  45     // ID of initial starting airport
  46     char airport_id[5];
  47
  48     // Miscellaneous
  49     int splash_screen; // show splash screen
  50     int intro_music;   // play introductory music
  51     int mouse_pointer; // show mouse pointer
  52
  53     // Features
  54     int hud_status;    // HUD on/off
  55     int panel_status;  // Panel on/off
  56
  57     // Rendering options
  58     int fog;           // Fog enabled/disabled
  59     double fov;        // Field of View
  60     int fullscreen;    // Full screen mode enabled/disabled
  61     int shading;       // shading method, 0 = Flat, 1 = Smooth
  62     int skyblend;      // Blend sky to haze (using polygons) or just clear
  63     int textures;      // Textures enabled/disabled
  64     int wireframe;     // Wireframe mode enabled/disabled
  65
  66     // Scenery options
  67     int tile_radius;   // Square radius of rendered tiles (around center
  68                        // square.)
  69     int tile_diameter; // Diameter of rendered tiles.  for instance
  70                        // if tile_diameter = 3 then a 3 x 3 grid of tiles will
  71                        // be drawn.  Increase this to see terrain that is
  72                        // further away.
  73
  74     // Time options
  75     int time_offset;   // Offset true time by this many seconds
  76
  77 public:
  78
  79     // Constructor
  80     fgOPTIONS( void );
  81
  82     // Parse a single option
  83     int parse_option( char *arg );
  84
  85     // Parse the command line options
  86     int parse_command_line( int argc, char **argv );
  87
  88     // Parse the command line options
  89     int parse_config_file( char *path );
  90
  91     // Print usage message
  92     void usage ( void );
  93
  94     // Query functions
  95     void get_fg_root(char *root);
  96     void get_airport_id(char *id);
  97     int get_splash_screen( void );
  98     int get_intro_music( void );
  99     int get_mouse_pointer( void );
 100     int get_hud_status( void );
 101     int get_panel_status( void );
 102     int get_fog( void );
 103     double get_fov( void );
 104     int get_fullscreen( void );
 105     int get_shading( void );
 106     int get_skyblend( void );
 107     int get_textures( void );
 108     int get_wireframe( void );
 109     int get_tile_radius( void );
 110     int get_tile_diameter( void );
 111     int get_time_offset( void );
 112
 113     // Update functions
 114     void set_hud_status( int status );
 115     void set_fov( double amount );
 116
 117     // Destructor
 118     ~fgOPTIONS( void );
 119
 120 };
 121
 122
 123 extern fgOPTIONS current_options;
 124
 125
 126 #endif /* _OPTIONS_HXX */
 127
 128
 129 // $Log$
 130 // Revision 1.11  1998/07/13 21:01:39  curt
 131 // Wrote access functions for current fgOPTIONS.
 132 //
 133 // Revision 1.10  1998/07/06 21:34:20  curt
 134 // Added an enable/disable splash screen option.
 135 // Added an enable/disable intro music option.
 136 // Added an enable/disable instrument panel option.
 137 // Added an enable/disable mouse pointer option.
 138 // Added using namespace std for compilers that support this.
 139 //
 140 // Revision 1.9  1998/06/27 16:54:34  curt
 141 // Replaced "extern displayInstruments" with a entry in fgOPTIONS.
 142 // Don't change the view port when displaying the panel.
 143 //
 144 // Revision 1.8  1998/05/16 13:08:36  curt
 145 // C++ - ified views.[ch]xx
 146 // Shuffled some additional view parameters into the fgVIEW class.
 147 // Changed tile-radius to tile-diameter because it is a much better
 148 //   name.
 149 // Added a WORLD_TO_EYE transformation to views.cxx.  This allows us
 150 //  to transform world space to eye space for view frustum culling.
 151 //
 152 // Revision 1.7  1998/05/13 18:29:59  curt
 153 // Added a keyboard binding to dynamically adjust field of view.
 154 // Added a command line option to specify fov.
 155 // Adjusted terrain color.
 156 // Root path info moved to fgOPTIONS.
 157 // Added ability to parse options out of a config file.
 158 //
 159 // Revision 1.6  1998/05/06 03:16:26  curt
 160 // Added an averaged global frame rate counter.
 161 // Added an option to control tile radius.
 162 //
 163 // Revision 1.5  1998/05/03 00:47:32  curt
 164 // Added an option to enable/disable full-screen mode.
 165 //
 166 // Revision 1.4  1998/04/30 12:34:19  curt
 167 // Added command line rendering options:
 168 //   enable/disable fog/haze
 169 //   specify smooth/flat shading
 170 //   disable sky blending and just use a solid color
 171 //   enable wireframe drawing mode
 172 //
 173 // Revision 1.3  1998/04/28 01:20:23  curt
 174 // Type-ified fgTIME and fgVIEW.
 175 // Added a command line option to disable textures.
 176 //
 177 // Revision 1.2  1998/04/25 15:11:13  curt
 178 // Added an command line option to set starting position based on airport ID.
 179 //
 180 // Revision 1.1  1998/04/24 00:49:21  curt
 181 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 182 // Trying out some different option parsing code.
 183 // Some code reorganization.
 184 //
 185 //