\doxysection{pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick Class Reference}
\hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick}{}\label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
Inheritance diagram for pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.860465cm]{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a31f6e6136af756b1c93bf13f2be9d0af}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a03951e9da27e9fa4a6aa8c2a3eb52da6}{set\+\_\+joybuttonlist}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a3b7d1fdf1bae43b08c0a50aba669f130}{set\+\_\+timeout}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a515eb8af30b33cc9feb9754af120f668}{get\+\_\+joybutton}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a94f64bda81918452230177e6aa4e3dfa}{get\+\_\+joyaxes}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_ac837ff218b02c6a35c2670514517f8d6}{get\+\_\+joyballs}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a4308022d60189367c1d5a7c7eb66f6ce}{get\+\_\+joyhats}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a417509819332e634822ed6ada338e382}{get\+\_\+joyinput}} (self)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}A joystick for collecting responses\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a31f6e6136af756b1c93bf13f2be9d0af}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a31f6e6136af756b1c93bf13f2be9d0af} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Initializes a Joystick instance
        
        arguments
        
        None
        
        keyword arguments

        joybuttonlist   --  list of joystick buttons that are allowed (e.g.
                        [0,2,4]) or None to allow all buttons
                        (default = JOYBUTTONLIST)
        timeout     --  time in milliseconds after which None is returned
                        on a call to a get_* method when no input is
                        registered (default = JOYTIMEOUT)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a94f64bda81918452230177e6aa4e3dfa}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!get\_joyaxes@{get\_joyaxes}}
