src/FDM/YASim/ControlMap.hpp

   1 #ifndef _CONTROL_MAP_HPP
   2 #define _CONTROL_MAP_HPP
   3
   4 #include "Vector.hpp"
   5
   6 namespace yasim {
   7
   8 class ControlMap {
   9 public:
  10     ~ControlMap();
  11
  12     enum OutputType { THROTTLE, MIXTURE, STARTER, MAGNETOS,
  13                       ADVANCE, REHEAT, PROP,
  14                       BRAKE, STEER, EXTEND,
  15                       INCIDENCE, FLAP0, FLAP1, SLAT, SPOILER, VECTOR,
  16                       BOOST, CASTERING, PROPPITCH,
  17                       COLLECTIVE, CYCLICAIL, CYCLICELE, ROTORENGINEON,
  18                       REVERSE_THRUST };
  19
  20     enum { OPT_SPLIT  = 0x01,
  21            OPT_INVERT = 0x02,
  22            OPT_SQUARE = 0x04 };
  23
  24     // Returns a new, not-yet-used "input handle" for addMapping and
  25     // setInput.  This typically corresponds to one user axis.
  26     int newInput();
  27
  28     // Adds a mapping to between input handle and a particular setting
  29     // on an output object.  The value of output MUST match the type
  30     // of object!
  31     void addMapping(int input, int output, void* object, int options=0);
  32
  33     // An additional form to specify a mapping range.  Input values
  34     // outside of [src0:src1] are clamped, and are then mapped to
  35     // [dst0:dst1] before being set on the object.
  36     void addMapping(int input, int output, void* object, int options,
  37                     float src0, float src1, float dst0, float dst1);
  38
  39     // Resets our accumulated input values.  Call before any
  40     // setInput() invokations.
  41     void reset();
  42
  43     // Sets the specified input (as returned by newInput) to the
  44     // specified value.
  45     void setInput(int input, float value);
  46
  47     // Calculates and applies the settings received since the last reset().
  48     void applyControls(float dt);
  49
  50     // Returns the input/output range appropriate for the given
  51     // control.  Ailerons go from -1 to 1, while throttles are never
  52     // lower than zero, etc...
  53     static float rangeMin(int type);
  54     static float rangeMax(int type);
  55
  56     // Each output record is identified by both an object/type tuple
  57     // and a numeric handle.
  58     int getOutputHandle(void* obj, int type);
  59
  60     // Sets the transition time for the control output to swing
  61     // through its full range.
  62     void setTransitionTime(int handle, float time);
  63
  64     // Retrieves the current value of the control output.  Controls
  65     // with OPT_SPLIT settable on inputs will have a separately
  66     // computed "right side" value.
  67     float getOutput(int handle);
  68     float getOutputR(int handle);
  69
  70 private:
  71     struct OutRec { int type; void* object; Vector maps;
  72                     float oldL, oldR, time; };
  73     struct MapRec  { OutRec* out; int idx; int opt; float val;
  74                      float src0; float src1; float dst0; float dst1; };
  75
  76     // A list of (sub)Vectors containing a bunch of MapRec objects for
  77     // each input handle.
  78     Vector _inputs;
  79
  80     // An unordered list of output settings.
  81     Vector _outputs;
  82 };
  83
  84 }; // namespace yasim
  85 #endif // _CONTROL_MAP_HPP