1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>NeL: NLMISC::IInputDevice struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NLMISC::IInputDevice Struct Reference</h1><code>#include <<a class="el" href="a05818.html">input_device.h</a>></code>
<p>
<p>Inheritance diagram for NLMISC::IInputDevice:
<p><center><img src="a03855.png" usemap="#NLMISC::IInputDevice_map" border="0" alt=""></center>
<map name="NLMISC::IInputDevice_map">
<area href="a03854.html" alt="NLMISC::IGameDevice" shape="rect" coords="0,56,163,80">
<area href="a03860.html" alt="NLMISC::IKeyboardDevice" shape="rect" coords="173,56,336,80">
<area href="a03867.html" alt="NLMISC::IMouseDevice" shape="rect" coords="346,56,509,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class that wrap to a device <dl compact><dt><b>Author:</b></dt><dd>Nicolas Vizerie <p>
Nevrax France </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="a05818.html#l00048">48</a> of file <a class="el" href="a05818.html">input_device.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03855.html#NLMISC_1_1IMouseDevicea0">getBufferSize</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer size for this device. <a href="#NLMISC_1_1IMouseDevicea0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03855.html#NLMISC_1_1IMouseDevicea3">setBufferSize</a> (<a class="el" href="a04558.html#a15">uint</a> <a class="el" href="a04223.html#a587">size</a>)=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03855.html#NLMISC_1_1IInputDevicea2">~IInputDevice</a> ()</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="NLMISC_1_1IInputDevicea2" doxytag="NLMISC::IInputDevice::~IInputDevice" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual NLMISC::IInputDevice::~<a class="el" href="a03855.html">IInputDevice</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="a05818.html#l00085">85</a> of file <a class="el" href="a05818.html">input_device.h</a>.
<p>
<div class="fragment"><pre>00085 {};
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_0" doxytag="NLMISC::IInputDevice::begin" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void NLMISC::IInputDevice::begin </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a02479.html">CEventServer</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>server</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
For device server usage : Called at the beginning of each events retrieval. If a device doesn't support buffered datas, the state changes can be directly send to the event server. The default does nothing.
<p>
Definition at line <a class="el" href="a05818.html#l00064">64</a> of file <a class="el" href="a05818.html">input_device.h</a>.
<p>
<div class="fragment"><pre>00064 {}
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="NLMISC_1_1IMouseDevicea0" doxytag="NLMISC::IInputDevice::getBufferSize" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a15">uint</a> NLMISC::IInputDevice::getBufferSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the buffer size for this device.
<p>
</td>
</tr>
</table>
<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_1" doxytag="NLMISC::IInputDevice::poll" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void NLMISC::IInputDevice::poll </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a02669.html">CInputDeviceServer</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>dev</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices. This retrieves messages, but do not process them. </td>
</tr>
</table>
<a class="anchor" name="NLMISC_1_1IMouseDevicea3" doxytag="NLMISC::IInputDevice::setBufferSize" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool NLMISC::IInputDevice::setBufferSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the buffer size for this device (the number of samples it can retains). This return true if the size could be set </td>
</tr>
</table>
<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_2" doxytag="NLMISC::IInputDevice::submit" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void NLMISC::IInputDevice::submit </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a03857.html">IInputDeviceEvent</a> * </td>
<td class="mdname" nowrap> <em>deviceEvent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="a02479.html">CEventServer</a> * </td>
<td class="mdname" nowrap> <em>server</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage </td>
</tr>
</table>
<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_3" doxytag="NLMISC::IInputDevice::transitionOccured" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void NLMISC::IInputDevice::transitionOccured </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a02479.html">CEventServer</a> * </td>
<td class="mdname" nowrap> <em>server</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="a03857.html">IInputDeviceEvent</a> * </td>
<td class="mdname" nowrap> <em>nextMessage</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
For device server usage : Says that the next message is for another device, or that it is the last message that will be received. This allow to pack several messages in one (for example, to sum up mouse moves until a click occurs) The default does nothing. The next message can be used to get a time stamp for example. It may be NULL is no next message is available
<p>
Definition at line <a class="el" href="a05818.html#l00081">81</a> of file <a class="el" href="a05818.html">input_device.h</a>.
<p>
Referenced by <a class="el" href="a05820.html#l00067">NLMISC::CInputDeviceServer::poll()</a>.
<p>
<div class="fragment"><pre>00081 {}
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="a05818.html">input_device.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:46:06 2004 for NeL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.6 </small></address>
</body>
</html>
|