\index{get\_joyaxes@{get\_joyaxes}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{get\_joyaxes()}{get\_joyaxes()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a94f64bda81918452230177e6aa4e3dfa} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+get\+\_\+joyaxes (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for joystick axis movement
        
        arguments

        None
        
        keyword arguments

        timeout --  time in milliseconds after which None is returned
                    when no buttonpress is registered; None for no
                    timeout or 'default' to use the timeout property
                    (default = 'default')
        
        returns
        
        axespos, time   --  axespos is a [x,y,z] position list for the
                        positions of the joystick axes (usually [x,y,z]
                        for the main stick); x, y and z are floats
                        time is the time (measured from expbegintime)
                        an axismovement or a timeout occured
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_ad732211d47c8de078ca102592a510507}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_ac837ff218b02c6a35c2670514517f8d6}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!get\_joyballs@{get\_joyballs}}
\index{get\_joyballs@{get\_joyballs}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{get\_joyballs()}{get\_joyballs()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_ac837ff218b02c6a35c2670514517f8d6} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+get\+\_\+joyballs (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for joystick trackball movement
        
        arguments

        None
        
        keyword arguments

        timeout --  time in milliseconds after which None is returned
                    when no buttonpress is registered; None for no
                    timeout or 'default' to use the timeout property
                    (default = 'default')
        
        returns
        
        ballpos, time   --  ballpos is a [ball1,ball2,...,ballN] position
                        list for the positions of the joystick balls;
                        each ball position is a (x,y) tuple
                        time is the time (measured from expbegintime) a
                        ballmovement or a timeout occured
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_acbe464e3a0d8ef7dbd3e623c32f9a541}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a515eb8af30b33cc9feb9754af120f668}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!get\_joybutton@{get\_joybutton}}
\index{get\_joybutton@{get\_joybutton}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{get\_joybutton()}{get\_joybutton()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a515eb8af30b33cc9feb9754af120f668} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+get\+\_\+joybutton (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for joystick buttonpress
        
        arguments

        None
        
        keyword arguments

        joybuttonlist   --  list of buttons that are allowed (e.g.
                        [0,2,4]), None to allow all buttons or
                        'default' to use jbuttonlist property
                        (default = 'default')
        timeout     --  time in milliseconds after which None is returned
                        when no buttonpress is registered; None for no
                        timeout or 'default' to use the timeout property
                        (default = 'default')
        
        returns
        
        button, presstime   --  button is an integer, indicating which button
                            has been pressed or None when no button has
                            been pressed
                            presstime is the time (measured from
                            expbegintime) a buttonpress or a timeout
                            occured
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_ad2a3b8205b9762f39cfd16fb5bb16ba4}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a4308022d60189367c1d5a7c7eb66f6ce}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!get\_joyhats@{get\_joyhats}}
\index{get\_joyhats@{get\_joyhats}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{get\_joyhats()}{get\_joyhats()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a4308022d60189367c1d5a7c7eb66f6ce} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+get\+\_\+joyhats (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for joystick hat movement
        
        arguments

        None
        
        keyword arguments

        timeout --  time in milliseconds after which None is returned
                    when no buttonpress is registered; None for no
                    timeout or 'default' to use the timeout property
                    (default = 'default')
        
        returns
        
        hatpos, time    --  hatpos is a [hat1,hat2,...,hatN] position list
                        for the positions of the joystick hats; each
                        hat position is a (x,y) tuple
                        time is the time (measured from expbegintime) a
                        hatmovement or a timeout occured
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_a449394d1d1faac2a889ec886db878899}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a417509819332e634822ed6ada338e382}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!get\_joyinput@{get\_joyinput}}
\index{get\_joyinput@{get\_joyinput}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{get\_joyinput()}{get\_joyinput()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a417509819332e634822ed6ada338e382} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+get\+\_\+joyinput (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for any kind of joystick input
        
        arguments

        None
        
        keyword arguments

        joybuttonlist   --  list of buttons that are allowed (e.g.
                        [0,2,4]), None to allow all buttons or
                        'default' to use jbuttonlist property
                        (default = 'default')
        timeout     --  time in milliseconds after which None is returned
                        when no buttonpress is registered; None for no
                        timeout or 'default' to use the timeout property
                        (default = 'default')
        
        returns
        
        event, input, time  --  event is a string or None on a timeout,
                            indicating what kind of input was given:
                            'joybuttonpress', input is an integer
                            button number
                            'joyaxismotion', input is a [x,y,z]
                            position list for the positions of the
                            joystick axes (usually [x,y,z] for the
                            main stick); x, y and z are floats
                            'joyballmotion', input is a
                            [ball1,ball2,...,ballN] position list for
                            the positions of the joystick balls; each
                            ball position is a (x,y) tuple
                            'joyhatmotion', input is a
                            [hat1,hat2,...,hatN] position list for
                            the positions of the joystick hats; each
                            hat position is a (x,y) tuple
                            time is the time (measured from
                            expbegintime) any input or a timeout
                            occured
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_a38c8fa38022341e13b9d15de39d9507a}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a03951e9da27e9fa4a6aa8c2a3eb52da6}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!set\_joybuttonlist@{set\_joybuttonlist}}
\index{set\_joybuttonlist@{set\_joybuttonlist}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{set\_joybuttonlist()}{set\_joybuttonlist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a03951e9da27e9fa4a6aa8c2a3eb52da6} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+set\+\_\+joybuttonlist (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set a list of accepted joystick buttons
        
        arguments

        None
        
        keyword arguments

        joybuttonlist   --  list of joystick buttons that are allowed (e.g.
                        [0,2,4]) or None to allow all buttons
                        (default = None)
        returns
        
        None            --  sets the jbuttonlist property
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_a85f1e42200f7977b0af6378a5f5d7009}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.

\Hypertarget{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a3b7d1fdf1bae43b08c0a50aba669f130}\index{pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_joystick.basejoystick.BaseJoystick@{pygaze.\_joystick.basejoystick.BaseJoystick}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__joystick_1_1basejoystick_1_1_base_joystick_a3b7d1fdf1bae43b08c0a50aba669f130} 
pygaze.\+\_\+joystick.\+basejoystick.\+Base\+Joystick.\+set\+\_\+timeout (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set a timeout (in milliseconds)
        
        arguments

        None
        
        keyword arguments

        timeout --  time in milliseconds after which None is returned
                    on a call to get_clicked method when no click is
                    registered (default = None)
        
        returns

        None        --  sets timeout property
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__joystick_1_1pygamejoystick_1_1_py_game_joystick_ad6a6dbd87228213c506ed7fcc039721b}{pygaze.\+\_\+joystick.\+pygamejoystick.\+Py\+Game\+Joystick}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
C\+:/\+Users/lurax/eyetracking\+Tobii/pygaze/\+\_\+joystick/\mbox{\hyperlink{basejoystick_8py}{basejoystick.\+py}}\end{DoxyCompactItemize}
