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.
673 lines
28 KiB
673 lines
28 KiB
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.13) on Wed Jun 08 18:29:23 UTC 2022 -->
|
|
<title>AbstractController (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="AbstractController (jinput API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/AbstractController.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 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: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">net.java.games.input</a></div>
|
|
<h2 title="Class AbstractController" class="title">Class AbstractController</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>net.java.games.input.AbstractController</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><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 abstract class <span class="typeNameLabel">AbstractController</span>
|
|
extends java.lang.Object
|
|
implements <a href="Controller.html" title="interface in net.java.games.input">Controller</a></pre>
|
|
<div class="block">An AbstractController is a skeleton implementation of a controller that
|
|
contains a fixed number of axes, controllers, and rumblers.</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>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="nested.classes.inherited.from.class.net.java.games.input.Controller">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested classes/interfaces inherited from interface net.java.games.input.<a href="Controller.html" title="interface in net.java.games.input">Controller</a></h3>
|
|
<code><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a>, <a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier</th>
|
|
<th class="colSecond" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected </code></td>
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,net.java.games.input.Component%5B%5D,net.java.games.input.Controller%5B%5D,net.java.games.input.Rumbler%5B%5D)">AbstractController</a></span>​(java.lang.String name,
|
|
<a href="Component.html" title="interface in net.java.games.input">Component</a>[] components,
|
|
<a href="Controller.html" title="interface in net.java.games.input">Controller</a>[] children,
|
|
<a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[] rumblers)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Protected constructor for a controller containing the specified
|
|
axes, child controllers, and rumblers</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"> </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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>​(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a> id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns a single component based on its identifier, or null
|
|
if no component 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>protected abstract boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextDeviceEvent(net.java.games.input.Event)">getNextDeviceEvent</a></span>​(<a href="Event.html" title="class in net.java.games.input">Event</a> event)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<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="i7" class="rowColor">
|
|
<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="i8" class="altColor">
|
|
<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="i9" class="rowColor">
|
|
<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="i10" class="altColor">
|
|
<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="i11" class="rowColor">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pollDevice()">pollDevice</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeviceEventQueueSize(int)">setDeviceEventQueueSize</a></span>​(int size)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Plugins override this method to adjust their internal event queue size</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventQueueSize(int)">setEventQueueSize</a></span>​(int size)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new EventQueue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns a non-localized string description of this controller.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>(java.lang.String,net.java.games.input.Component[],net.java.games.input.Controller[],net.java.games.input.Rumbler[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>AbstractController</h4>
|
|
<pre>protected AbstractController​(java.lang.String name,
|
|
<a href="Component.html" title="interface in net.java.games.input">Component</a>[] components,
|
|
<a href="Controller.html" title="interface in net.java.games.input">Controller</a>[] children,
|
|
<a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[] rumblers)</pre>
|
|
<div class="block">Protected constructor for a controller containing the specified
|
|
axes, child controllers, and rumblers</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - name for the controller</dd>
|
|
<dd><code>components</code> - components for the controller</dd>
|
|
<dd><code>children</code> - child controllers for the controller</dd>
|
|
<dd><code>rumblers</code> - rumblers for the controller</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ 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">public final <a href="Controller.html" title="interface in net.java.games.input">Controller</a>[] 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>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getControllers()">getControllers</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getComponents()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getComponents</h4>
|
|
<pre class="methodSignature">public final <a href="Component.html" title="interface in net.java.games.input">Component</a>[] 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>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getComponents()">getComponents</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getComponent(net.java.games.input.Component.Identifier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getComponent</h4>
|
|
<pre class="methodSignature">public final <a href="Component.html" title="interface in net.java.games.input">Component</a> getComponent​(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a> id)</pre>
|
|
<div class="block">Returns a single component based on its identifier, or null
|
|
if no component with the specified type could be found.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getComponent(net.java.games.input.Component.Identifier)">getComponent</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRumblers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRumblers</h4>
|
|
<pre class="methodSignature">public final <a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[] 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>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getRumblers()">getRumblers</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getPortType()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPortType</h4>
|
|
<pre class="methodSignature">public <a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a> getPortType()</pre>
|
|
<div class="block">Returns the port type for this Controller.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getPortType()">getPortType</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>PortType.UNKNOWN by default, can be overridden</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getPortNumber()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPortNumber</h4>
|
|
<pre class="methodSignature">public int getPortNumber()</pre>
|
|
<div class="block">Returns the zero-based port number for this Controller.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getPortNumber()">getPortNumber</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>0 by default, can be overridden</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre class="methodSignature">public final java.lang.String getName()</pre>
|
|
<div class="block">Returns a human-readable name for this Controller.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getName()">getName</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="toString()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>toString</h4>
|
|
<pre class="methodSignature">public java.lang.String toString()</pre>
|
|
<div class="block">Returns a non-localized string description of this controller.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getType()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getType</h4>
|
|
<pre class="methodSignature">public <a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a> getType()</pre>
|
|
<div class="block">Returns the type of the Controller.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getType()">getType</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setEventQueueSize(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setEventQueueSize</h4>
|
|
<pre class="methodSignature">public final void setEventQueueSize​(int size)</pre>
|
|
<div class="block">Creates a new EventQueue. Events in old queue are lost.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#setEventQueueSize(int)">setEventQueueSize</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="setDeviceEventQueueSize(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDeviceEventQueueSize</h4>
|
|
<pre class="methodSignature">protected void setDeviceEventQueueSize​(int size)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Plugins override this method to adjust their internal event queue size</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getEventQueue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEventQueue</h4>
|
|
<pre class="methodSignature">public final <a href="EventQueue.html" title="class in net.java.games.input">EventQueue</a> getEventQueue()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Controller.html#getEventQueue()">Controller</a></code></span></div>
|
|
<div class="block">Get the device event queue</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#getEventQueue()">getEventQueue</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getNextDeviceEvent(net.java.games.input.Event)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextDeviceEvent</h4>
|
|
<pre class="methodSignature">protected abstract boolean getNextDeviceEvent​(<a href="Event.html" title="class in net.java.games.input">Event</a> event)
|
|
throws java.io.IOException</pre>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="pollDevice()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>pollDevice</h4>
|
|
<pre class="methodSignature">protected void pollDevice()
|
|
throws java.io.IOException</pre>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="poll()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>poll</h4>
|
|
<pre class="methodSignature">public boolean poll()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Controller.html#poll()">Controller</a></code></span></div>
|
|
<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>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Controller.html#poll()">poll</a></code> in interface <code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
|
|
</dl>
|
|
</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/AbstractController.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 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: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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>
|
|
|