aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_joystick_event.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_joystick_event.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_joystick_event.html299
1 files changed, 299 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_joystick_event.html b/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_joystick_event.html
new file mode 100644
index 0000000..6c06a17
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/structirr_1_1_s_event_1_1_s_joystick_event.html
@@ -0,0 +1,299 @@
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::SJoystickEvent 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_joystick_event.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-types">Public Types</a> &#124;
89<a href="#pub-methods">Public Member Functions</a> &#124;
90<a href="#pub-attribs">Public Attributes</a> </div>
91 <div class="headertitle">
92<div class="title">irr::SEvent::SJoystickEvent Struct Reference</div> </div>
93</div>
94<div class="contents">
95<!-- doxytag: class="irr::SEvent::SJoystickEvent" -->
96<p>A joystick event.
97 <a href="structirr_1_1_s_event_1_1_s_joystick_event.html#details">More...</a></p>
98
99<p><code>#include &lt;<a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>&gt;</code></p>
100
101<p><a href="structirr_1_1_s_event_1_1_s_joystick_event-members.html">List of all members.</a></p>
102<h2><a name="pub-types"></a>
103Public Types</h2>
104<ul>
105<li>enum { <br/>
106&#160;&#160;<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71adde1bff7510f76b3fd2955a5cfda32e3">NUMBER_OF_BUTTONS</a> = 32,
107<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71a636599ff015889eb57338dc0ee126f98">AXIS_X</a> = 0,
108<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71ab4e23f6901d2f4c65e5898250b37dce2">AXIS_Y</a>,
109<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71ac5a3ec3e27ed268695c1c56972df0933">AXIS_Z</a>,
110<br/>
111&#160;&#160;<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71ad3c6da87eec4ee8c8552bb685c53d1e5">AXIS_R</a>,
112<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71aa0071bdf7ce1a4e1fb50dc85dd8c143e">AXIS_U</a>,
113<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71a2114f66a2b79961807a8063230d05edc">AXIS_V</a>,
114<a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a2b0fac734e2cb4a5700ebadb68e5ef71a6fb67d57cfd88f4ea168bdc8372b531b">NUMBER_OF_AXES</a>
115<br/>
116 }
117</ul>
118<h2><a name="pub-methods"></a>
119Public Member Functions</h2>
120<ul>
121<li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#adac7656dc2bc1fedab52d7f84ce52872">IsButtonPressed</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> button) const
122<dl class="el"><dd class="mdescRight">A helper function to check if a button is pressed. <a href="#adac7656dc2bc1fedab52d7f84ce52872"></a><br/></dl></ul>
123<h2><a name="pub-attribs"></a>
124Public Attributes</h2>
125<ul>
126<li><a class="el" href="namespaceirr.html#a43ace0af066371ac0862bac3f7314220">s16</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a1ad2615ffdd8de01b93414228ac3a2d9">Axis</a> [NUMBER_OF_AXES]
127<li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a4fd74c22d62c1613405dc3191ccc5b7c">ButtonStates</a>
128<li><a class="el" href="namespaceirr.html#a646874f69af8ff87fc10201b0254a761">u8</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a04424b44a1c3370263afb3af501cae44">Joystick</a>
129<dl class="el"><dd class="mdescRight">The ID of the joystick which generated this event. <a href="#a04424b44a1c3370263afb3af501cae44"></a><br/></dl><li><a class="el" href="namespaceirr.html#ae9f8ec82692ad3b83c21f555bfa70bcc">u16</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#af30285332d154507b9752ffde3f6bf84">POV</a>
130</ul>
131<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
132<div class="textblock"><p>A joystick event. </p>
133<p>Unlike other events, joystick events represent the result of polling each connected joystick once per run() of the device. Joystick events will not be generated by default. If joystick support is available for the active device, _IRR_COMPILE_WITH_JOYSTICK_EVENTS_ is defined, and <a class="el" href="classirr_1_1_irrlicht_device.html#af06f8d2c4fdffd1f879e46685bcbc6e3">irr::IrrlichtDevice::activateJoysticks()</a> has been called, an event of this type will be generated once per joystick per <a class="el" href="classirr_1_1_irrlicht_device.html#a0489f8151dc43f6f41503ffb5a160b35">IrrlichtDevice::run()</a> regardless of whether the state of the joystick has actually changed. </p>
134
135<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00342">342</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
136</div><hr/><h2>Member Enumeration Documentation</h2>
137<a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::@2" ref="a2b0fac734e2cb4a5700ebadb68e5ef71" args="" -->
138<div class="memitem">
139<div class="memproto">
140 <table class="memname">
141 <tr>
142 <td class="memname">anonymous enum</td>
143 </tr>
144 </table>
145</div>
146<div class="memdoc">
147<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
148<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71adde1bff7510f76b3fd2955a5cfda32e3"></a><!-- doxytag: member="NUMBER_OF_BUTTONS" ref="a2b0fac734e2cb4a5700ebadb68e5ef71adde1bff7510f76b3fd2955a5cfda32e3" args="" -->NUMBER_OF_BUTTONS</em>&nbsp;</td><td>
149</td></tr>
150<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71a636599ff015889eb57338dc0ee126f98"></a><!-- doxytag: member="AXIS_X" ref="a2b0fac734e2cb4a5700ebadb68e5ef71a636599ff015889eb57338dc0ee126f98" args="" -->AXIS_X</em>&nbsp;</td><td>
151</td></tr>
152<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71ab4e23f6901d2f4c65e5898250b37dce2"></a><!-- doxytag: member="AXIS_Y" ref="a2b0fac734e2cb4a5700ebadb68e5ef71ab4e23f6901d2f4c65e5898250b37dce2" args="" -->AXIS_Y</em>&nbsp;</td><td>
153</td></tr>
154<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71ac5a3ec3e27ed268695c1c56972df0933"></a><!-- doxytag: member="AXIS_Z" ref="a2b0fac734e2cb4a5700ebadb68e5ef71ac5a3ec3e27ed268695c1c56972df0933" args="" -->AXIS_Z</em>&nbsp;</td><td>
155</td></tr>
156<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71ad3c6da87eec4ee8c8552bb685c53d1e5"></a><!-- doxytag: member="AXIS_R" ref="a2b0fac734e2cb4a5700ebadb68e5ef71ad3c6da87eec4ee8c8552bb685c53d1e5" args="" -->AXIS_R</em>&nbsp;</td><td>
157</td></tr>
158<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71aa0071bdf7ce1a4e1fb50dc85dd8c143e"></a><!-- doxytag: member="AXIS_U" ref="a2b0fac734e2cb4a5700ebadb68e5ef71aa0071bdf7ce1a4e1fb50dc85dd8c143e" args="" -->AXIS_U</em>&nbsp;</td><td>
159</td></tr>
160<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71a2114f66a2b79961807a8063230d05edc"></a><!-- doxytag: member="AXIS_V" ref="a2b0fac734e2cb4a5700ebadb68e5ef71a2114f66a2b79961807a8063230d05edc" args="" -->AXIS_V</em>&nbsp;</td><td>
161</td></tr>
162<tr><td valign="top"><em><a class="anchor" id="a2b0fac734e2cb4a5700ebadb68e5ef71a6fb67d57cfd88f4ea168bdc8372b531b"></a><!-- doxytag: member="NUMBER_OF_AXES" ref="a2b0fac734e2cb4a5700ebadb68e5ef71a6fb67d57cfd88f4ea168bdc8372b531b" args="" -->NUMBER_OF_AXES</em>&nbsp;</td><td>
163</td></tr>
164</table>
165</dd>
166</dl>
167
168<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00344">344</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
169
170</div>
171</div>
172<hr/><h2>Member Function Documentation</h2>
173<a class="anchor" id="adac7656dc2bc1fedab52d7f84ce52872"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::IsButtonPressed" ref="adac7656dc2bc1fedab52d7f84ce52872" args="(u32 button) const " -->
174<div class="memitem">
175<div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname">bool irr::SEvent::SJoystickEvent::IsButtonPressed </td>
179 <td>(</td>
180 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
181 <td class="paramname"><em>button</em></td><td>)</td>
182 <td> const<code> [inline]</code></td>
183 </tr>
184 </table>
185</div>
186<div class="memdoc">
187
188<p>A helper function to check if a button is pressed. </p>
189
190<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00384">384</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
191
192<p>References <a class="el" href="_i_event_receiver_8h_source.html#l00359">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00346">NUMBER_OF_BUTTONS</a>.</p>
193
194</div>
195</div>
196<hr/><h2>Member Data Documentation</h2>
197<a class="anchor" id="a1ad2615ffdd8de01b93414228ac3a2d9"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::Axis" ref="a1ad2615ffdd8de01b93414228ac3a2d9" args="[NUMBER_OF_AXES]" -->
198<div class="memitem">
199<div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname"><a class="el" href="namespaceirr.html#a43ace0af066371ac0862bac3f7314220">s16</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a1ad2615ffdd8de01b93414228ac3a2d9">irr::SEvent::SJoystickEvent::Axis</a>[NUMBER_OF_AXES]</td>
203 </tr>
204 </table>
205</div>
206<div class="memdoc">
207<p>For AXIS_X, AXIS_Y, AXIS_Z, AXIS_R, AXIS_U and AXIS_V Values are in the range -32768 to 32767, with 0 representing the center position. You will receive the raw value from the joystick, and so will usually want to implement a dead zone around the center of the range. Axes not supported by this joystick will always have a value of 0. On Linux, POV hats are represented as axes, usually the last two active axis. </p>
208
209<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00369">369</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
210
211</div>
212</div>
213<a class="anchor" id="a4fd74c22d62c1613405dc3191ccc5b7c"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::ButtonStates" ref="a4fd74c22d62c1613405dc3191ccc5b7c" args="" -->
214<div class="memitem">
215<div class="memproto">
216 <table class="memname">
217 <tr>
218 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a4fd74c22d62c1613405dc3191ccc5b7c">irr::SEvent::SJoystickEvent::ButtonStates</a></td>
219 </tr>
220 </table>
221</div>
222<div class="memdoc">
223<p>A bitmap of button states. You can use <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#adac7656dc2bc1fedab52d7f84ce52872" title="A helper function to check if a button is pressed.">IsButtonPressed()</a> to ( check the state of each button from 0 to (NUMBER_OF_BUTTONS - 1) </p>
224
225<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00359">359</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
226
227<p>Referenced by <a class="el" href="_i_event_receiver_8h_source.html#l00384">IsButtonPressed()</a>.</p>
228
229</div>
230</div>
231<a class="anchor" id="a04424b44a1c3370263afb3af501cae44"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::Joystick" ref="a04424b44a1c3370263afb3af501cae44" args="" -->
232<div class="memitem">
233<div class="memproto">
234 <table class="memname">
235 <tr>
236 <td class="memname"><a class="el" href="namespaceirr.html#a646874f69af8ff87fc10201b0254a761">u8</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#a04424b44a1c3370263afb3af501cae44">irr::SEvent::SJoystickEvent::Joystick</a></td>
237 </tr>
238 </table>
239</div>
240<div class="memdoc">
241
242<p>The ID of the joystick which generated this event. </p>
243<p>This is an internal Irrlicht index; it does not map directly to any particular hardware joystick. </p>
244
245<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00381">381</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
246
247</div>
248</div>
249<a class="anchor" id="af30285332d154507b9752ffde3f6bf84"></a><!-- doxytag: member="irr::SEvent::SJoystickEvent::POV" ref="af30285332d154507b9752ffde3f6bf84" args="" -->
250<div class="memitem">
251<div class="memproto">
252 <table class="memname">
253 <tr>
254 <td class="memname"><a class="el" href="namespaceirr.html#ae9f8ec82692ad3b83c21f555bfa70bcc">u16</a> <a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html#af30285332d154507b9752ffde3f6bf84">irr::SEvent::SJoystickEvent::POV</a></td>
255 </tr>
256 </table>
257</div>
258<div class="memdoc">
259<p>The POV represents the angle of the POV hat in degrees * 100, from 0 to 35,900. A value of 65535 indicates that the POV hat is centered (or not present). This value is only supported on Windows. On Linux, the POV hat will be sent as 2 axes instead. </p>
260
261<p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00376">376</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p>
262
263</div>
264</div>
265<hr/>The documentation for this struct was generated from the following file:<ul>
266<li><a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a></li>
267</ul>
268</div>
269</div>
270 <div id="nav-path" class="navpath">
271 <ul>
272 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
273 <li class="navelem"><a class="el" href="structirr_1_1_s_event.html">SEvent</a> </li>
274 <li class="navelem"><a class="el" href="structirr_1_1_s_event_1_1_s_joystick_event.html">SJoystickEvent</a> </li>
275<!-- window showing the filter options -->
276<div id="MSearchSelectWindow"
277 onmouseover="return searchBox.OnSearchSelectShow()"
278 onmouseout="return searchBox.OnSearchSelectHide()"
279 onkeydown="return searchBox.OnSearchSelectKey(event)">
280<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>
281
282<!-- iframe showing the search results (closed by default) -->
283<div id="MSearchResultsWindow">
284<iframe src="javascript:void(0)" frameborder="0"
285 name="MSearchResults" id="MSearchResults">
286</iframe>
287</div>
288
289
290 <li class="footer">
291<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
292Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
293<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
294 </ul>
295 </div>
296
297
298</body>
299</html>
generated by cgit v1.1 at 2024-05-15 18:59:47 +0000