aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html346
1 files changed, 346 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html b/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html
new file mode 100644
index 0000000..1eedc65
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_mouse_input.html
@@ -0,0 +1,346 @@
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::SEvent::SMouseInput Struct 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('structirr_1_1_s_event_1_1_s_mouse_input.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> &#124;
89<a href="#pub-attribs">Public Attributes</a> </div>
90 <div class="headertitle">
91<div class="title">irr::SEvent::SMouseInput Struct Reference</div> </div>
92</div>
93<div class="contents">
94<!-- doxytag: class="irr::SEvent::SMouseInput" -->
95<p>Any kind of mouse event.
96 <a href="structirr_1_1_s_event_1_1_s_mouse_input.html#details">More...</a></p>
97
98<p><code>#include &lt;<a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>&gt;</code></p>
99
100<p><a href="structirr_1_1_s_event_1_1_s_mouse_input-members.html">List of all members.</a></p>
101<h2><a name="pub-methods"></a>
102Public Member Functions</h2>
103<ul>
104<li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a7c3fec25a36a285f46897a6350c8fc24">isLeftPressed</a> () const
105<dl class="el"><dd class="mdescRight">Is the left button pressed down? <a href="#a7c3fec25a36a285f46897a6350c8fc24"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a1a93f70157bfad1c15ae2a7c10745432">isMiddlePressed</a> () const
106<dl class="el"><dd class="mdescRight">Is the middle button pressed down? <a href="#a1a93f70157bfad1c15ae2a7c10745432"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a6dc635dc9841455ab2233f469c24c6e9">isRightPressed</a> () const
107<dl class="el"><dd class="mdescRight">Is the right button pressed down? <a href="#a6dc635dc9841455ab2233f469c24c6e9"></a><br/></dl></ul>
108<h2><a name="pub-attribs"></a>
109Public Attributes</h2>
110<ul>
111<li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#af2f4e21a673879db7f89335ccdc3efdd">ButtonStates</a>
112<li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a2b0cf7a5d52c4489dbfc739fe62aa354">Control</a>:1
113<dl class="el"><dd class="mdescRight">True if ctrl was also pressed. <a href="#a2b0cf7a5d52c4489dbfc739fe62aa354"></a><br/></dl><li><a class="el" href="namespaceirr.html#a2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#adc389bcfee10b86dc5c6d2f39c4f5acd">Event</a>
114<dl class="el"><dd class="mdescRight">Type of mouse event. <a href="#adc389bcfee10b86dc5c6d2f39c4f5acd"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#afa1f5dca47f1378ccc27157ba225feda">Shift</a>:1
115<dl class="el"><dd class="mdescRight">True if shift was also pressed. <a href="#afa1f5dca47f1378ccc27157ba225feda"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a0821c616196a7ffcc574e68c060b6d18">Wheel</a>
116<dl class="el"><dd class="mdescRight">mouse wheel delta, often 1.0 or -1.0, but can have other values &lt; 0.f or &gt; 0.f; <a href="#a0821c616196a7ffcc574e68c060b6d18"></a><br/></dl><li><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a8d1f2d8281cc8982eff089b580f58e86">X</a>
117<dl class="el"><dd class="mdescRight">X position of mouse cursor. <a href="#a8d1f2d8281cc8982eff089b580f58e86"></a><br/></dl><li><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a274d984da2c05655589bd13c4e71e5a3">Y</a>
118<dl class="el"><dd class="mdescRight">Y position of mouse cursor. <a href="#a274d984da2c05655589bd13c4e71e5a3"></a><br/></dl></ul>
119<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
120<div class="textblock"><p>Any kind of mouse event. </p>
121
122<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00279">279</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
123</div><hr/><h2>Member Function Documentation</h2>
124<a class="anchor" id="a7c3fec25a36a285f46897a6350c8fc24"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isLeftPressed" ref="a7c3fec25a36a285f46897a6350c8fc24" args="() const " -->
125<div class="memitem">
126<div class="memproto">
127 <table class="memname">
128 <tr>
129 <td class="memname">bool irr::SEvent::SMouseInput::isLeftPressed </td>
130 <td>(</td>
131 <td class="paramname"></td><td>)</td>
132 <td> const<code> [inline]</code></td>
133 </tr>
134 </table>
135</div>
136<div class="memdoc">
137
138<p>Is the left button pressed down? </p>
139
140<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00303">303</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
141
142<p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00132">irr::EMBSM_LEFT</a>.</p>
143
144</div>
145</div>
146<a class="anchor" id="a1a93f70157bfad1c15ae2a7c10745432"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isMiddlePressed" ref="a1a93f70157bfad1c15ae2a7c10745432" args="() const " -->
147<div class="memitem">
148<div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname">bool irr::SEvent::SMouseInput::isMiddlePressed </td>
152 <td>(</td>
153 <td class="paramname"></td><td>)</td>
154 <td> const<code> [inline]</code></td>
155 </tr>
156 </table>
157</div>
158<div class="memdoc">
159
160<p>Is the middle button pressed down? </p>
161
162<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00309">309</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
163
164<p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00134">irr::EMBSM_MIDDLE</a>.</p>
165
166</div>
167</div>
168<a class="anchor" id="a6dc635dc9841455ab2233f469c24c6e9"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isRightPressed" ref="a6dc635dc9841455ab2233f469c24c6e9" args="() const " -->
169<div class="memitem">
170<div class="memproto">
171 <table class="memname">
172 <tr>
173 <td class="memname">bool irr::SEvent::SMouseInput::isRightPressed </td>
174 <td>(</td>
175 <td class="paramname"></td><td>)</td>
176 <td> const<code> [inline]</code></td>
177 </tr>
178 </table>
179</div>
180<div class="memdoc">
181
182<p>Is the right button pressed down? </p>
183
184<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00306">306</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
185
186<p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00133">irr::EMBSM_RIGHT</a>.</p>
187
188</div>
189</div>
190<hr/><h2>Member Data Documentation</h2>
191<a class="anchor" id="af2f4e21a673879db7f89335ccdc3efdd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::ButtonStates" ref="af2f4e21a673879db7f89335ccdc3efdd" args="" -->
192<div class="memitem">
193<div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#af2f4e21a673879db7f89335ccdc3efdd">irr::SEvent::SMouseInput::ButtonStates</a></td>
197 </tr>
198 </table>
199</div>
200<div class="memdoc">
201<p>A bitmap of button states. You can use isButtonPressed() to determine if a button is pressed or not. Currently only valid if the event was EMIE_MOUSE_MOVED </p>
202
203<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00300">300</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
204
205<p>Referenced by <a class="el" href="_i_event_receiver_8h_source.html#l00303">isLeftPressed()</a>, <a class="el" href="_i_event_receiver_8h_source.html#l00309">isMiddlePressed()</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00306">isRightPressed()</a>.</p>
206
207</div>
208</div>
209<a class="anchor" id="a2b0cf7a5d52c4489dbfc739fe62aa354"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Control" ref="a2b0cf7a5d52c4489dbfc739fe62aa354" args="" -->
210<div class="memitem">
211<div class="memproto">
212 <table class="memname">
213 <tr>
214 <td class="memname">bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a2b0cf7a5d52c4489dbfc739fe62aa354">irr::SEvent::SMouseInput::Control</a></td>
215 </tr>
216 </table>
217</div>
218<div class="memdoc">
219
220<p>True if ctrl was also pressed. </p>
221
222<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00295">295</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
223
224</div>
225</div>
226<a class="anchor" id="adc389bcfee10b86dc5c6d2f39c4f5acd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Event" ref="adc389bcfee10b86dc5c6d2f39c4f5acd" args="" -->
227<div class="memitem">
228<div class="memproto">
229 <table class="memname">
230 <tr>
231 <td class="memname"><a class="el" href="namespaceirr.html#a2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#adc389bcfee10b86dc5c6d2f39c4f5acd">irr::SEvent::SMouseInput::Event</a></td>
232 </tr>
233 </table>
234</div>
235<div class="memdoc">
236
237<p>Type of mouse event. </p>
238
239<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00312">312</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
240
241</div>
242</div>
243<a class="anchor" id="afa1f5dca47f1378ccc27157ba225feda"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Shift" ref="afa1f5dca47f1378ccc27157ba225feda" args="" -->
244<div class="memitem">
245<div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#afa1f5dca47f1378ccc27157ba225feda">irr::SEvent::SMouseInput::Shift</a></td>
249 </tr>
250 </table>
251</div>
252<div class="memdoc">
253
254<p>True if shift was also pressed. </p>
255
256<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00292">292</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
257
258</div>
259</div>
260<a class="anchor" id="a0821c616196a7ffcc574e68c060b6d18"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Wheel" ref="a0821c616196a7ffcc574e68c060b6d18" args="" -->
261<div class="memitem">
262<div class="memproto">
263 <table class="memname">
264 <tr>
265 <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a0821c616196a7ffcc574e68c060b6d18">irr::SEvent::SMouseInput::Wheel</a></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>mouse wheel delta, often 1.0 or -1.0, but can have other values &lt; 0.f or &gt; 0.f; </p>
272<p>Only valid if event was EMIE_MOUSE_WHEEL </p>
273
274<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00289">289</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
275
276</div>
277</div>
278<a class="anchor" id="a8d1f2d8281cc8982eff089b580f58e86"></a><!-- doxytag: member="irr::SEvent::SMouseInput::X" ref="a8d1f2d8281cc8982eff089b580f58e86" args="" -->
279<div class="memitem">
280<div class="memproto">
281 <table class="memname">
282 <tr>
283 <td class="memname"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a8d1f2d8281cc8982eff089b580f58e86">irr::SEvent::SMouseInput::X</a></td>
284 </tr>
285 </table>
286</div>
287<div class="memdoc">
288
289<p>X position of mouse cursor. </p>
290
291<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00282">282</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
292
293</div>
294</div>
295<a class="anchor" id="a274d984da2c05655589bd13c4e71e5a3"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Y" ref="a274d984da2c05655589bd13c4e71e5a3" args="" -->
296<div class="memitem">
297<div class="memproto">
298 <table class="memname">
299 <tr>
300 <td class="memname"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a274d984da2c05655589bd13c4e71e5a3">irr::SEvent::SMouseInput::Y</a></td>
301 </tr>
302 </table>
303</div>
304<div class="memdoc">
305
306<p>Y position of mouse cursor. </p>
307
308<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00285">285</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
309
310</div>
311</div>
312<hr/>The documentation for this struct was generated from the following file:<ul>
313<li><a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a></li>
314</ul>
315</div>
316</div>
317 <div id="nav-path" class="navpath">
318 <ul>
319 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
320 <li class="navelem"><a class="el" href="structirr_1_1_s_event.html">SEvent</a> </li>
321 <li class="navelem"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html">SMouseInput</a> </li>
322<!-- window showing the filter options -->
323<div id="MSearchSelectWindow"
324 onmouseover="return searchBox.OnSearchSelectShow()"
325 onmouseout="return searchBox.OnSearchSelectHide()"
326 onkeydown="return searchBox.OnSearchSelectKey(event)">
327<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>
328
329<!-- iframe showing the search results (closed by default) -->
330<div id="MSearchResultsWindow">
331<iframe src="javascript:void(0)" frameborder="0"
332 name="MSearchResults" id="MSearchResults">
333</iframe>
334</div>
335
336
337 <li class="footer">
338<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
339Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
340<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
341 </ul>
342 </div>
343
344
345</body>
346</html>