aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html567
1 files changed, 567 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html
new file mode 100644
index 0000000..45b7a3c
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_cursor_control.html
@@ -0,0 +1,567 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::gui::ICursorControl Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1gui_1_1_i_cursor_control.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::gui::ICursorControl Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::ICursorControl" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Interface to manipulate the mouse cursor.
95 <a href="classirr_1_1gui_1_1_i_cursor_control.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::ICursorControl:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1gui_1_1_i_cursor_control.png" usemap="#irr::gui::ICursorControl_map" alt=""/>
105 <map id="irr::gui::ICursorControl_map" name="irr::gui::ICursorControl_map">
106<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1gui_1_1_i_cursor_control-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a102ff455c70595886281e636ef063d3b">addIcon</a> (const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;icon)
115<dl class="el"><dd class="mdescRight">Add a custom sprite as cursor icon. <a href="#a102ff455c70595886281e636ef063d3b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a3e7c8cb1f03e1ccc31fcc3c30f717762">changeIcon</a> (<a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> iconId, const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;sprite)
116<dl class="el"><dd class="mdescRight">replace a cursor icon. <a href="#a3e7c8cb1f03e1ccc31fcc3c30f717762"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a6c08f4adefe397b8054296151f15f2ad">getActiveIcon</a> () const
117<dl class="el"><dd class="mdescRight">Gets the currently active icon. <a href="#a6c08f4adefe397b8054296151f15f2ad"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a0d0b11d3d3d5d0adb6e0b0de78edd2a8">getPlatformBehavior</a> () const
118<dl class="el"><dd class="mdescRight">Return platform specific behavior. <a href="#a0d0b11d3d3d5d0adb6e0b0de78edd2a8"></a><br/></dl><li>virtual const core::position2d<br class="typebreak"/>
119&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp; <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a65d9f6e734baa02be69b7e9f5fbdd565">getPosition</a> ()=0
120<dl class="el"><dd class="mdescRight">Returns the current position of the mouse cursor. <a href="#a65d9f6e734baa02be69b7e9f5fbdd565"></a><br/></dl><li>virtual core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a8ba1cb0ff11edc5fb32cdadddece09f8">getRelativePosition</a> ()=0
121<dl class="el"><dd class="mdescRight">Returns the current position of the mouse cursor. <a href="#a8ba1cb0ff11edc5fb32cdadddece09f8"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1core.html#ac79bc3704cf28bc1ab72d7cd1cae78d1">core::dimension2di</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ad2c301e1c82366520913c270ef8d738c">getSupportedIconSize</a> () const
122<dl class="el"><dd class="mdescRight">Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work. <a href="#ad2c301e1c82366520913c270ef8d738c"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ae1d1ca4c1c3042388881fabda4e53a42">isVisible</a> () const =0
123<dl class="el"><dd class="mdescRight">Returns if the cursor is currently visible. <a href="#ae1d1ca4c1c3042388881fabda4e53a42"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#af394700d5279b13cc0f2bcdad679469c">setActiveIcon</a> (<a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> iconId)
124<dl class="el"><dd class="mdescRight">Sets the active cursor icon. <a href="#af394700d5279b13cc0f2bcdad679469c"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ad7688bb200945f15877a598e8be53878">setPlatformBehavior</a> (<a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> behavior)
125<dl class="el"><dd class="mdescRight">Set platform specific behavior flags. <a href="#ad7688bb200945f15877a598e8be53878"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a951b5afe97fa21d98ce5360d96314306">setPosition</a> (const core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; &amp;pos)=0
126<dl class="el"><dd class="mdescRight">Sets the new position of the cursor. <a href="#a951b5afe97fa21d98ce5360d96314306"></a><br/></dl><li>virtual void <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
127<dl class="el"><dd class="mdescRight">Sets the new position of the cursor. <a href="#adca41054684f73435c9b045520f7c83b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a421c770ffc494f8f6082a16bef0feed2">setPosition</a> (const core::position2d&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;pos)=0
128<dl class="el"><dd class="mdescRight">Sets the new position of the cursor. <a href="#a421c770ffc494f8f6082a16bef0feed2"></a><br/></dl><li>virtual void <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
129<dl class="el"><dd class="mdescRight">Sets the new position of the cursor. <a href="#a3b0a59608d1d0810079349acfa01a79b"></a><br/></dl><li>virtual void <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>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; *rect=0)=0
130<dl class="el"><dd class="mdescRight">Sets an absolute reference rect for setting and retrieving the cursor position. <a href="#a2a7428ef716a60f8f4b86361a69b8770"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#aceb41d68494e2b2076fbc6949b254c74">setVisible</a> (bool visible)=0
131<dl class="el"><dd class="mdescRight">Changes the visible state of the mouse cursor. <a href="#aceb41d68494e2b2076fbc6949b254c74"></a><br/></dl></ul>
132<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
133<div class="textblock"><p>Interface to manipulate the mouse cursor. </p>
134
135<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00097">97</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
136</div><hr/><h2>Member Function Documentation</h2>
137<a class="anchor" id="a102ff455c70595886281e636ef063d3b"></a><!-- doxytag: member="irr::gui::ICursorControl::addIcon" ref="a102ff455c70595886281e636ef063d3b" args="(const gui::SCursorSprite &amp;icon)" -->
138<div class="memitem">
139<div class="memproto">
140 <table class="memname">
141 <tr>
142 <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> irr::gui::ICursorControl::addIcon </td>
143 <td>(</td>
144 <td class="paramtype">const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;&#160;</td>
145 <td class="paramname"><em>icon</em></td><td>)</td>
146 <td><code> [inline, virtual]</code></td>
147 </tr>
148 </table>
149</div>
150<div class="memdoc">
151
152<p>Add a custom sprite as cursor icon. </p>
153<dl class="return"><dt><b>Returns:</b></dt><dd>Identification for the icon </dd></dl>
154
155<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00166">166</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
156
157<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00023">irr::gui::ECI_NORMAL</a>.</p>
158
159</div>
160</div>
161<a class="anchor" id="a3e7c8cb1f03e1ccc31fcc3c30f717762"></a><!-- doxytag: member="irr::gui::ICursorControl::changeIcon" ref="a3e7c8cb1f03e1ccc31fcc3c30f717762" args="(ECURSOR_ICON iconId, const gui::SCursorSprite &amp;sprite)" -->
162<div class="memitem">
163<div class="memproto">
164 <table class="memname">
165 <tr>
166 <td class="memname">virtual void irr::gui::ICursorControl::changeIcon </td>
167 <td>(</td>
168 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a>&#160;</td>
169 <td class="paramname"><em>iconId</em>, </td>
170 </tr>
171 <tr>
172 <td class="paramkey"></td>
173 <td></td>
174 <td class="paramtype">const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;&#160;</td>
175 <td class="paramname"><em>sprite</em>&#160;</td>
176 </tr>
177 <tr>
178 <td></td>
179 <td>)</td>
180 <td></td><td><code> [inline, virtual]</code></td>
181 </tr>
182 </table>
183</div>
184<div class="memdoc">
185
186<p>replace a cursor icon. </p>
187<p>Changing cursor icons is so far only supported on Win32 and Linux Note that this only changes the icons within your application, system cursors outside your application will not be affected. </p>
188
189<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00173">173</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
190
191</div>
192</div>
193<a class="anchor" id="a6c08f4adefe397b8054296151f15f2ad"></a><!-- doxytag: member="irr::gui::ICursorControl::getActiveIcon" ref="a6c08f4adefe397b8054296151f15f2ad" args="() const " -->
194<div class="memitem">
195<div class="memproto">
196 <table class="memname">
197 <tr>
198 <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> irr::gui::ICursorControl::getActiveIcon </td>
199 <td>(</td>
200 <td class="paramname"></td><td>)</td>
201 <td> const<code> [inline, virtual]</code></td>
202 </tr>
203 </table>
204</div>
205<div class="memdoc">
206
207<p>Gets the currently active icon. </p>
208
209<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00162">162</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
210
211<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00023">irr::gui::ECI_NORMAL</a>.</p>
212
213</div>
214</div>
215<a class="anchor" id="a0d0b11d3d3d5d0adb6e0b0de78edd2a8"></a><!-- doxytag: member="irr::gui::ICursorControl::getPlatformBehavior" ref="a0d0b11d3d3d5d0adb6e0b0de78edd2a8" args="() const " -->
216<div class="memitem">
217<div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> irr::gui::ICursorControl::getPlatformBehavior </td>
221 <td>(</td>
222 <td class="paramname"></td><td>)</td>
223 <td> const<code> [inline, virtual]</code></td>
224 </tr>
225 </table>
226</div>
227<div class="memdoc">
228
229<p>Return platform specific behavior. </p>
230<dl class="return"><dt><b>Returns:</b></dt><dd>Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors. </dd></dl>
231
232<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00184">184</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
233
234<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00085">irr::gui::ECPB_NONE</a>.</p>
235
236</div>
237</div>
238<a class="anchor" id="a65d9f6e734baa02be69b7e9f5fbdd565"></a><!-- doxytag: member="irr::gui::ICursorControl::getPosition" ref="a65d9f6e734baa02be69b7e9f5fbdd565" args="()=0" -->
239<div class="memitem">
240<div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">virtual const core::position2d&lt;<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&gt;&amp; irr::gui::ICursorControl::getPosition </td>
244 <td>(</td>
245 <td class="paramname"></td><td>)</td>
246 <td><code> [pure virtual]</code></td>
247 </tr>
248 </table>
249</div>
250<div class="memdoc">
251
252<p>Returns the current position of the mouse cursor. </p>
253<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>
254
255</div>
256</div>
257<a class="anchor" id="a8ba1cb0ff11edc5fb32cdadddece09f8"></a><!-- doxytag: member="irr::gui::ICursorControl::getRelativePosition" ref="a8ba1cb0ff11edc5fb32cdadddece09f8" args="()=0" -->
258<div class="memitem">
259<div class="memproto">
260 <table class="memname">
261 <tr>
262 <td class="memname">virtual core::position2d&lt;<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&gt; irr::gui::ICursorControl::getRelativePosition </td>
263 <td>(</td>
264 <td class="paramname"></td><td>)</td>
265 <td><code> [pure virtual]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>Returns the current position of the mouse cursor. </p>
272<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>
273
274</div>
275</div>
276<a class="anchor" id="ad2c301e1c82366520913c270ef8d738c"></a><!-- doxytag: member="irr::gui::ICursorControl::getSupportedIconSize" ref="ad2c301e1c82366520913c270ef8d738c" args="() const " -->
277<div class="memitem">
278<div class="memproto">
279 <table class="memname">
280 <tr>
281 <td class="memname">virtual <a class="el" href="namespaceirr_1_1core.html#ac79bc3704cf28bc1ab72d7cd1cae78d1">core::dimension2di</a> irr::gui::ICursorControl::getSupportedIconSize </td>
282 <td>(</td>
283 <td class="paramname"></td><td>)</td>
284 <td> const<code> [inline, virtual]</code></td>
285 </tr>
286 </table>
287</div>
288<div class="memdoc">
289
290<p>Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work. </p>
291
292<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00176">176</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
293
294</div>
295</div>
296<a class="anchor" id="ae1d1ca4c1c3042388881fabda4e53a42"></a><!-- doxytag: member="irr::gui::ICursorControl::isVisible" ref="ae1d1ca4c1c3042388881fabda4e53a42" args="() const =0" -->
297<div class="memitem">
298<div class="memproto">
299 <table class="memname">
300 <tr>
301 <td class="memname">virtual bool irr::gui::ICursorControl::isVisible </td>
302 <td>(</td>
303 <td class="paramname"></td><td>)</td>
304 <td> const<code> [pure virtual]</code></td>
305 </tr>
306 </table>
307</div>
308<div class="memdoc">
309
310<p>Returns if the cursor is currently visible. </p>
311<dl class="return"><dt><b>Returns:</b></dt><dd>True if the cursor is visible, false if not. </dd></dl>
312
313</div>
314</div>
315<a class="anchor" id="af394700d5279b13cc0f2bcdad679469c"></a><!-- doxytag: member="irr::gui::ICursorControl::setActiveIcon" ref="af394700d5279b13cc0f2bcdad679469c" args="(ECURSOR_ICON iconId)" -->
316<div class="memitem">
317<div class="memproto">
318 <table class="memname">
319 <tr>
320 <td class="memname">virtual void irr::gui::ICursorControl::setActiveIcon </td>
321 <td>(</td>
322 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a>&#160;</td>
323 <td class="paramname"><em>iconId</em></td><td>)</td>
324 <td><code> [inline, virtual]</code></td>
325 </tr>
326 </table>
327</div>
328<div class="memdoc">
329
330<p>Sets the active cursor icon. </p>
331<p>Setting cursor icons is so far only supported on Win32 and Linux </p>
332
333<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00159">159</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
334
335</div>
336</div>
337<a class="anchor" id="ad7688bb200945f15877a598e8be53878"></a><!-- doxytag: member="irr::gui::ICursorControl::setPlatformBehavior" ref="ad7688bb200945f15877a598e8be53878" args="(ECURSOR_PLATFORM_BEHAVIOR behavior)" -->
338<div class="memitem">
339<div class="memproto">
340 <table class="memname">
341 <tr>
342 <td class="memname">virtual void irr::gui::ICursorControl::setPlatformBehavior </td>
343 <td>(</td>
344 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a>&#160;</td>
345 <td class="paramname"><em>behavior</em></td><td>)</td>
346 <td><code> [inline, virtual]</code></td>
347 </tr>
348 </table>
349</div>
350<div class="memdoc">
351
352<p>Set platform specific behavior flags. </p>
353
354<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00179">179</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
355
356</div>
357</div>
358<a class="anchor" id="a951b5afe97fa21d98ce5360d96314306"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a951b5afe97fa21d98ce5360d96314306" args="(const core::position2d&lt; f32 &gt; &amp;pos)=0" -->
359<div class="memitem">
360<div class="memproto">
361 <table class="memname">
362 <tr>
363 <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
364 <td>(</td>
365 <td class="paramtype">const core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; &amp;&#160;</td>
366 <td class="paramname"><em>pos</em></td><td>)</td>
367 <td><code> [pure virtual]</code></td>
368 </tr>
369 </table>
370</div>
371<div class="memdoc">
372
373<p>Sets the new position of the cursor. </p>
374<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>
375<dl><dt><b>Parameters:</b></dt><dd>
376 <table class="params">
377 <tr><td class="paramname">pos</td><td>New position of the cursor. </td></tr>
378 </table>
379 </dd>
380</dl>
381
382</div>
383</div>
384<a class="anchor" id="adca41054684f73435c9b045520f7c83b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="adca41054684f73435c9b045520f7c83b" args="(f32 x, f32 y)=0" -->
385<div class="memitem">
386<div class="memproto">
387 <table class="memname">
388 <tr>
389 <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
390 <td>(</td>
391 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
392 <td class="paramname"><em>x</em>, </td>
393 </tr>
394 <tr>
395 <td class="paramkey"></td>
396 <td></td>
397 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
398 <td class="paramname"><em>y</em>&#160;</td>
399 </tr>
400 <tr>
401 <td></td>
402 <td>)</td>
403 <td></td><td><code> [pure virtual]</code></td>
404 </tr>
405 </table>
406</div>
407<div class="memdoc">
408
409<p>Sets the new position of the cursor. </p>
410<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>
411<dl><dt><b>Parameters:</b></dt><dd>
412 <table class="params">
413 <tr><td class="paramname">x</td><td>New x-coord of the cursor. </td></tr>
414 <tr><td class="paramname">y</td><td>New x-coord of the cursor. </td></tr>
415 </table>
416 </dd>
417</dl>
418
419</div>
420</div>
421<a class="anchor" id="a421c770ffc494f8f6082a16bef0feed2"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a421c770ffc494f8f6082a16bef0feed2" args="(const core::position2d&lt; s32 &gt; &amp;pos)=0" -->
422<div class="memitem">
423<div class="memproto">
424 <table class="memname">
425 <tr>
426 <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
427 <td>(</td>
428 <td class="paramtype">const core::position2d&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;&#160;</td>
429 <td class="paramname"><em>pos</em></td><td>)</td>
430 <td><code> [pure virtual]</code></td>
431 </tr>
432 </table>
433</div>
434<div class="memdoc">
435
436<p>Sets the new position of the cursor. </p>
437<dl><dt><b>Parameters:</b></dt><dd>
438 <table class="params">
439 <tr><td class="paramname">pos,:</td><td>New position of the cursor. The coordinates are pixel units. </td></tr>
440 </table>
441 </dd>
442</dl>
443
444</div>
445</div>
446<a class="anchor" id="a3b0a59608d1d0810079349acfa01a79b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a3b0a59608d1d0810079349acfa01a79b" args="(s32 x, s32 y)=0" -->
447<div class="memitem">
448<div class="memproto">
449 <table class="memname">
450 <tr>
451 <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
452 <td>(</td>
453 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
454 <td class="paramname"><em>x</em>, </td>
455 </tr>
456 <tr>
457 <td class="paramkey"></td>
458 <td></td>
459 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
460 <td class="paramname"><em>y</em>&#160;</td>
461 </tr>
462 <tr>
463 <td></td>
464 <td>)</td>
465 <td></td><td><code> [pure virtual]</code></td>
466 </tr>
467 </table>
468</div>
469<div class="memdoc">
470
471<p>Sets the new position of the cursor. </p>
472<dl><dt><b>Parameters:</b></dt><dd>
473 <table class="params">
474 <tr><td class="paramname">x</td><td>New x-coord of the cursor. The coordinates are pixel units. </td></tr>
475 <tr><td class="paramname">y</td><td>New y-coord of the cursor. The coordinates are pixel units. </td></tr>
476 </table>
477 </dd>
478</dl>
479
480</div>
481</div>
482<a class="anchor" id="a2a7428ef716a60f8f4b86361a69b8770"></a><!-- doxytag: member="irr::gui::ICursorControl::setReferenceRect" ref="a2a7428ef716a60f8f4b86361a69b8770" args="(core::rect&lt; s32 &gt; *rect=0)=0" -->
483<div class="memitem">
484<div class="memproto">
485 <table class="memname">
486 <tr>
487 <td class="memname">virtual void irr::gui::ICursorControl::setReferenceRect </td>
488 <td>(</td>
489 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; *&#160;</td>
490 <td class="paramname"><em>rect</em> = <code>0</code></td><td>)</td>
491 <td><code> [pure virtual]</code></td>
492 </tr>
493 </table>
494</div>
495<div class="memdoc">
496
497<p>Sets an absolute reference rect for setting and retrieving the cursor position. </p>
498<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>
499<dl><dt><b>Parameters:</b></dt><dd>
500 <table class="params">
501 <tr><td class="paramname">rect,:</td><td>A pointer to an reference rectangle or 0 to disable the reference rectangle. </td></tr>
502 </table>
503 </dd>
504</dl>
505
506</div>
507</div>
508<a class="anchor" id="aceb41d68494e2b2076fbc6949b254c74"></a><!-- doxytag: member="irr::gui::ICursorControl::setVisible" ref="aceb41d68494e2b2076fbc6949b254c74" args="(bool visible)=0" -->
509<div class="memitem">
510<div class="memproto">
511 <table class="memname">
512 <tr>
513 <td class="memname">virtual void irr::gui::ICursorControl::setVisible </td>
514 <td>(</td>
515 <td class="paramtype">bool&#160;</td>
516 <td class="paramname"><em>visible</em></td><td>)</td>
517 <td><code> [pure virtual]</code></td>
518 </tr>
519 </table>
520</div>
521<div class="memdoc">
522
523<p>Changes the visible state of the mouse cursor. </p>
524<dl><dt><b>Parameters:</b></dt><dd>
525 <table class="params">
526 <tr><td class="paramname">visible,:</td><td>The new visible state. If true, the cursor will be visible, if false, it will be invisible. </td></tr>
527 </table>
528 </dd>
529</dl>
530
531</div>
532</div>
533<hr/>The documentation for this class was generated from the following file:<ul>
534<li><a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a></li>
535</ul>
536</div>
537</div>
538 <div id="nav-path" class="navpath">
539 <ul>
540 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
541 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
542 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html">ICursorControl</a> </li>
543<!-- window showing the filter options -->
544<div id="MSearchSelectWindow"
545 onmouseover="return searchBox.OnSearchSelectShow()"
546 onmouseout="return searchBox.OnSearchSelectHide()"
547 onkeydown="return searchBox.OnSearchSelectKey(event)">
548<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
549
550<!-- iframe showing the search results (closed by default) -->
551<div id="MSearchResultsWindow">
552<iframe src="javascript:void(0)" frameborder="0"
553 name="MSearchResults" id="MSearchResults">
554</iframe>
555</div>
556
557
558 <li class="footer">
559<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
560Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
561<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
562 </ul>
563 </div>
564
565
566</body>
567</html>
generated by cgit v1.1 at 2024-06-27 09:43:41 +0000