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.
34 Commits
1 Branch
3 Tags
3.1 MiB
Tag: Branch: Tree: df2d8030e8
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'df2d8030e8'
${ noResults }
jinput2.10/docs/net/java/games/input/AbstractController.html

472 lines
35 KiB
Raw Normal View History Unescape

Built a javadoc as well.
3 years ago
<!DOCTYPE HTML>
<html lang="en">
<head>
Include specific information about the equality comparison for Abstract Controllers. Abstract controllers are now returned through the event.
3 years ago
<!-- Generated by javadoc (17) on Wed Jun 22 19:30:51 UTC 2022 -->
Built a javadoc as well.
3 years ago
<title>AbstractController (jinput API)</title>
Correct the location of the forked project in javadocs
3 years ago
<meta name="viewport" content="width=device-width, initial-scale=1">
Built a javadoc as well.
3 years ago
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Correct the location of the forked project in javadocs
3 years ago
<meta name="dc.created" content="2022-06-22">
<meta name="description" content="declaration: package: net.java.games.input, class: AbstractController">
<meta name="generator" content="javadoc/ClassWriterImpl">
Built a javadoc as well.
3 years ago
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Correct the location of the forked project in javadocs
3 years ago
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
Built a javadoc as well.
3 years ago
<script type="text/javascript" src="../../../../script.js"></script>
Correct the location of the forked project in javadocs
3 years ago
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
Built a javadoc as well.
3 years ago
</head>
Correct the location of the forked project in javadocs
3 years ago
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
Built a javadoc as well.
3 years ago
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
Correct the location of the forked project in javadocs
3 years ago
<div class="flex-box">
<header role="banner" class="flex-header">
Built a javadoc as well.
3 years ago
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
Correct the location of the forked project in javadocs
3 years ago
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
Built a javadoc as well.
3 years ago
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
Correct the location of the forked project in javadocs
3 years ago
<li class="nav-bar-cell1-rev">Class</li>
Built a javadoc as well.
3 years ago
<li><a href="class-use/AbstractController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
Correct the location of the forked project in javadocs
3 years ago
<li><a href="../../../../help-doc.html#class">Help</a></li>
Built a javadoc as well.
3 years ago
</ul>
</div>
Correct the location of the forked project in javadocs
3 years ago
<div class="sub-nav">
Built a javadoc as well.
3 years ago
<div>
Correct the location of the forked project in javadocs
3 years ago
<ul class="sub-nav-list">
Built a javadoc as well.
3 years ago
<li>Summary:&nbsp;</li>
Correct the location of the forked project in javadocs
3 years ago
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
Built a javadoc as well.
3 years ago
<li>Field&nbsp;|&nbsp;</li>
Correct the location of the forked project in javadocs
3 years ago
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
Built a javadoc as well.
3 years ago
</ul>
Correct the location of the forked project in javadocs
3 years ago
<ul class="sub-nav-list">
Built a javadoc as well.
3 years ago
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
Correct the location of the forked project in javadocs
3 years ago
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
Built a javadoc as well.
3 years ago
</ul>
</div>
Correct the location of the forked project in javadocs
3 years ago
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
Built a javadoc as well.
3 years ago
</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
Built a javadoc as well.
3 years ago
</header>
Correct the location of the forked project in javadocs
3 years ago
<div class="flex-content">
Built a javadoc as well.
3 years ago
<main role="main">
Correct the location of the forked project in javadocs
3 years ago
<!-- ======== START OF CLASS DATA ======== -->
Built a javadoc as well.
3 years ago
<div class="header">
Correct the location of the forked project in javadocs
3 years ago
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">net.java.games.input</a></div>
<h1 title="Class AbstractController" class="title">Class AbstractController</h1>
Built a javadoc as well.
3 years ago
</div>
Correct the location of the forked project in javadocs
3 years ago
<div class="inheritance" title="Inheritance Tree"><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">net.java.games.input.AbstractController</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
Built a javadoc as well.
3 years ago
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractController</span>
<span class="extends-implements">extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="Controller.html" title="interface in net.java.games.input">Controller</a></span></div>
Built a javadoc as well.
3 years ago
<div class="block">An AbstractController is a skeleton implementation of a controller that
contains a fixed number of axes, controllers, and rumblers.</div>
Correct the location of the forked project in javadocs
3 years ago
</section>
<section class="summary">
<ul class="summary-list">
Built a javadoc as well.
3 years ago
<!-- ======== NESTED CLASS SUMMARY ======== -->
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-net.java.games.input.Controller">Nested classes/interfaces inherited from interface&nbsp;net.java.games.input.<a href="Controller.html" title="interface in net.java.games.input">Controller</a></h2>
<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></div>
Built a javadoc as well.
3 years ago
</section>
Correct the location of the forked project in javadocs
3 years ago
</li>
Built a javadoc as well.
3 years ago
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,net.java.games.input.Component%5B%5D,net.java.games.input.AbstractController%5B%5D,net.java.games.input.Rumbler%5B%5D)" class="member-name-link">AbstractController</a><wbr>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;components,
<a href="AbstractController.html" title="class in net.java.games.input">AbstractController</a>[]&nbsp;children,
<a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;rumblers)</code></div>
<div class="col-last even-row-color">
Built a javadoc as well.
3 years ago
<div class="block">Protected constructor for a controller containing the specified
axes, child controllers, and rumblers</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
</div>
Built a javadoc as well.
3 years ago
</section>
Correct the location of the forked project in javadocs
3 years ago
</li>
Built a javadoc as well.
3 years ago
<!-- ========== METHOD SUMMARY =========== -->
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</code></div>
Include specific information about the equality comparison for Abstract Controllers. Abstract controllers are now returned through the event.
3 years ago
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Overwritten to specifically calculate if this controller matches another controller.</div>
</div>
Correct the location of the forked project in javadocs
3 years ago
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="Component.html" title="interface in net.java.games.input">Component</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponent(net.java.games.input.Component.Identifier)" class="member-name-link">getComponent</a><wbr>(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns a single component based on its identifier, or null
if no component with the specified type could be found.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="Component.html" title="interface in net.java.games.input">Component</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponents()" class="member-name-link">getComponents</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns the components on this controller, in order of assignment priority.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="AbstractController.html" title="class in net.java.games.input">AbstractController</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getControllers()" class="member-name-link">getControllers</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns the controllers connected to make up this controller, or
an empty array if this controller contains no child controllers.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="EventQueue.html" title="class in net.java.games.input">EventQueue</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEventQueue()" class="member-name-link">getEventQueue</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Get the device event queue</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns a human-readable name for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNextDeviceEvent(net.java.games.input.Event)" class="member-name-link">getNextDeviceEvent</a><wbr>(<a href="Event.html" title="class in net.java.games.input">Event</a>&nbsp;event)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPortNumber()" class="member-name-link">getPortNumber</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns the zero-based port number for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPortType()" class="member-name-link">getPortType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns the port type for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRumblers()" class="member-name-link">getRumblers</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns the type of the Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#poll()" class="member-name-link">poll</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Polls axes for data.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pollDevice()" class="member-name-link">pollDevice</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDeviceEventQueueSize(int)" class="member-name-link">setDeviceEventQueueSize</a><wbr>(int&nbsp;size)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Plugins override this method to adjust their internal event queue size</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEventQueueSize(int)" class="member-name-link">setEventQueueSize</a><wbr>(int&nbsp;size)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Creates a new EventQueue.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Built a javadoc as well.
3 years ago
<div class="block">Returns a non-localized string description of this controller.</div>
Correct the location of the forked project in javadocs
3 years ago
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
Built a javadoc as well.
3 years ago
</section>
</li>
</ul>
Correct the location of the forked project in javadocs
3 years ago
</section>
<section class="details">
<ul class="details-list">
Built a javadoc as well.
3 years ago
<!-- ========= CONSTRUCTOR DETAIL ======== -->
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,net.java.games.input.Component[],net.java.games.input.AbstractController[],net.java.games.input.Rumbler[])">
<h3>AbstractController</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">AbstractController</span><wbr><span class="parameters">(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;components,
<a href="AbstractController.html" title="class in net.java.games.input">AbstractController</a>[]&nbsp;children,
<a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;rumblers)</span></div>
Built a javadoc as well.
3 years ago
<div class="block">Protected constructor for a controller containing the specified
axes, child controllers, and rumblers</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Parameters:</dt>
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
</ul>
</section>
Correct the location of the forked project in javadocs
3 years ago
</li>
Built a javadoc as well.
3 years ago
<!-- ============ METHOD DETAIL ========== -->
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</span></div>
Include specific information about the equality comparison for Abstract Controllers. Abstract controllers are now returned through the event.
3 years ago
<div class="block">Overwritten to specifically calculate if this controller matches another controller.
A controller matches if it is the same type of controller as specified,
regardless of which order it was plugged into a device. Therefore this
cannot be used simply to check if all controllers plugged in match all ports
as two controllers of the same type i.e. Two XBox One controllers would
both be considered equal.
Keep this in mind when doing equality comparisons with other controllers.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getControllers()">
<h3>getControllers</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="AbstractController.html" title="class in net.java.games.input">AbstractController</a>[]</span>&nbsp;<span class="element-name">getControllers</span>()</div>
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getControllers()">getControllers</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getComponents()">
<h3>getComponents</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="Component.html" title="interface in net.java.games.input">Component</a>[]</span>&nbsp;<span class="element-name">getComponents</span>()</div>
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getComponents()">getComponents</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getComponent(net.java.games.input.Component.Identifier)">
<h3>getComponent</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="Component.html" title="interface in net.java.games.input">Component</a></span>&nbsp;<span class="element-name">getComponent</span><wbr><span class="parameters">(<a href="Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</span></div>
Built a javadoc as well.
3 years ago
<div class="block">Returns a single component based on its identifier, or null
if no component with the specified type could be found.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getComponent(net.java.games.input.Component.Identifier)">getComponent</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getRumblers()">
<h3>getRumblers</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]</span>&nbsp;<span class="element-name">getRumblers</span>()</div>
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getRumblers()">getRumblers</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getPortType()">
<h3>getPortType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Controller.PortType.html" title="class in net.java.games.input">Controller.PortType</a></span>&nbsp;<span class="element-name">getPortType</span>()</div>
Built a javadoc as well.
3 years ago
<div class="block">Returns the port type for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getPortType()">getPortType</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
Correct the location of the forked project in javadocs
3 years ago
<dt>Returns:</dt>
Built a javadoc as well.
3 years ago
<dd>PortType.UNKNOWN by default, can be overridden</dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getPortNumber()">
<h3>getPortNumber</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getPortNumber</span>()</div>
Built a javadoc as well.
3 years ago
<div class="block">Returns the zero-based port number for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getPortNumber()">getPortNumber</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
Correct the location of the forked project in javadocs
3 years ago
<dt>Returns:</dt>
Built a javadoc as well.
3 years ago
<dd>0 by default, can be overridden</dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
Built a javadoc as well.
3 years ago
<div class="block">Returns a human-readable name for this Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
Built a javadoc as well.
3 years ago
<div class="block">Returns a non-localized string description of this controller.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
Built a javadoc as well.
3 years ago
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getType()">
<h3>getType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Controller.Type.html" title="class in net.java.games.input">Controller.Type</a></span>&nbsp;<span class="element-name">getType</span>()</div>
Built a javadoc as well.
3 years ago
<div class="block">Returns the type of the Controller.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getType()">getType</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="setEventQueueSize(int)">
<h3>setEventQueueSize</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setEventQueueSize</span><wbr><span class="parameters">(int&nbsp;size)</span></div>
Built a javadoc as well.
3 years ago
<div class="block">Creates a new EventQueue. Events in old queue are lost.</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#setEventQueueSize(int)">setEventQueueSize</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="setDeviceEventQueueSize(int)">
<h3>setDeviceEventQueueSize</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDeviceEventQueueSize</span><wbr><span class="parameters">(int&nbsp;size)</span>
throws <span class="exceptions"><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
Built a javadoc as well.
3 years ago
<div class="block">Plugins override this method to adjust their internal event queue size</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
Built a javadoc as well.
3 years ago
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getEventQueue()">
<h3>getEventQueue</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="EventQueue.html" title="class in net.java.games.input">EventQueue</a></span>&nbsp;<span class="element-name">getEventQueue</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Controller.html#getEventQueue()">Controller</a></code></span></div>
Built a javadoc as well.
3 years ago
<div class="block">Get the device event queue</div>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#getEventQueue()">getEventQueue</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="getNextDeviceEvent(net.java.games.input.Event)">
<h3>getNextDeviceEvent</h3>
<div class="member-signature"><span class="modifiers">protected abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getNextDeviceEvent</span><wbr><span class="parameters">(<a href="Event.html" title="class in net.java.games.input">Event</a>&nbsp;event)</span>
throws <span class="exceptions"><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
Built a javadoc as well.
3 years ago
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="pollDevice()">
<h3>pollDevice</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">pollDevice</span>()
throws <span class="exceptions"><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
Built a javadoc as well.
3 years ago
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
Correct the location of the forked project in javadocs
3 years ago
<li>
<section class="detail" id="poll()">
<h3>poll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">poll</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Controller.html#poll()">Controller</a></code></span></div>
Built a javadoc as well.
3 years ago
<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>
Correct the location of the forked project in javadocs
3 years ago
<dl class="notes">
<dt>Specified by:</dt>
Built a javadoc as well.
3 years ago
<dd><code><a href="Controller.html#poll()">poll</a></code>&nbsp;in interface&nbsp;<code><a href="Controller.html" title="interface in net.java.games.input">Controller</a></code></dd>
</dl>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
</li>
</ul>
</section>
</li>
</ul>
Correct the location of the forked project in javadocs
3 years ago
</section>
Built a javadoc as well.
3 years ago
<!-- ========= END OF CLASS DATA ========= -->
Correct the location of the forked project in javadocs
3 years ago
</main>
Built a javadoc as well.
3 years ago
</div>
</div>
</body>
</html>