YiGamePadButton.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_GAME_PAD_BUTTON_H_
#define _YI_GAME_PAD_BUTTON_H_

#include "framework/YiPredef.h"

/*
    \brief Contains the state data for a single button on a CYIGamePad.

    \details Information is provided on the current press state of a button.
*/
class CYIGamePadButton 
{
friend class CYIGamePad;
friend class CYIGamePadPriv;
friend class CYIGamePadExtendedButtons;

public:
    enum STATE 
    {
        RELEASED,
        PRESSED,
        JUST_PRESSED,
        JUST_RELEASED
    };

    /*
        \details Returns true if the button is currently pressed.
    */
    bool  IsPressed() const;

    /*
        \details Returns the current state of the button.
    */
    STATE    GetState() const;

private:
    const static int32_t REPEAT_THRESHOLD;
    const static int32_t REPEAT_INITIAL_VALUE;

    CYIGamePadButton();

    void Update(bool isPressed, bool bIsAutoRepeat = false);

    STATE m_state;
    int32_t m_nRepeatValue;
};

#endif // _YI_GAME_PAD_BUTTON_H_