\doxysection{pygaze.\+\_\+mouse.\+osmouse.\+OSMouse Class Reference}
\hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse}{}\label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
Inheritance diagram for pygaze.\+\_\+mouse.\+osmouse.\+OSMouse\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_af2b834a9a915933c2fd176042faaa765}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, mousebuttonlist=settings.\+MOUSEBUTTONLIST, timeout=settings.\+MOUSETIMEOUT, visible=False)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a075c494a1c6a3c27251c701755cbe278}{set\+\_\+mousebuttonlist}} (self, mousebuttonlist=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_acedcda51ba1e5f0f7a0f135e06396249}{set\+\_\+timeout}} (self, timeout=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aaa8aac7d17bc9c177f25eed8edb581d5}{set\+\_\+visible}} (self, visible=True)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_abac8f937b4f7f7d0162e333cb7c1644b}{set\+\_\+pos}} (self, pos=(0, 0))
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a1f0ab20b7599f50969dc0788e830a77d}{get\+\_\+pos}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a0161c50f70a84a15c1d3f507716220d2}{get\+\_\+clicked}} (self, mousebuttonlist=u \textquotesingle{}default\textquotesingle{}, timeout=u \textquotesingle{}default\textquotesingle{})
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a6483fbcee5da707d1140fe741be71f2a}{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_1osmouse_1_1_o_s_mouse_a2c74e64a51ea74cc8307f75586e45c6d}{experiment}} = settings.\+osexperiment
\item 
\mbox{\hyperlink{namespacepygaze_1_1py3compat_a00268eef6a7a5c7241ae0072047d8171}{str}} \mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aef5bb8248cdb58a981f1106e4608bacb}{uniform\+\_\+coordinates}} = u\textquotesingle{}yes\textquotesingle{}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a4c1048845a273ae8772fa16061fea9fb}{mouse}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a5eb50af2041bd17a19f3516fc8cef192}{\+\_\+from\+\_\+pos}} (self, pos)
\item 
\mbox{\hyperlink{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a2b696664f98ec5b26a4d5ecd83ba0735}{\+\_\+to\+\_\+pos}} (self, pos)
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_af2b834a9a915933c2fd176042faaa765}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_af2b834a9a915933c2fd176042faaa765} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+\_\+\+\_\+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_1osmouse_1_1_o_s_mouse_a5eb50af2041bd17a19f3516fc8cef192}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!\_from\_pos@{\_from\_pos}}
\index{\_from\_pos@{\_from\_pos}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{\_from\_pos()}{\_from\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a5eb50af2041bd17a19f3516fc8cef192} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+\_\+from\+\_\+pos (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pos}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}

\begin{DoxyVerb}Convert OpenSesame coordinates to PyGaze coordinates.\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a2b696664f98ec5b26a4d5ecd83ba0735}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!\_to\_pos@{\_to\_pos}}
\index{\_to\_pos@{\_to\_pos}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{\_to\_pos()}{\_to\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a2b696664f98ec5b26a4d5ecd83ba0735} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+\_\+to\+\_\+pos (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pos}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}

\begin{DoxyVerb}Convert PyGaze coordinates to OpenSesame coordinates.\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a0161c50f70a84a15c1d3f507716220d2}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!get\_clicked@{get\_clicked}}
\index{get\_clicked@{get\_clicked}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{get\_clicked()}{get\_clicked()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a0161c50f70a84a15c1d3f507716220d2} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+get\+\_\+clicked (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{mousebuttonlist}{ = {\ttfamily u\textquotesingle{}default\textquotesingle{}}, }\item[{}]{timeout}{ = {\ttfamily u\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_1osmouse_1_1_o_s_mouse_a1f0ab20b7599f50969dc0788e830a77d}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!get\_pos@{get\_pos}}
\index{get\_pos@{get\_pos}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{get\_pos()}{get\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a1f0ab20b7599f50969dc0788e830a77d} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_a6483fbcee5da707d1140fe741be71f2a}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!get\_pressed@{get\_pressed}}
\index{get\_pressed@{get\_pressed}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{get\_pressed()}{get\_pressed()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a6483fbcee5da707d1140fe741be71f2a} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_a075c494a1c6a3c27251c701755cbe278}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!set\_mousebuttonlist@{set\_mousebuttonlist}}
\index{set\_mousebuttonlist@{set\_mousebuttonlist}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{set\_mousebuttonlist()}{set\_mousebuttonlist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a075c494a1c6a3c27251c701755cbe278} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_abac8f937b4f7f7d0162e333cb7c1644b}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!set\_pos@{set\_pos}}
\index{set\_pos@{set\_pos}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{set\_pos()}{set\_pos()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_abac8f937b4f7f7d0162e333cb7c1644b} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_acedcda51ba1e5f0f7a0f135e06396249}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_acedcda51ba1e5f0f7a0f135e06396249} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_aaa8aac7d17bc9c177f25eed8edb581d5}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!set\_visible@{set\_visible}}
\index{set\_visible@{set\_visible}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{set\_visible()}{set\_visible()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aaa8aac7d17bc9c177f25eed8edb581d5} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+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_1osmouse_1_1_o_s_mouse_a2c74e64a51ea74cc8307f75586e45c6d}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!experiment@{experiment}}
\index{experiment@{experiment}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{experiment}{experiment}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a2c74e64a51ea74cc8307f75586e45c6d} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+experiment = settings.\+osexperiment}

\Hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a4c1048845a273ae8772fa16061fea9fb}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!mouse@{mouse}}
\index{mouse@{mouse}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{mouse}{mouse}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_a4c1048845a273ae8772fa16061fea9fb} 
pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+mouse}

{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{=\ \ mouse(self.experiment,\ buttonlist=mousebuttonlist,}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ timeout=timeout)}

\end{DoxyCode}
\Hypertarget{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aef5bb8248cdb58a981f1106e4608bacb}\index{pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}!uniform\_coordinates@{uniform\_coordinates}}
\index{uniform\_coordinates@{uniform\_coordinates}!pygaze.\_mouse.osmouse.OSMouse@{pygaze.\_mouse.osmouse.OSMouse}}
\doxysubsubsection{\texorpdfstring{uniform\_coordinates}{uniform\_coordinates}}
{\footnotesize\ttfamily \label{classpygaze_1_1__mouse_1_1osmouse_1_1_o_s_mouse_aef5bb8248cdb58a981f1106e4608bacb} 
\mbox{\hyperlink{namespacepygaze_1_1py3compat_a00268eef6a7a5c7241ae0072047d8171}{str}} pygaze.\+\_\+mouse.\+osmouse.\+OSMouse.\+uniform\+\_\+coordinates = u\textquotesingle{}yes\textquotesingle{}}



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