sigonasr2
/
jinput2.10
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
The future is now. Read Hardware inputs from devices plugged into a computer, cross-platform!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
19 Commits
1 Branch
3 Tags
3.1 MiB
 
 
 
 
Tag: Branch: Tree: a11708955c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a11708955c'
${ noResults }
jinput2.10/docs/net/java/games/input/Controller.html

480 lines
18 KiB
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Wed Jun 08 18:29:23 UTC 2022 -->
<title>Controller (jinput API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-06-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Controller (jinput API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Controller.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">net.java.games.input</a></div>
<h2 title="Interface Controller" class="title">Interface Controller</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractController.html" title="class in net.java.games.input">AbstractController</a></code>, <code><a href="Keyboard.html" title="class in net.java.games.input">Keyboard</a></code>, <code><a href="LinuxCombinedController.html" title="class in net.java.games.input">LinuxCombinedController</a></code>, <code><a href="Mouse.html" title="class in net.java.games.input">Mouse</a></code>, <code><a href="WinTabDevice.html" title="class in net.java.games.input">WinTabDevice</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Controller</span></pre>
<div class="block">A Controller represents a physical device, such as a keyboard, mouse,
or joystick, or a logical grouping of related controls, such as a button
pad or mouse ball. A controller can be composed of multiple controllers.
For example, the ball of a mouse and its buttons are two separate
controllers.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a></span></code></th>
<td class="colLast">
<div class="block">Common controller port types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a></span></code></th>
<td class="colLast">
<div class="block">Types of controller objects.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponent(net.java.games.input.Component.Identifier)">getComponent</a></span>&#8203;(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Returns a single axis based on its type, or null
if no axis with the specified type could be found.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="Component.html" title="interface in net.java.games.input">Component</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponents()">getComponents</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the components on this controller, in order of assignment priority.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Controller.html" title="interface in net.java.games.input">Controller</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getControllers()">getControllers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the controllers connected to make up this controller, or
an empty array if this controller contains no child controllers.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="EventQueue.html" title="class in net.java.games.input">EventQueue</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventQueue()">getEventQueue</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the device event queue</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a human-readable name for this Controller.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPortNumber()">getPortNumber</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the zero-based port number for this Controller.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPortType()">getPortType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the port type for this Controller.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRumblers()">getRumblers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the rumblers for sending feedback to this controller, or an
empty array if there are no rumblers on this controller.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of the Controller.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#poll()">poll</a></span>()</code></th>
<td class="colLast">
<div class="block">Polls axes for data.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventQueueSize(int)">setEventQueueSize</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Initialized the controller event queue to a new size.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getControllers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getControllers</h4>
<pre class="methodSignature"><a href="Controller.html" title="interface in net.java.games.input">Controller</a>[]&nbsp;getControllers()</pre>
<div class="block">Returns the controllers connected to make up this controller, or
an empty array if this controller contains no child controllers.
The objects in the array are returned in order of assignment priority
(primary stick, secondary buttons, etc.).</div>
</li>
</ul>
<a id="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature"><a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a>&nbsp;getType()</pre>
<div class="block">Returns the type of the Controller.</div>
</li>
</ul>
<a id="getComponents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponents</h4>
<pre class="methodSignature"><a href="Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;getComponents()</pre>
<div class="block">Returns the components on this controller, in order of assignment priority.
For example, the button controller on a mouse returns an array containing
the primary or leftmost mouse button, followed by the secondary or
rightmost mouse button (if present), followed by the middle mouse button
(if present).
The array returned is an empty array if this controller contains no components
(such as a logical grouping of child controllers).</div>
</li>
</ul>
<a id="getComponent(net.java.games.input.Component.Identifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponent</h4>
<pre class="methodSignature"><a href="Component.html" title="interface in net.java.games.input">Component</a>&nbsp;getComponent&#8203;(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</pre>
<div class="block">Returns a single axis based on its type, or null
if no axis with the specified type could be found.</div>
</li>
</ul>
<a id="getRumblers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRumblers</h4>
<pre class="methodSignature"><a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;getRumblers()</pre>
<div class="block">Returns the rumblers for sending feedback to this controller, or an
empty array if there are no rumblers on this controller.</div>
</li>
</ul>
<a id="poll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre class="methodSignature">boolean&nbsp;poll()</pre>
<div class="block">Polls axes for data. Returns false if the controller is no longer valid.
Polling reflects the current state of the device when polled.</div>
</li>
</ul>
<a id="setEventQueueSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEventQueueSize</h4>
<pre class="methodSignature">void&nbsp;setEventQueueSize&#8203;(int&nbsp;size)</pre>
<div class="block">Initialized the controller event queue to a new size. Existing events
in the queue are lost.</div>
</li>
</ul>
<a id="getEventQueue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventQueue</h4>
<pre class="methodSignature"><a href="EventQueue.html" title="class in net.java.games.input">EventQueue</a>&nbsp;getEventQueue()</pre>
<div class="block">Get the device event queue</div>
</li>
</ul>
<a id="getPortType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPortType</h4>
<pre class="methodSignature"><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a>&nbsp;getPortType()</pre>
<div class="block">Returns the port type for this Controller.</div>
</li>
</ul>
<a id="getPortNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPortNumber</h4>
<pre class="methodSignature">int&nbsp;getPortNumber()</pre>
<div class="block">Returns the zero-based port number for this Controller.</div>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">java.lang.String&nbsp;getName()</pre>
<div class="block">Returns a human-readable name for this Controller.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Controller.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>