\doxysection{pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse Class Reference}
\hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse}{}\label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
Inheritance diagram for pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=0.927152cm]{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_acd410b8c1c94804969b0eb4de89656e6}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aa2ba677ab6417d00217a88a6181b8e44}{set\+\_\+mousebuttonlist}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a537292910bcb6086fe0484b44a020e3f}{set\+\_\+timeout}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a4f3b9f345ff1a28e97252239b0f41f2b}{set\+\_\+visible}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_ac9cfb8afec914c6ffc9b2139d6173899}{set\+\_\+pos}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a0140ed3a121d04cfa231c984cb987082}{get\+\_\+pos}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aec7ef1be653de8e6a97fa87786295cf2}{get\+\_\+clicked}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a454d3cc9fac5fed55013d0b67b5c8815}{get\+\_\+pressed}} (self)
\end{DoxyCompactItemize}


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

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_acd410b8c1c94804969b0eb4de89656e6}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_acd410b8c1c94804969b0eb4de89656e6} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Initializes mouse object
        
        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 =
                        MOUSEBUTTONLIST)
        timeout --      time in milliseconds after which None is returned
                        on a call to get_clicked method when no click is
                        registered (default = MOUSETIMEOUT)
        visible --      Boolean indicating if mouse should be visible or not
                        (default = False)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aec7ef1be653de8e6a97fa87786295cf2}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!get\_clicked@{get\_clicked}}
\index{get\_clicked@{get\_clicked}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{get\_clicked()}{get\_clicked()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aec7ef1be653de8e6a97fa87786295cf2} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+get\+\_\+clicked (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a0161c50f70a84a15c1d3f507716220d2}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a34730358b47e03087e50cb57814fddc9}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a98046d3c239f19663469ff8f9f4bb728}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a0140ed3a121d04cfa231c984cb987082}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!get\_pos@{get\_pos}}
\index{get\_pos@{get\_pos}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{get\_pos()}{get\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a0140ed3a121d04cfa231c984cb987082} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a1f0ab20b7599f50969dc0788e830a77d}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad68d0540ea0e5481d9278f2e63fa32e4}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a5da405111b119ab21e9a82613505f97b}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a454d3cc9fac5fed55013d0b67b5c8815}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!get\_pressed@{get\_pressed}}
\index{get\_pressed@{get\_pressed}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{get\_pressed()}{get\_pressed()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a454d3cc9fac5fed55013d0b67b5c8815} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a6483fbcee5da707d1140fe741be71f2a}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a78b41c9323f86da013ebfa67278ba9da}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a61fa984d75395646237e3e0b4f7d7c9f}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aa2ba677ab6417d00217a88a6181b8e44}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!set\_mousebuttonlist@{set\_mousebuttonlist}}
\index{set\_mousebuttonlist@{set\_mousebuttonlist}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{set\_mousebuttonlist()}{set\_mousebuttonlist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_aa2ba677ab6417d00217a88a6181b8e44} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+set\+\_\+mousebuttonlist (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a075c494a1c6a3c27251c701755cbe278}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_ad0744d66ab7b2a90f0031d536c980c5a}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a9f5ab93bed38630ea48fcf6a68e3192e}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_ac9cfb8afec914c6ffc9b2139d6173899}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!set\_pos@{set\_pos}}
\index{set\_pos@{set\_pos}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{set\_pos()}{set\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_ac9cfb8afec914c6ffc9b2139d6173899} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+set\+\_\+pos (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_abac8f937b4f7f7d0162e333cb7c1644b}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a0c2fea5f852d8efcb361271db8a0f956}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_ac1445dda4a4f042baf5206114a109396}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a537292910bcb6086fe0484b44a020e3f}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a537292910bcb6086fe0484b44a020e3f} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+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__mouse_1_1osmouse_1_1_o_s_mouse_acedcda51ba1e5f0f7a0f135e06396249}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_a078bc6083c58a67157b033b16714e506}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a5b78a3d4404cd04ebc108522ff1c26f5}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.

\Hypertarget{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a4f3b9f345ff1a28e97252239b0f41f2b}\index{pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}!set\_visible@{set\_visible}}
\index{set\_visible@{set\_visible}!pygaze.\_mouse.basemouse.BaseMouse@{pygaze.\_mouse.basemouse.BaseMouse}}
\doxysubsubsection{\texorpdfstring{set\_visible()}{set\_visible()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1basemouse_1_1_base_mouse_a4f3b9f345ff1a28e97252239b0f41f2b} 
pygaze.\+\_\+mouse.\+basemouse.\+Base\+Mouse.\+set\+\_\+visible (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aaa8aac7d17bc9c177f25eed8edb581d5}{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse}}, \mbox{\hyperlink{classpygaze_1_1__mouse_1_1psychopymouse_1_1_psycho_py_mouse_aefb9c559e724e8b9c78383cdf6f5b6c7}{pygaze.\+\_\+mouse.\+psychopymouse.\+Psycho\+Py\+Mouse}}, and \mbox{\hyperlink{classpygaze_1_1__mouse_1_1pygamemouse_1_1_py_game_mouse_a117c8e35ee5aaf3f8f366b073121f297}{pygaze.\+\_\+mouse.\+pygamemouse.\+Py\+Game\+Mouse}}.



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