-
Notifications
You must be signed in to change notification settings - Fork 1
/
IBaseInput.html
355 lines (355 loc) · 14 KB
/
IBaseInput.html
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>IBaseInput (NVList)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IBaseInput (NVList)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../nl/weeaboo/vn/input/IInput.html" title="interface in nl.weeaboo.vn.input"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?nl/weeaboo/vn/input/IBaseInput.html" target="_top">Frames</a></li>
<li><a href="IBaseInput.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">nl.weeaboo.vn.input</div>
<h2 title="Interface IBaseInput" class="title">Interface IBaseInput<K></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Key identifier.</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../nl/weeaboo/vn/input/IInput.html" title="interface in nl.weeaboo.vn.input">IInput</a>, <a href="../../../../nl/weeaboo/vn/input/INativeInput.html" title="interface in nl.weeaboo.vn.input">INativeInput</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IBaseInput<K></span></pre>
<div class="block">Provides access to user-input events.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#clearButtonStates--">clearButtonStates</a></span>()</code>
<div class="block">Reset button press states.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#consumePress-K-">consumePress</a></span>(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button)</code>
<div class="block">Same as <a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#isPressed-K-boolean-"><code>isPressed(Object, boolean)</code></a>, then marks the press as consumed so further calls
return <code>false</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../nl/weeaboo/vn/math/Vec2.html" title="class in nl.weeaboo.vn.math">Vec2</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#getPointerPos-nl.weeaboo.vn.math.Matrix-">getPointerPos</a></span>(<a href="../../../../nl/weeaboo/vn/math/Matrix.html" title="class in nl.weeaboo.vn.math">Matrix</a> transform)</code>
<div class="block">The X/Y-coordinates of the most recent mouse/touch position, transformed by the given transform.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#getPointerScroll--">getPointerScroll</a></span>()</code>
<div class="block">The amount that the mouse scroll wheel was scrolled.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#getPressedTime-K-boolean-">getPressedTime</a></span>(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button,
boolean allowConsumedPress)</code>
<div class="block">Returns the time in milliseconds that the specified button has been continuously held, or <code>0</code> if
that button isn't currently being held.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#isIdle--">isIdle</a></span>()</code>
<div class="block">Returns <code>true</code> if the user hasn't performed any type of input this frame (no button presses, no
mouse/touch events).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#isJustPressed-K-">isJustPressed</a></span>(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button)</code>
<div class="block">Returns <code>true</code> if the specified button got pressed since the last frame.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#isPressed-K-boolean-">isPressed</a></span>(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button,
boolean allowConsumedPress)</code>
<div class="block">Returns <code>true</code> if the specified button is currently pressed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clearButtonStates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearButtonStates</h4>
<pre>void clearButtonStates()</pre>
<div class="block">Reset button press states.</div>
</li>
</ul>
<a name="consumePress-java.lang.Object-">
<!-- -->
</a><a name="consumePress-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumePress</h4>
<pre>boolean consumePress(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button)</pre>
<div class="block">Same as <a href="../../../../nl/weeaboo/vn/input/IBaseInput.html#isPressed-K-boolean-"><code>isPressed(Object, boolean)</code></a>, then marks the press as consumed so further calls
return <code>false</code>.</div>
</li>
</ul>
<a name="isJustPressed-java.lang.Object-">
<!-- -->
</a><a name="isJustPressed-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJustPressed</h4>
<pre>boolean isJustPressed(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button)</pre>
<div class="block">Returns <code>true</code> if the specified button got pressed since the last frame.</div>
</li>
</ul>
<a name="isPressed-java.lang.Object-boolean-">
<!-- -->
</a><a name="isPressed-K-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPressed</h4>
<pre>boolean isPressed(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button,
boolean allowConsumedPress)</pre>
<div class="block">Returns <code>true</code> if the specified button is currently pressed.</div>
</li>
</ul>
<a name="getPressedTime-java.lang.Object-boolean-">
<!-- -->
</a><a name="getPressedTime-K-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPressedTime</h4>
<pre>long getPressedTime(<a href="../../../../nl/weeaboo/vn/input/IBaseInput.html" title="type parameter in IBaseInput">K</a> button,
boolean allowConsumedPress)</pre>
<div class="block">Returns the time in milliseconds that the specified button has been continuously held, or <code>0</code> if
that button isn't currently being held.</div>
</li>
</ul>
<a name="getPointerPos-nl.weeaboo.vn.math.Matrix-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPointerPos</h4>
<pre><a href="../../../../nl/weeaboo/vn/math/Vec2.html" title="class in nl.weeaboo.vn.math">Vec2</a> getPointerPos(<a href="../../../../nl/weeaboo/vn/math/Matrix.html" title="class in nl.weeaboo.vn.math">Matrix</a> transform)</pre>
<div class="block">The X/Y-coordinates of the most recent mouse/touch position, transformed by the given transform.</div>
</li>
</ul>
<a name="getPointerScroll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPointerScroll</h4>
<pre>int getPointerScroll()</pre>
<div class="block">The amount that the mouse scroll wheel was scrolled. Positive values indicate a downward scroll,
negative values an upward scroll.</div>
</li>
</ul>
<a name="isIdle--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isIdle</h4>
<pre>boolean isIdle()</pre>
<div class="block">Returns <code>true</code> if the user hasn't performed any type of input this frame (no button presses, no
mouse/touch events).</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../nl/weeaboo/vn/input/IInput.html" title="interface in nl.weeaboo.vn.input"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?nl/weeaboo/vn/input/IBaseInput.html" target="_top">Frames</a></li>
<li><a href="IBaseInput.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>