mod_base_joystick.hh

Go to the documentation of this file.

/*
 * LEGAL:   COPYRIGHT (C) 2004 JIM E. BROOKS
 *          THIS SOURCE CODE IS RELEASED UNDER THE TERMS
 *          OF THE GNU GENERAL PUBLIC LICENSE VERSION 2 (GPL 2).
 *****************************************************************************/

#if COMPILING_MODULE
#ifndef MOD_BASE_JOYSTICK_HH
#define MOD_BASE_JOYSTICK_HH 1

#include "inp_joystick.hh"
using namespace inp;

namespace mod_base {

class Joystick
{

public:
    enum eMove
    {
        eMove_AT_CENTER,
        eMove_PITCH_UP,
        eMove_PITCH_DOWN,
        eMove_ROLL_LEFT,
        eMove_ROLL_RIGHT,
        eMove_YAW_LEFT,
        eMove_YAW_RIGHT,
        eMove_THROTTLE_SLOW,
        eMove_THROTTLE_FAST
    };

public:
    enum eAxis3
    {
        eAxis3_DISABLED,
        eAxis3_THROTTLE,
        eAxis3_RUDDER
    };

public:
    class Values
    {
    
    public:
        Values( void )
        {
            Reset();
        }

        void Reset( void )
        {
            mUp = mDown = mLeft = mRight = mSlow = mFast = INVALID;
        }

    public:
        enum    { INVALID = -99999 };
        int     mUp;
        int     mDown;
        int     mLeft;
        int     mRight;
        int     mSlow;  // axis3
        int     mFast;  // axis3
    };

private:
    class TimerFunctor : public Timer::Functor
    {
    public:
                TimerFunctor( mod_base::Joystick& joystick ) : mJoystick(joystick) { }
        void    operator()( const Milliseconds millisecElapsed );
        mod_base::Joystick&  mJoystick;
    };
    friend class TimerFunctor;

public:
                    Joystick( void );
                    ~Joystick();
    void            Init( void );
    bool            IfEnabled( void );
    bool            Enable( bool enable = true );
    bool            Poll( void );
    TinyArray<3,Degree> GetResponse( void );
    Percent         GetResponsePercent( void );
    void            AdjustResponse( const Percent percent );
    void            SetResponse( Degree r0, Degree r1, Degree r2 );
    void            SetResponseForEye( void );
    void            SetResponseForCraft( void );
    bool            SetAxis3( eAxis3 a );
    eAxis3          GetAxis3( void );
    void            EnableAutofire( bool f );
    void            EnablePrint( bool f );
    bool            IfPrint( void );
    void            PrintRaw( int value, eMove move );
    void            RecordRaw( int value, eMove move );
    bool            IfCalibrationMode( void );
    void            SetCalibrationMode( bool f );
    const Values&   GetValues( void ) { return mValues; }       // used for calibration
    void            ResetValues( void ) { mValues.Reset(); }    // used for calibration

private:
    void            EnableInitial( void );
    void            EnableSubsequent( bool enable );
    bool            IfBeyondCenter( int lo );
    fp              PositionAbs( int high );

private:
    CLASS_VAR int           msInstanceCnt;

    // Joystick state.
    bool                    mEnableInitial;     
    inp::Joystick::Event    mEvent;             
    eAxis3                  mAxis3;
    bool                    mAutofire;

    // Joystick calibration.
    bool                    mCalibrating;
    Values                  mValues;
    bool                    mPrint;

    // Rate of rotation in degrees.
    // mResponse = mResponsePotential * mResponsePercent
    TinyArray<3,Degree>     mResponsePotential;     
    TinyArray<3,Degree>     mResponse;              
    Percent                 mResponsePercent;       
};

} // namespace mod_base

#endif // MOD_BASE_JOYSTICK_HH
#endif // COMPILING_MOD

Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:12 2007