Controls/controls.hxx

   1 // controls.hxx -- defines a standard interface to all flight sim controls
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23
  24
  25 #ifndef _CONTROLS_HXX
  26 #define _CONTROLS_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33
  34 // Define a structure containing the control parameters
  35
  36 class FGControls {
  37
  38 public:
  39
  40     static const int ALL_ENGINES = -1;
  41     static const int MAX_ENGINES = 10;
  42
  43     static const int ALL_WHEELS = -1;
  44     static const int MAX_WHEELS = 3;
  45
  46 private:
  47
  48     double aileron;
  49     double elevator;
  50     double elevator_trim;
  51     double rudder;
  52     double throttle[MAX_ENGINES];
  53     double brake[MAX_WHEELS];
  54
  55 public:
  56
  57     FGControls();
  58     ~FGControls();
  59
  60     // Query functions
  61     inline double get_aileron() const { return aileron; }
  62     inline double get_elevator() const { return elevator; }
  63     inline double get_elevator_trim() const { return elevator_trim; }
  64     inline double get_rudder() const { return rudder; }
  65     inline double get_throttle(int engine) const { return throttle[engine]; }
  66     inline double get_brake(int wheel) const { return brake[wheel]; }
  67
  68     // Update functions
  69     inline void set_aileron( double pos ) {
  70         aileron = pos;
  71         if ( aileron < -1.0 ) aileron = -1.0;
  72         if ( aileron >  1.0 ) aileron =  1.0;
  73     }
  74     inline void move_aileron( double amt ) {
  75         aileron += amt;
  76         if ( aileron < -1.0 ) aileron = -1.0;
  77         if ( aileron >  1.0 ) aileron =  1.0;
  78     }
  79     inline void set_elevator( double pos ) {
  80         elevator = pos;
  81         if ( elevator < -1.0 ) elevator = -1.0;
  82         if ( elevator >  1.0 ) elevator =  1.0;
  83     }
  84     inline void move_elevator( double amt ) {
  85         elevator += amt;
  86         if ( elevator < -1.0 ) elevator = -1.0;
  87         if ( elevator >  1.0 ) elevator =  1.0;
  88     }
  89     inline void set_elevator_trim( double pos ) {
  90         elevator_trim = pos;
  91         if ( elevator_trim < -1.0 ) elevator_trim = -1.0;
  92         if ( elevator_trim >  1.0 ) elevator_trim =  1.0;
  93     }
  94     inline void move_elevator_trim( double amt ) {
  95         elevator_trim += amt;
  96         if ( elevator_trim < -1.0 ) elevator_trim = -1.0;
  97         if ( elevator_trim >  1.0 ) elevator_trim =  1.0;
  98     }
  99     inline void set_rudder( double pos ) {
 100         rudder = pos;
 101         if ( rudder < -1.0 ) rudder = -1.0;
 102         if ( rudder >  1.0 ) rudder =  1.0;
 103     }
 104     inline void move_rudder( double amt ) {
 105         rudder += amt;
 106         if ( rudder < -1.0 ) rudder = -1.0;
 107         if ( rudder >  1.0 ) rudder =  1.0;
 108     }
 109     inline void set_throttle( int engine, double pos ) {
 110         if ( engine == ALL_ENGINES ) {
 111             for ( int i = 0; i < MAX_ENGINES; i++ ) {
 112                 throttle[i] = pos;
 113                 if ( throttle[i] < 0.0 ) throttle[i] = 0.0;
 114                 if ( throttle[i] >  1.0 ) throttle[i] =  1.0;
 115             }
 116         } else {
 117             if ( (engine >= 0) && (engine < MAX_ENGINES) ) {
 118                 throttle[engine] = pos;
 119                 if ( throttle[engine] < 0.0 ) throttle[engine] = 0.0;
 120                 if ( throttle[engine] >  1.0 ) throttle[engine] =  1.0;
 121             }
 122         }
 123     }
 124     inline void move_throttle( int engine, double amt ) {
 125         if ( engine == ALL_ENGINES ) {
 126             for ( int i = 0; i < MAX_ENGINES; i++ ) {
 127                 throttle[i] += amt;
 128                 if ( throttle[i] < 0.0 ) throttle[i] = 0.0;
 129                 if ( throttle[i] >  1.0 ) throttle[i] =  1.0;
 130             }
 131         } else {
 132             if ( (engine >= 0) && (engine < MAX_ENGINES) ) {
 133                 throttle[engine] += amt;
 134                 if ( throttle[engine] < 0.0 ) throttle[engine] = 0.0;
 135                 if ( throttle[engine] >  1.0 ) throttle[engine] =  1.0;
 136             }
 137         }
 138     }
 139     inline void set_brake( int wheel, double pos ) {
 140         if ( wheel == ALL_WHEELS ) {
 141             for ( int i = 0; i < MAX_WHEELS; i++ ) {
 142                 brake[i] = pos;
 143                 if ( brake[i] < 0.0 ) brake[i] = 0.0;
 144                 if ( brake[i] >  1.0 ) brake[i] =  1.0;
 145             }
 146         } else {
 147             if ( (wheel >= 0) && (wheel < MAX_WHEELS) ) {
 148                 brake[wheel] = pos;
 149                 if ( brake[wheel] < 0.0 ) brake[wheel] = 0.0;
 150                 if ( brake[wheel] >  1.0 ) brake[wheel] =  1.0;
 151             }
 152         }
 153     }
 154     inline void move_brake( int wheel, double amt ) {
 155         if ( wheel == ALL_WHEELS ) {
 156             for ( int i = 0; i < MAX_WHEELS; i++ ) {
 157                 brake[i] += amt;
 158                 if ( brake[i] < 0.0 ) brake[i] = 0.0;
 159                 if ( brake[i] >  1.0 ) brake[i] =  1.0;
 160             }
 161         } else {
 162             if ( (wheel >= 0) && (wheel < MAX_WHEELS) ) {
 163                 brake[wheel] += amt;
 164                 if ( brake[wheel] < 0.0 ) brake[wheel] = 0.0;
 165                 if ( brake[wheel] >  1.0 ) brake[wheel] =  1.0;
 166             }
 167         }
 168     }
 169 };
 170
 171
 172 extern FGControls controls;
 173
 174
 175 #endif // _CONTROLS_HXX
 176
 177
 178 // $Log$
 179 // Revision 1.3  1998/12/05 16:13:13  curt
 180 // Renamed class fgCONTROLS to class FGControls.
 181 //
 182 // Revision 1.2  1998/10/25 14:08:42  curt
 183 // Turned "struct fgCONTROLS" into a class, with inlined accessor functions.
 184 //
 185 // Revision 1.1  1998/10/18 01:51:07  curt
 186 // c++-ifying ...
 187 //
 188 // Revision 1.17  1998/09/29 14:57:00  curt
 189 // c++-ified some comments.
 190 //
 191 // Revision 1.16  1998/09/29 02:01:32  curt
 192 // Added a brake.
 193 //
 194 // Revision 1.15  1998/04/25 22:06:27  curt
 195 // Edited cvs log messages in source files ... bad bad bad!
 196 //
 197 // Revision 1.14  1998/04/22 13:26:19  curt
 198 // C++ - ifing the code a bit.
 199 //
 200 // Revision 1.13  1998/04/21 17:02:35  curt
 201 // Prepairing for C++ integration.
 202 //
 203 // Revision 1.12  1998/02/09 22:56:48  curt
 204 // Removed "depend" files from cvs control.  Other minor make tweaks.
 205 //
 206 // Revision 1.11  1998/02/07 15:29:36  curt
 207 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 208 // <chotchkiss@namg.us.anritsu.com>
 209 //
 210 // Revision 1.10  1998/01/27 00:47:52  curt
 211 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 212 // system and commandline/config file processing code.
 213 //
 214 // Revision 1.9  1998/01/22 02:59:31  curt
 215 // Changed #ifdef FILE_H to #ifdef _FILE_H
 216 //
 217 // Revision 1.8  1998/01/19 18:40:22  curt
 218 // Tons of little changes to clean up the code and to remove fatal errors
 219 // when building with the c++ compiler.
 220 //
 221 // Revision 1.7  1997/12/15 23:54:36  curt
 222 // Add xgl wrappers for debugging.
 223 // Generate terrain normals on the fly.
 224 //
 225 // Revision 1.6  1997/12/10 22:37:41  curt
 226 // Prepended "fg" on the name of all global structures that didn't have it yet.
 227 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 228 //
 229 // Revision 1.5  1997/08/27 03:30:02  curt
 230 // Changed naming scheme of basic shared structures.
 231 //
 232 // Revision 1.4  1997/07/23 21:52:18  curt
 233 // Put comments around the text after an #endif for increased portability.
 234 //
 235 // Revision 1.3  1997/05/31 19:16:27  curt
 236 // Elevator trim added.
 237 //
 238 // Revision 1.2  1997/05/23 15:40:33  curt
 239 // Added GNU copyright headers.
 240 //
 241 // Revision 1.1  1997/05/16 15:59:48  curt
 242 // Initial revision.
 243 //