.. index:: pair: class; EE::Window::Joystick
.. _doxid-class_e_e_1_1_window_1_1_joystick:

class EE::Window::Joystick
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Represents a physical :ref:`Joystick <doxid-class_e_e_1_1_window_1_1_joystick>`, and contains all its states. :ref:`More...<details-class_e_e_1_1_window_1_1_joystick>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <joystick.hpp>
	
	class Joystick {
	public:
		// construction
	
		:target:`Joystick<doxid-class_e_e_1_1_window_1_1_joystick_1ac028067bebac7d820081758a5fafc7c4>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& index);
		virtual :target:`~Joystick<doxid-class_e_e_1_1_window_1_1_joystick_1a3c1dfed4b2195fdca19cd4c3c24196cb>`();

		// methods
	
		virtual void :ref:`close<doxid-class_e_e_1_1_window_1_1_joystick_1a481db8cca547f4f669c5df55d50c0495>`();
		virtual void :ref:`open<doxid-class_e_e_1_1_window_1_1_joystick_1a34ab5e67f9f9208c171179ae3db8c700>`();
		virtual void :ref:`update<doxid-class_e_e_1_1_window_1_1_joystick_1afaaffeced7f80b5533ba17d93e524210>`() = 0;
		virtual :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` :ref:`getHat<doxid-class_e_e_1_1_window_1_1_joystick_1a872cef1b6de30b0a940407e6ca226179>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index = 0) = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getAxis<doxid-class_e_e_1_1_window_1_1_joystick_1ac6a7b4b5182d0d96976a4ee378917829>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& axis) = 0;
		virtual :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>` :ref:`getBallMotion<doxid-class_e_e_1_1_window_1_1_joystick_1a23bd8bf39008356ae9d65bc829a31a2f>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& ball) = 0;
		virtual bool :ref:`isPlugged<doxid-class_e_e_1_1_window_1_1_joystick_1ae007d6463a6f77294a75a9c07ee31cc0>`() const = 0;
		virtual void :ref:`reOpen<doxid-class_e_e_1_1_window_1_1_joystick_1a4b1243b7c7468259eecb4a24bc069495>`();
		const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& :ref:`getNumHats<doxid-class_e_e_1_1_window_1_1_joystick_1a669203965305f8252e6b96ecb6bb4ed0>`() const;
		const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& :ref:`getNumButtons<doxid-class_e_e_1_1_window_1_1_joystick_1ad3c109b1832fe7cef186ddac684e93a3>`() const;
		const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& :ref:`getNumAxes<doxid-class_e_e_1_1_window_1_1_joystick_1a75b0fd353074cc115cf0b274ed7e4b1e>`() const;
		const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& :ref:`getNumBalls<doxid-class_e_e_1_1_window_1_1_joystick_1a99bf5ff8f2b2159318b8e1de842f23cc>`() const;
		const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& :ref:`getButtonTrigger<doxid-class_e_e_1_1_window_1_1_joystick_1a200f8aff78275a94ad6f9f1e280ecff7>`() const;
		const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& :ref:`getButtonUpTrigger<doxid-class_e_e_1_1_window_1_1_joystick_1aead79ca3c7ebb04f21113e25f2de4b14>`() const;
		bool :ref:`isButtonDown<doxid-class_e_e_1_1_window_1_1_joystick_1aec1e214d67ffcc7bcfb71509bce6c82a>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index);
		bool :ref:`isButtonUp<doxid-class_e_e_1_1_window_1_1_joystick_1aae6596b1e54f74f792271e20ab5f7ae8>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index);
	};
.. _details-class_e_e_1_1_window_1_1_joystick:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Represents a physical :ref:`Joystick <doxid-class_e_e_1_1_window_1_1_joystick>`, and contains all its states.

Methods
-------

.. index:: pair: function; close
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a481db8cca547f4f669c5df55d50c0495:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void close()

Close the joystick

.. index:: pair: function; open
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a34ab5e67f9f9208c171179ae3db8c700:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void open()

Open the joystick

.. index:: pair: function; update
.. _doxid-class_e_e_1_1_window_1_1_joystick_1afaaffeced7f80b5533ba17d93e524210:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void update() = 0

