inp_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).
 *****************************************************************************/

#ifndef INP_JOYSTICK_HH
#define INP_JOYSTICK_HH 1

namespace inp {

class Global;
class InputQueue;

class Joystick
{

friend class Global;
friend class InputQueue;
public:
    CLASS_CONST int JOY_LO = 8000;  
    CLASS_CONST int JOY_HI = 32767; 

private:
    CLASS_CONST uint JOY_EVENT_ENQUEUE_LIMIT = 20;  

public:
    enum eAxis
    {
        eAxis_NONE,
        eAxis_LEFT_RIGHT,
        eAxis_UP_DOWN,
        eAxis_THIRD,
    };

public:
    enum eButton
    {
        eButton_NONE,
        eButton_1,
        eButton_2,
        eButton_3,
        eButton_4,
        eButton_LAST = eButton_4
    };

public:
    class Event
    {
    
    public:
        Event( void )
        {
            Clear();
        }

        void Clear( void )
        {
            mAxis      = Joystick::eAxis_NONE;
            mAxisVal   = 0;
            mButton    = Joystick::eButton_NONE;
            mButtonVal = 0;
        }

        bool IfValid( void ) const
        {
            // Either.
            return (mAxis != eAxis_NONE) || (mButton != eButton_NONE);
        }

    public:
        Joystick::eAxis     mAxis;          
        int                 mAxisVal;       
        Joystick::eButton   mButton;        
        bool                mButtonVal;     
    };

protected:
    // Only derivative can construct this (not even Global).
                    Joystick( void );
    virtual         ~Joystick();

// Interface for client:
public:
    virtual void    PrintStatus( void ) = 0;
    bool            Enable( bool flag = true );  
    bool            IfEnabled( void ) { return mEnabled; }
    bool            CalibrateDefault( void );
    bool            CalibrateMin( int left, int right,
                                  int up,   int down,
                                  int slow, int fast ); 
    bool            CalibrateMax( int left, int right,
                                  int up,   int down,
                                  int slow, int fast ); 
    bool            CalibrateDeadzone( const int dz[3] );
    bool            CalibrateDirection( const int d[3] );

// Interface for InputQueue:
private:
    void            PollAndEnqueueEvents( const uint limit = JOY_EVENT_ENQUEUE_LIMIT );  
protected:
    virtual bool    PollEvent( Event& event ) = 0;

// Template Method:
protected:
    virtual bool    Open( void ) = 0;
    virtual void    Close( void ) = 0;

// Private methods:
private:
    int             CheckMin( int val );
    int             CheckMax( int val );

// Data members:
protected:
    CLASS_VAR int   msInstanceCnt;  
    bool            mEnabled;       
public:
    struct Calibration
    {
        struct { int mLo; int mHi; } mLeft;
        struct { int mLo; int mHi; } mRight;
        struct { int mLo; int mHi; } mUp;
        struct { int mLo; int mHi; } mDown;
        struct { int mLo; int mHi; } mSlow;  
        struct { int mLo; int mHi; } mFast;
    };
    Calibration         mCalibration;
    TinyArray<3,int>    mAxisDir;           
};

} // namespace inp

#endif // INP_JOYSTICK_HH

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