Joystick.h

Go to the documentation of this file.

/*********************************************************\
 *  File: Joystick.h                                     *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLINPUT_JOYSTICK_H__
#define __PLINPUT_JOYSTICK_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/Base/Event/EventHandler.h>
#include "PLInput/Input/Devices/Device.h"
#include "PLInput/Input/Controls/Axis.h"
#include "PLInput/Input/Controls/Button.h"
#include "PLInput/Input/Controls/Effect.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLInput {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class HIDDevice;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Joystick input device
*
*  @remarks
*    This class supports the following device backend types:
*    - UpdateDevice
*    - HIDDevice
*/
class Joystick : public Device {


    //[-------------------------------------------------------]
    //[ Class definition                                      ]
    //[-------------------------------------------------------]
    pl_class(PLINPUT_RTTI_EXPORT, Joystick, "PLInput", PLInput::Device, "Joystick input controller")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Controller definition                                 ]
    //[-------------------------------------------------------]
    public:
        // Input
        Axis    X;          /**< X axis */
        Axis    Y;          /**< Y axis */
        Axis    Z;          /**< Z axis */
        Axis    RX;         /**< Rotation X axis */
        Axis    RY;         /**< Rotation Y axis */
        Axis    RZ;         /**< Rotation Z axis */
        Axis    Hat;        /**< Hat axis */
        Button  Button0;    /**< Button #0 */
        Button  Button1;    /**< Button #1 */
        Button  Button2;    /**< Button #2 */
        Button  Button3;    /**< Button #3 */
        Button  Button4;    /**< Button #4 */
        Button  Button5;    /**< Button #5 */
        Button  Button6;    /**< Button #6 */
        Button  Button7;    /**< Button #7 */
        Button  Button8;    /**< Button #8 */
        Button  Button9;    /**< Button #9 */
        Button  Button10;   /**< Button #10 */
        Button  Button11;   /**< Button #11 */
        Button  Button12;   /**< Button #12 */
        Button  Button13;   /**< Button #13 */
        Button  Button14;   /**< Button #14 */
        Button  Button15;   /**< Button #15 */
        Button  Button16;   /**< Button #16 */
        Button  Button17;   /**< Button #17 */
        Button  Button18;   /**< Button #18 */
        Button  Button19;   /**< Button #19 */
        Button  Button20;   /**< Button #20 */
        Button  Button21;   /**< Button #21 */
        Button  Button22;   /**< Button #22 */
        Button  Button23;   /**< Button #23 */
        Button  Button24;   /**< Button #24 */
        Button  Button25;   /**< Button #25 */
        Button  Button26;   /**< Button #26 */
        Button  Button27;   /**< Button #27 */
        Button  Button28;   /**< Button #28 */
        Button  Button29;   /**< Button #29 */
        Button  Button30;   /**< Button #30 */
        Button  Button31;   /**< Button #31 */

        // Effects
        Effect  Rumble1;    /**< Rumble effect (motor #1) */
        Effect  Rumble2;    /**< Rumble effect (motor #2) */
        Effect  Rumble3;    /**< Rumble effect (motor #3) */
        Effect  Rumble4;    /**< Rumble effect (motor #4) */


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] sName
        *    Device name
        *  @param[in] pImpl
        *    System specific device implementation, can, but shouldn't be a null pointer
        */
        PLINPUT_API Joystick(const PLCore::String &sName, DeviceImpl *pImpl);

        /**
        *  @brief
        *    Destructor
        */
        PLINPUT_API virtual ~Joystick();

        /**
        *  @brief
        *    Get threshold
        *
        *  @return
        *    Threshold
        */
        PLINPUT_API int GetThreshold() const;

        /**
        *  @brief
        *    Set threshold
        *
        *  @param[in] nThreshold
        *    Threshold
        */
        PLINPUT_API void SetThreshold(int nThreshold = 12000);


    //[-------------------------------------------------------]
    //[ Public virtual Controller functions                   ]
    //[-------------------------------------------------------]
    public:
        PLINPUT_API virtual void Update() override;
        PLINPUT_API virtual void UpdateOutputControl(Control *pControl) override;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Parse HID input report
        */
        void ParseInputReport();

        /**
        *  @brief
        *    Called when the HID device has read some data
        */
        void OnDeviceRead();


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        // Event handlers
        PLCore::EventHandler<> EventHandlerOnDeviceRead;

        // HID connection
        HIDDevice *m_pHIDDevice;    /**< HID device, can be a null pointer */

        // Configuration
        int m_nThreshold;           /**< Movement threshold */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLInput


#endif // __PLINPUT_JOYSTICK_H__