YiGamePad.h

Go to the documentation of this file.

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

#include "YiGamePadButton.h"
#include "YiGamePadExtendedButtons.h"

#include <glm/vec2.hpp>

/*
    \brief Contains state data about all buttons and axis on a standard gamepad.

    \details This class represents a standard gamepad. It contains the current state information for the buttons and axis on the gamepad.

    \sa CYIGamePadButton
*/
class CYIGamePad
{
friend class CYIGamePadPriv;

public:
    /*
        \details Returns the current gamepad instance.
    */
    static const CYIGamePad    &GetUserGamePad();

    /*
        \details Returns a button representing the state of the left directional pad button of the gamepad.
    */
    const CYIGamePadButton     &GetDPadLeftButton() const;

    /*
        \details Returns a button representing the state of the right directional pad button of the gamepad.
    */
    const CYIGamePadButton     &GetDPadRightButton() const;

    /*
        \details Returns a button representing the state of the up directional pad button of the gamepad.
    */
    const CYIGamePadButton     &GetDPadUpButton() const;

    /*
        \details Returns a button representing the state of the down directional pad button of the gamepad.
    */
    const CYIGamePadButton     &GetDPadDownButton() const;

    /*
        \details Returns a button representing the state of button 0 of the gamepad.

        \note On Playstation consoles this is the Cross button and on Xbox consoles this is the A button.
    */
    const CYIGamePadButton     &GetButton0() const;

    /*
        \details Returns a button representing the state of button 1 of the gamepad.

        \note On Playstation consoles this is the Circle button and on Xbox consoles this is the B button.
    */
    const CYIGamePadButton     &GetButton1() const;

    /*
        \details Returns a button representing the state of button 2 of the gamepad.

        \note On Playstation consoles this is the Square button and on Xbox consoles this is the X button.
    */
    const CYIGamePadButton     &GetButton2() const; // XB: X, PS: Square

    /*
        \details Returns a button representing the state of button 3 of the gamepad.

        \note On Playstation consoles this is the Triangle button and on Xbox consoles this is the Y button.
    */
    const CYIGamePadButton     &GetButton3() const;

    /*
        \details Returns a button representing the state of the select button of the gamepad.
    */
    const CYIGamePadButton     &GetSelectButton() const;

    /*
        \details Returns a button representing the state of the start button of the gamepad.
    */
    const CYIGamePadButton     &GetStartButton() const;

    /*
        \details Returns a button representing the state of the left thumb stick button of the gamepad.

        \note This is the button accessed by pressing down on the left thumb stick. On Playstation consoles this is also known as L3.
    */
    const CYIGamePadButton     &GetLeftThumbStickButton() const;

    /*
        \details Returns a button representing the state of the right thumb stick button of the gamepad.

        \note This is the button accessed by pressing down on the right thumb stick. On Playstation consoles this is also known as R3.
    */
    const CYIGamePadButton     &GetRightThumbStickButton() const;

    /*
        \details Returns a button representing the state of the left bumper button of the gamepad.

        \note On Playstation consoles this is also known as L1.
    */
    const CYIGamePadButton     &GetLeftBumperButton() const;

    /*
        \details Returns a button representing the state of the left bumper button of the gamepad.

        \note On Playstation consoles this is also known as R1.
    */
    const CYIGamePadButton     &GetRightBumperButton() const;

    /*
        \details Returns a button representing the state of the left trigger button of the gamepad.

        \note On Playstation consoles this is also known as L2.
    */
    const CYIGamePadButton     &GetLeftTriggerButton() const;

    /*
        \details Returns a button representing the state of the right trigger button of the gamepad.

        \note On Playstation consoles this is also known as R2.
    */
    const CYIGamePadButton     &GetRightTriggerButton() const;

    /*
        \details Returns a button representing the state of the left direction of the left thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetLeftThumbStickLeftButton() const;

    /*
        \details Returns a button representing the state of the right direction of the left thumbstick. This is a digital representation of the analog directional stick.
    */