Update the current joystick states ( users don't need to call this manually )

.. index:: pair: function; getHat
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a872cef1b6de30b0a940407e6ca226179:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` getHat(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index = 0) = 0



.. rubric:: Returns:

The hat index state



.. rubric:: See also:

EE_HAT_POS to get info about the possible states You just need to compare the state against what position you need, example if ( myJoy->GetHat() == :ref:`HAT_LEFT <doxid-namespace_e_e_1_1_window_1a618b50d984cfb5b9249aa6e8f9eb7b25a9f9101c948ea1adddbd70a69195216fe>`) { ... do whatever you need to do }

.. index:: pair: function; getAxis
.. _doxid-class_e_e_1_1_window_1_1_joystick_1ac6a7b4b5182d0d96976a4ee378917829:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` getAxis(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& axis) = 0



.. rubric:: Returns:

the axis state



.. rubric:: See also:

EE_JOYAXIS to know the possible axis ( usually you will use :ref:`AXIS_X <doxid-namespace_e_e_1_1_window_1ac91aa8fe027beb2947abe8eaea8ac881a2f6061a5200a85b7e6e2456837a817ce>` and :ref:`AXIS_Y <doxid-namespace_e_e_1_1_window_1ac91aa8fe027beb2947abe8eaea8ac881a71b4ed0455e4f9bcd7243ae91d5467c2>` Axis values goes from :ref:`AXIS_MIN <doxid-joycodes_8hpp_1a4bbe71015f550ff6c8b09863e86b61ff>` to :ref:`AXIS_MAX <doxid-joycodes_8hpp_1a96f55016188dae6c443e2b971ec424bb>`

.. index:: pair: function; getBallMotion
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a23bd8bf39008356ae9d65bc829a31a2f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>` getBallMotion(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& ball) = 0



.. rubric:: Returns:

The ball motion position

.. index:: pair: function; isPlugged
.. _doxid-class_e_e_1_1_window_1_1_joystick_1ae007d6463a6f77294a75a9c07ee31cc0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual bool isPlugged() const = 0



.. rubric:: Returns:

True if the joystick is plugged in

.. index:: pair: function; reOpen
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a4b1243b7c7468259eecb4a24bc069495:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual void reOpen()

ReOpen the joysick ( this is the same of doing Close and the Open )

.. index:: pair: function; getNumHats
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a669203965305f8252e6b96ecb6bb4ed0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& getNumHats() const



.. rubric:: Returns:

The number of hats

.. index:: pair: function; getNumButtons
.. _doxid-class_e_e_1_1_window_1_1_joystick_1ad3c109b1832fe7cef186ddac684e93a3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& getNumButtons() const



.. rubric:: Returns:

The number of buttons

.. index:: pair: function; getNumAxes
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a75b0fd353074cc115cf0b274ed7e4b1e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& getNumAxes() const



.. rubric:: Returns:

The number of axes

.. index:: pair: function; getNumBalls
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a99bf5ff8f2b2159318b8e1de842f23cc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& getNumBalls() const



.. rubric:: Returns:

The number of balls

.. index:: pair: function; getButtonTrigger
.. _doxid-class_e_e_1_1_window_1_1_joystick_1a200f8aff78275a94ad6f9f1e280ecff7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& getButtonTrigger() const



.. rubric:: Returns:

The buttons states flags

.. index:: pair: function; getButtonUpTrigger
.. _doxid-class_e_e_1_1_window_1_1_joystick_1aead79ca3c7ebb04f21113e25f2de4b14:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& getButtonUpTrigger() const



.. rubric:: Returns:

The buttons released states flags

.. index:: pair: function; isButtonDown
.. _doxid-class_e_e_1_1_window_1_1_joystick_1aec1e214d67ffcc7bcfb71509bce6c82a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool isButtonDown(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index)



.. rubric:: Returns:

If the button index is down ( pressed )

.. index:: pair: function; isButtonUp
.. _doxid-class_e_e_1_1_window_1_1_joystick_1aae6596b1e54f74f792271e20ab5f7ae8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool isButtonUp(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& index)



.. rubric:: Returns:

If the button index is up ( released )