\doxysection{pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor Class Reference}
\hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor}{}\label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_ad1d274bba9c643d00a9da05d5c18af8b}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, disptype=\textquotesingle{}\textquotesingle{}, \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a456dbbd0cccf0f25761a653d326c59bf}{ctype}}=\textquotesingle{}cross\textquotesingle{}, \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f67f4cb0b53174b305cab719667f071}{size}}=20, \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a92d666a3104e65d1e87b58bdace85014}{colour}}=(200, 100, 100), \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f88fe671701946728c81310fce9c93b}{pw}}=3, \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a8c6021b00bbd74d3750f9f50c2762585}{fill}}=True)
\item 
\mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a1aa5bd4b2996310dc0a2cb22376e4082}{update}} (self, screen, gazepos)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{namespacepygaze_1_1py3compat_a00268eef6a7a5c7241ae0072047d8171}{str}} \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a456dbbd0cccf0f25761a653d326c59bf}{ctype}} = ctype
\item 
\mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a8c6021b00bbd74d3750f9f50c2762585}{fill}} = fill
\item 
\mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f88fe671701946728c81310fce9c93b}{pw}} = pw
\item 
tuple \mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f67f4cb0b53174b305cab719667f071}{size}} = (int(size), int(size))
\item 
\mbox{\hyperlink{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a92d666a3104e65d1e87b58bdace85014}{colour}} = colour
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}Gaze contingent cursor\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_ad1d274bba9c643d00a9da05d5c18af8b}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_ad1d274bba9c643d00a9da05d5c18af8b} 
pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{disptype}{ = {\ttfamily \textquotesingle{}\textquotesingle{}}, }\item[{}]{ctype}{ = {\ttfamily \textquotesingle{}cross\textquotesingle{}}, }\item[{}]{size}{ = {\ttfamily 20}, }\item[{}]{colour}{ = {\ttfamily (200,100,100)}, }\item[{}]{pw}{ = {\ttfamily 3}, }\item[{}]{fill}{ = {\ttfamily True}}\end{DoxyParamCaption})}

\begin{DoxyVerb}Initializes cursor object
        
        arguments
        None
        
        keyword arguments
        disptype    --  string indicating which display type is used;
                    DEPRECATED: disptype is ignored (default = '')
        ctype       --  string indicating the cursor type; should be one of
                    the following: 'rectangle', 'ellipse', 'plus',
                    'cross' or 'arrow' (default = 'cross')
        size        --  cursor size in pixels (default = 20)
        colour      --  colour for the cursor (a RGB tuple, e.g. (255,0,0))
                    (default = (0,0,0))
        pw      --  cursor line thickness in pixels (default = 3)
        fill        --  Boolean indicating if cursor should be filled or not;
                    only applies for cursortypes with a body, e.g.
                    'rectangle' (default = True)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a1aa5bd4b2996310dc0a2cb22376e4082}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!update@{update}}
\index{update@{update}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{update()}{update()}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a1aa5bd4b2996310dc0a2cb22376e4082} 
pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+update (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{screen}{, }\item[{}]{gazepos}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Adds the cursor to specified screen; does NOT directly update
        the display
        
        arguments
        screen  --  a libscreen.Screen instance
        gazepos --  current gaze position (a (x,y) tuple)
        
        returns
        screen  --  same Screen as was used as an input, but with the
                addition of a cursor at the gaze position
\end{DoxyVerb}
 

\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a92d666a3104e65d1e87b58bdace85014}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!colour@{colour}}
\index{colour@{colour}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{colour}{colour}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a92d666a3104e65d1e87b58bdace85014} 
pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+colour = colour}

\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a456dbbd0cccf0f25761a653d326c59bf}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!ctype@{ctype}}
\index{ctype@{ctype}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{ctype}{ctype}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a456dbbd0cccf0f25761a653d326c59bf} 
\mbox{\hyperlink{namespacepygaze_1_1py3compat_a00268eef6a7a5c7241ae0072047d8171}{str}} pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+ctype = ctype}

\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a8c6021b00bbd74d3750f9f50c2762585}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!fill@{fill}}
\index{fill@{fill}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{fill}{fill}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a8c6021b00bbd74d3750f9f50c2762585} 
pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+fill = fill}

\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f88fe671701946728c81310fce9c93b}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!pw@{pw}}
\index{pw@{pw}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{pw}{pw}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f88fe671701946728c81310fce9c93b} 
pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+pw = pw}

\Hypertarget{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f67f4cb0b53174b305cab719667f071}\index{pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}!size@{size}}
\index{size@{size}!pygaze.plugins.gazecursor.GazeCursor@{pygaze.plugins.gazecursor.GazeCursor}}
\doxysubsubsection{\texorpdfstring{size}{size}}
{\footnotesize\ttfamily \label{classpygaze_1_1plugins_1_1gazecursor_1_1_gaze_cursor_a3f67f4cb0b53174b305cab719667f071} 
tuple pygaze.\+plugins.\+gazecursor.\+Gaze\+Cursor.\+size = (int(size), int(size))}



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