    const CYIGamePadButton     &GetLeftThumbStickRightButton() const;
    /*
        \details Returns a button representing the state of the up direction of the left thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetLeftThumbStickUpButton() const;

    /*
        \details Returns a button representing the state of the down direction of the left thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetLeftThumbStickDownButton() const;

    /*
        \details Returns a button representing the state of the left direction of the right thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetRightThumbStickLeftButton() const;

    /*
        \details Returns a button representing the state of the right direction of the right thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetRightThumbStickRightButton() const;

    /*
        \details Returns a button representing the state of the up direction of the right thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetRightThumbStickUpButton() const;

    /*
        \details Returns a button representing the state of the down direction of the right thumbstick. This is a digital representation of the analog directional stick.
    */
    const CYIGamePadButton     &GetRightThumbStickDownButton() const;

    /*
        \details Returns a set of extended buttons not found on a typical gamepad. 

        \note If the current gamepad does not have extended buttons nullptr will be returned.
    */
    const CYIGamePadExtendedButtons *GetExtendedButtons() const;

    /*
        \details Returns the current analog x and y position of the left thumbstick.
    */
    const glm::vec2            &GetLeftThumbStickAxes() const;

    /*
        \details Returns the current analog x and y position of the right thumbstick.
    */
    const glm::vec2            &GetRightThumbStickAxes() const;

    /*
        \details Returns the current analog position of the left trigger.

        \note On Playstation consoles this is also known as L2.
    */
    float GetLeftTriggerAxis() const;

    /*
        \details Returns the current analog position of the right trigger.

        \note On Playstation consoles this is also known as R2.
    */
    float GetRightTriggerAxis() const;

    /*
        \details Returns true if auto repeat is enabled.

        \sa SetAutoRepeatEnabled
    */
    bool IsAutoRepeatEnabled() const;

    /*
        \details Enabled the auto-repeat feature if \a bEnabled is true. Auto-repeat will repeat directional input while a directional button/stick is held down.
    */
    void SetAutoRepeatEnabled(bool bEnabled);

private:
    CYIGamePad();
    ~CYIGamePad();
    
    CYIGamePadButton    m_dPadLeftButton;
    CYIGamePadButton    m_dPadRightButton;
    CYIGamePadButton    m_dPadUpButton;
    CYIGamePadButton    m_dPadDownButton;
    CYIGamePadButton    m_button0;
    CYIGamePadButton    m_button1;
    CYIGamePadButton    m_button2;
    CYIGamePadButton    m_button3;
    CYIGamePadButton    m_selectButton;
    CYIGamePadButton    m_startButton;
    CYIGamePadButton    m_leftThumbStickButton;
    CYIGamePadButton    m_rightThumbStickButton;
    CYIGamePadButton    m_leftBumperButton;
    CYIGamePadButton    m_rightBumperButton;

    CYIGamePadButton    m_leftTriggerButton;
    CYIGamePadButton    m_rightTriggerButton;
    CYIGamePadButton    m_leftThumbStickLeftButton;
    CYIGamePadButton    m_leftThumbStickRightButton;
    CYIGamePadButton    m_leftThumbStickUpButton;
    CYIGamePadButton    m_leftThumbStickDownButton;
    CYIGamePadButton    m_rightThumbStickLeftButton;
    CYIGamePadButton    m_rightThumbStickRightButton;
    CYIGamePadButton    m_rightThumbStickUpButton;
    CYIGamePadButton    m_rightThumbStickDownButton;

    CYIGamePadExtendedButtons *m_pExtendedButtons;

    glm::vec2           m_leftThumbStickAxes;
    glm::vec2           m_rightThumbStickAxes;
    float m_leftTriggerAxis;
    float m_rightTriggerAxis;

    bool m_bAutoRepeat;
};

#endif // _YI_GAME_PAD_H_