<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::gui::ICursorControl Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1gui.html">gui</a>::<a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html">ICursorControl</a>
</div>
<div class="contents">
<h1>irr::gui::ICursorControl Class Reference</h1><!-- doxytag: class="irr::gui::ICursorControl" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
<p>Interface to manipulate the mouse cursor.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for irr::gui::ICursorControl:</div>
<div class="dynsection">
<div class="center">
<img src="classirr_1_1gui_1_1_i_cursor_control.png" usemap="#irr::gui::ICursorControl_map" alt=""/>
<map id="irr::gui::ICursorControl_map" name="irr::gui::ICursorControl_map">
<area href="classirr_1_1_i_reference_counted.html" alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/>
</map>
</div>
</div>
<p><a href="classirr_1_1gui_1_1_i_cursor_control-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const core::position2d<br class="typebreak"/>
< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a65d9f6e734baa02be69b7e9f5fbdd565">getPosition</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current position of the mouse cursor. <a href="#a65d9f6e734baa02be69b7e9f5fbdd565"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual core::position2d< <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a8ba1cb0ff11edc5fb32cdadddece09f8">getRelativePosition</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current position of the mouse cursor. <a href="#a8ba1cb0ff11edc5fb32cdadddece09f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ae1d1ca4c1c3042388881fabda4e53a42">isVisible</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if the cursor is currently visible. <a href="#ae1d1ca4c1c3042388881fabda4e53a42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a3b0a59608d1d0810079349acfa01a79b">setPosition</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> x, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> y)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the new position of the cursor. <a href="#a3b0a59608d1d0810079349acfa01a79b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a421c770ffc494f8f6082a16bef0feed2">setPosition</a> (const core::position2d< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > &pos)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the new position of the cursor. <a href="#a421c770ffc494f8f6082a16bef0feed2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#adca41054684f73435c9b045520f7c83b">setPosition</a> (<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> x, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> y)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the new position of the cursor. <a href="#adca41054684f73435c9b045520f7c83b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a951b5afe97fa21d98ce5360d96314306">setPosition</a> (const core::position2d< <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> > &pos)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the new position of the cursor. <a href="#a951b5afe97fa21d98ce5360d96314306"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a2a7428ef716a60f8f4b86361a69b8770">setReferenceRect</a> (<a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > *rect=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an absolute reference rect for setting and retrieving the cursor position. <a href="#a2a7428ef716a60f8f4b86361a69b8770"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#aceb41d68494e2b2076fbc6949b254c74">setVisible</a> (bool visible)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the visible state of the mouse cursor. <a href="#aceb41d68494e2b2076fbc6949b254c74"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface to manipulate the mouse cursor. </p>
<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00018">18</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a65d9f6e734baa02be69b7e9f5fbdd565"></a><!-- doxytag: member="irr::gui::ICursorControl::getPosition" ref="a65d9f6e734baa02be69b7e9f5fbdd565" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const core::position2d<<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>>& irr::gui::ICursorControl::getPosition </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current position of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the current position of the cursor. The returned position is the position of the mouse cursor in pixel units. </dd></dl>
</div>
</div>
<a class="anchor" id="a8ba1cb0ff11edc5fb32cdadddece09f8"></a><!-- doxytag: member="irr::gui::ICursorControl::getRelativePosition" ref="a8ba1cb0ff11edc5fb32cdadddece09f8" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual core::position2d<<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>> irr::gui::ICursorControl::getRelativePosition </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current position of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the current position of the cursor. The returned position is a value between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1d1ca4c1c3042388881fabda4e53a42"></a><!-- doxytag: member="irr::gui::ICursorControl::isVisible" ref="ae1d1ca4c1c3042388881fabda4e53a42" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::ICursorControl::isVisible </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns if the cursor is currently visible. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the cursor is visible, false if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a3b0a59608d1d0810079349acfa01a79b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a3b0a59608d1d0810079349acfa01a79b" args="(s32 x, s32 y)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the new position of the cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>New x-coord of the cursor. The coordinates are pixel units. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>New y-coord of the cursor. The coordinates are pixel units. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a421c770ffc494f8f6082a16bef0feed2"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a421c770ffc494f8f6082a16bef0feed2" args="(const core::position2d< s32 > &pos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
<td>(</td>
<td class="paramtype">const core::position2d< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > & </td>
<td class="paramname"> <em>pos</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the new position of the cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pos,:</em> </td><td>New position of the cursor. The coordinates are pixel units. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adca41054684f73435c9b045520f7c83b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="adca41054684f73435c9b045520f7c83b" args="(f32 x, f32 y)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the new position of the cursor. </p>
<p>The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>New x-coord of the cursor. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>New x-coord of the cursor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a951b5afe97fa21d98ce5360d96314306"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a951b5afe97fa21d98ce5360d96314306" args="(const core::position2d< f32 > &pos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
<td>(</td>
<td class="paramtype">const core::position2d< <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> > & </td>
<td class="paramname"> <em>pos</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the new position of the cursor. </p>
<p>The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>New position of the cursor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a7428ef716a60f8f4b86361a69b8770"></a><!-- doxytag: member="irr::gui::ICursorControl::setReferenceRect" ref="a2a7428ef716a60f8f4b86361a69b8770" args="(core::rect< s32 > *rect=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setReferenceRect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > * </td>
<td class="paramname"> <em>rect</em> = <code>0</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets an absolute reference rect for setting and retrieving the cursor position. </p>
<p>If this rect is set, the cursor position is not being calculated relative to the rendering window but to this rect. You can set the rect pointer to 0 to disable this feature again. This feature is useful when rendering into parts of foreign windows for example in an editor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rect,:</em> </td><td>A pointer to an reference rectangle or 0 to disable the reference rectangle. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aceb41d68494e2b2076fbc6949b254c74"></a><!-- doxytag: member="irr::gui::ICursorControl::setVisible" ref="aceb41d68494e2b2076fbc6949b254c74" args="(bool visible)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::ICursorControl::setVisible </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>visible</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the visible state of the mouse cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>visible,:</em> </td><td>The new visible state. If true, the cursor will be visible, if false, it will be invisible. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a></li>
</ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Sun Oct 24 12:42:03 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.6.2)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
