C:/Active/libraries/cxutils/2.0/include/cxutils/joystick.h

Go to the documentation of this file.

#ifndef __CX_JOYSTICK_H
#define __CX_JOYSTICK_H

#ifdef WIN32
#pragma warning(disable : 4251) // Disables an annoying template DLL warning.
#endif

#include <limits.h>
#include <vector>
#include <string>

#include "thread.h"
#include "mutex.h"
#include "timer.h"
#include "cxutils/math/cxmath.h"

namespace CxUtils
{
    class CX_UTILS_DLL Joystick
    {
    public:
        static const short int MinAxisValue        = -32767;     
        static const short int MaxAxisValue        =  32767;     
        static const short int MaxAxis             =  9;         
        static const unsigned int MaxButtons       = 32;         
        static const unsigned short int PovOff     = 65535;      
        static const unsigned int AnyJoystick      = UINT_MAX;   






        enum Axes
        {
            X = 0,
            Y,
            Z,
            R,
            U,
            V,
            POV,
            PovX,
            PovY
        };
        enum Event
        {
            None = 0,
            ButtonDown,
            ButtonUp
        };
        class CX_UTILS_DLL Callback
        {
        public:
            class CX_UTILS_DLL Data
            {
            public:    
                typedef std::vector<Data> List;
                Data() : mpJoyCallback(0), mpJoyFunc(0), mpJoyButtonFunc(0), mpJoyFuncArgs(0)
                {
                }
                Data(const Data& data) : mpJoyCallback(0), mpJoyFunc(0), mpJoyFuncArgs(0)
                {
                    *this = data;
                }
                ~Data() {}
                Data& operator=(const Data& data)
                {
                    mpJoyCallback = data.mpJoyCallback;
                    mpJoyFunc = data.mpJoyFunc;
                    mpJoyButtonFunc = data.mpJoyButtonFunc;
                    mpJoyFuncArgs = data.mpJoyFuncArgs;
                    return *this;
                }
                Joystick::Callback* mpJoyCallback;
                void (*mpJoyFunc)(const Joystick& jstick, void* args);
                void (*mpJoyButtonFunc)(const unsigned int buttonNumber, const Joystick::Event type, void* args);
                void *mpJoyFuncArgs;
            };
            virtual void ProcessJoystickEvent(const Joystick& jstick) = 0;
            virtual void ProcessButtonEvent(const unsigned int buttonNumber, const Joystick::Event type) {}
        };
        Joystick();
        ~Joystick();
        int Initialize(const unsigned int num = AnyJoystick, 
                       const unsigned int freq = 25,
                       const std::string& calibrationFile = std::string());
        int Shutdown();
        int GetAxis(const short int axis) const;
        int GetPOV() const;
        int GetButtonNumber() const;
        int GetID() const { return mID; }
        int RegisterCallback(Joystick::Callback* cb);
        int RegisterCallback(void (*func)(const Joystick& jstick, void* args), void* args);
        int RegisterCallback(void (*func)(const unsigned int buttonNumber, const Joystick::Event type, void* args), 
                             void* args);
        void ClearCallbacks();
        void PrintJoystickInfo() const;
        bool IsButtonPressed(const unsigned int num = 0) const;
        bool IsConnected() const;
        static short int GetAxisFromLetter(const char ch);
        static char GetLetterFromAxis(const short int axis);
        double GetAxisPercentage(const short int axis, const short int deadzone = 0) const;
        unsigned int GetUpdateFrequencey() const { return mUpdateFrequency; }
    protected:        
        static void JoystickThreadFunction(void* args);
#ifndef WIN32
        static void CallbackThreadFunction(void* args);
        Thread mCallbackThread;
#endif
        Mutex mJoystickMutex;               
        Mutex mJoyCallbackMutex;            
        Thread mJoystickThread;             
        Callback::Data::List mCallbacks;    
        int mID;                            
        int mButtons;                       
        int *mpAxis;                        
        unsigned int mUpdateFrequency;      
        bool mJoystickConnected;            
        void* mpJoyInterface;               
    };

    typedef Joystick::Callback JoystickCallback; // Backwards compatibility with previous version of CxUtils.
}

#endif

/*  End of File */