\doxysection{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse Class Reference}
\hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse}{}\label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
Inheritance diagram for pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aedcde5eee8ed6c6246ddb59a516e3796}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, mousebuttonlist=settings.\+MOUSEBUTTONLIST, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40}{timeout}}=settings.\+MOUSETIMEOUT, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a1d289c7e51418525c0b20d9f6c3f3693}{visible}}=False)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad0744d66ab7b2a90f0031d536c980c5a}{set\+\_\+mousebuttonlist}} (self, mousebuttonlist=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a078bc6083c58a67157b033b16714e506}{set\+\_\+timeout}} (self, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40}{timeout}}=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aefb9c559e724e8b9c78383cdf6f5b6c7}{set\+\_\+visible}} (self, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a1d289c7e51418525c0b20d9f6c3f3693}{visible}}=True)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a0c2fea5f852d8efcb361271db8a0f956}{set\+\_\+pos}} (self, pos=(0, 0))
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad68d0540ea0e5481d9278f2e63fa32e4}{get\+\_\+pos}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a34730358b47e03087e50cb57814fddc9}{get\+\_\+clicked}} (self, mousebuttonlist=\textquotesingle{}default\textquotesingle{}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40}{timeout}}=\textquotesingle{}default\textquotesingle{})
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a78b41c9323f86da013ebfa67278ba9da}{get\+\_\+pressed}} (self)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_acd410b8c1c94804969b0eb4de89656e6}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a35f57fa6d0e93355785130546e4b9cf7}{mouse}}
\item 
list \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25d18381ed5fd624cff5440a426f9a17}{mbuttonlist}} = None
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40}{timeout}} = timeout
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a1d289c7e51418525c0b20d9f6c3f3693}{visible}} = visible
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aedcde5eee8ed6c6246ddb59a516e3796}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aedcde5eee8ed6c6246ddb59a516e3796} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{mousebuttonlist}{ = {\ttfamily settings.MOUSEBUTTONLIST}, }\item[{}]{timeout}{ = {\ttfamily settings.MOUSETIMEOUT}, }\item[{}]{visible}{ = {\ttfamily False}}\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a34730358b47e03087e50cb57814fddc9}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!get\_clicked@{get\_clicked}}
\index{get\_clicked@{get\_clicked}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{get\_clicked()}{get\_clicked()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a34730358b47e03087e50cb57814fddc9} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+get\+\_\+clicked (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{mousebuttonlist}{ = {\ttfamily \textquotesingle{}default\textquotesingle{}}, }\item[{}]{timeout}{ = {\ttfamily \textquotesingle{}default\textquotesingle{}}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Waits for mouse clicks
        
        arguments
        
        None
        
        keyword arguments

        mousebuttonlist --  list of mouse buttons that are allowed (e.g.
                        [1,3] for left and right button); None to
                        allow all buttons or 'default' to use the
                        mbuttonlist property (default = 'default')
        timeout --  time in milliseconds after which None is returned
                    when no click is registered; None for no timeout or
                    'default' to use the timeout property (default =
                    'default')
        
        returns
        
        mousebutton, clickpos, clicktime    --  mousebutton is an integer,
                                    indicating which button has
                                    been pressed or None when no
                                    button has been pressed;
                                    clickpos is an (x,y) position
                                    tuple or None when no click
                                    was registered;
                                    clicktime is the time
                                    (measured from expbegintime) a
                                    buttonpress or a timeout
                                    occured
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aec7ef1be653de8e6a97fa87786295cf2}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad68d0540ea0e5481d9278f2e63fa32e4}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!get\_pos@{get\_pos}}
\index{get\_pos@{get\_pos}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{get\_pos()}{get\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad68d0540ea0e5481d9278f2e63fa32e4} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+get\+\_\+pos (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Returns mouse position
        
        arguments

        None
        
        keyword arguments
        
        None
        
        returns
        
        mpos        --  a (x,y) position tuple, assuming top left is (0,0)
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a0140ed3a121d04cfa231c984cb987082}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a78b41c9323f86da013ebfa67278ba9da}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!get\_pressed@{get\_pressed}}
\index{get\_pressed@{get\_pressed}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{get\_pressed()}{get\_pressed()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a78b41c9323f86da013ebfa67278ba9da} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+get\+\_\+pressed (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Returns the current state of the mouse buttons
        
        arguments
        
        None
        
        keyword arguments
        
        None
        
        returns

        statelist   --  a list of Booleans indicating which mousebutton is
                    down (e.g. [1,0,0] when only button 1 is pressed on
                    a three-button-mouse)
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a454d3cc9fac5fed55013d0b67b5c8815}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad0744d66ab7b2a90f0031d536c980c5a}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!set\_mousebuttonlist@{set\_mousebuttonlist}}
\index{set\_mousebuttonlist@{set\_mousebuttonlist}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{set\_mousebuttonlist()}{set\_mousebuttonlist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad0744d66ab7b2a90f0031d536c980c5a} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+set\+\_\+mousebuttonlist (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{mousebuttonlist}{ = {\ttfamily None}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set a list of accepted mouse buttons
        
        arguments
        
        None
        
        keyword arguments

        mousebuttonlist --  list of mouse buttons that are allowed (e.g.
                        [1,3] for left and right button) or None to
                        allow all buttons (default = None)
        
        returns
        
        None        --   sets mbuttonlist property
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aa2ba677ab6417d00217a88a6181b8e44}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a0c2fea5f852d8efcb361271db8a0f956}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!set\_pos@{set\_pos}}
\index{set\_pos@{set\_pos}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{set\_pos()}{set\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a0c2fea5f852d8efcb361271db8a0f956} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+set\+\_\+pos (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pos}{ = {\ttfamily (0,0)}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set the mouse position
        
        arguments
        
        None
        
        keyword arguments

        pos     --  an (x,y) position tuple, assuming top left is (0,0)
                    (default = (0,0))
        
        returns
        
        None        --  sets the mouse position
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_ac9cfb8afec914c6ffc9b2139d6173899}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a078bc6083c58a67157b033b16714e506}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a078bc6083c58a67157b033b16714e506} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+set\+\_\+timeout (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{timeout}{ = {\ttfamily None}}\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 from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a537292910bcb6086fe0484b44a020e3f}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aefb9c559e724e8b9c78383cdf6f5b6c7}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!set\_visible@{set\_visible}}
\index{set\_visible@{set\_visible}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{set\_visible()}{set\_visible()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aefb9c559e724e8b9c78383cdf6f5b6c7} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+set\+\_\+visible (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{visible}{ = {\ttfamily True}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Sets the visibility of the cursor
        
        arguments
        
        None
        
        keyword arguments

        visible --  Boolean indicating if mouse should be visible or not
                    (default = False)
        
        returns
        
        None        --  sets visible property
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a4f3b9f345ff1a28e97252239b0f41f2b}{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse}}.



\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25d18381ed5fd624cff5440a426f9a17}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!mbuttonlist@{mbuttonlist}}
\index{mbuttonlist@{mbuttonlist}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{mbuttonlist}{mbuttonlist}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25d18381ed5fd624cff5440a426f9a17} 
list pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+mbuttonlist = None}

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a35f57fa6d0e93355785130546e4b9cf7}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!mouse@{mouse}}
\index{mouse@{mouse}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{mouse}{mouse}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a35f57fa6d0e93355785130546e4b9cf7} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+mouse}

{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{=\ \ psychopy.event.Mouse(visible=\textcolor{keyword}{False},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ win=pygaze.expdisplay)}

\end{DoxyCode}
\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!timeout@{timeout}}
\index{timeout@{timeout}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{timeout}{timeout}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a25394cae7712e4d2ede5b7298d2cbc40} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+timeout = timeout}

\Hypertarget{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a1d289c7e51418525c0b20d9f6c3f3693}\index{pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}!visible@{visible}}
\index{visible@{visible}!pygaze.\_mouse.psychopymouse.PsychoPyMouse@{pygaze.\_mouse.psychopymouse.PsychoPyMouse}}
\doxysubsubsection{\texorpdfstring{visible}{visible}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a1d289c7e51418525c0b20d9f6c3f3693} 
pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse.\+visible = visible}



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