<!DOCTYPE HTML>
<!-- NewPage -->
< html lang = "en" >
< head >
<!-- Generated by javadoc (11.0.13) on Wed Jun 08 18:29:23 UTC 2022 -->
< title > Component (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="Component (jinput API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/Component.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 > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a 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 = "Interface Component" class = "title" > Interface Component< / 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 = "AbstractComponent.html" title = "class in net.java.games.input" > AbstractComponent< / a > < / code > , < code > < a href = "LinuxJoystickPOV.html" title = "class in net.java.games.input" > LinuxJoystickPOV< / a > < / code > , < code > < a href = "WinTabButtonComponent.html" title = "class in net.java.games.input" > WinTabButtonComponent< / a > < / code > , < code > < a href = "WinTabComponent.html" title = "class in net.java.games.input" > WinTabComponent< / a > < / code > , < code > < a href = "WinTabCursorComponent.html" title = "class in net.java.games.input" > WinTabCursorComponent< / a > < / code > < / dd >
< / dl >
< hr >
< pre > public interface < span class = "typeNameLabel" > Component< / span > < / pre >
< div class = "block" > An axis is a single button, slider, or dial, which has a single range. An
axis can hold information for motion (linear or rotational), velocity,
force, or acceleration.< / 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" > < / 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 < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "Component.Identifier.html" title = "class in net.java.games.input" > Component.Identifier< / a > < / span > < / code > < / th >
< td class = "colLast" >
< div class = "block" > Identifiers for different Axes.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static class < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "Component.POV.html" title = "class in net.java.games.input" > Component.POV< / a > < / span > < / code > < / th >
< td class = "colLast" >
< div class = "block" > POV enum for different positions.< / 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 > < / 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 > float< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getDeadZone()" > getDeadZone< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Returns the suggested dead zone for this axis.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > < a href = "Component.Identifier.html" title = "class in net.java.games.input" > Component.Identifier< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getIdentifier()" > getIdentifier< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Returns the identifier of the axis.< / div >
< / td >
< / tr >
< tr id = "i2" 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 axis.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > float< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getPollData()" > getPollData< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Returns the data from the last time the control has been polled.< / div >
< / td >
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#isAnalog()" > isAnalog< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Returns whether or not the axis is analog, or false if it is digital.< / div >
< / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#isRelative()" > isRelative< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Returns < code > true< / code > if data returned from < code > poll< / code >
is relative to the last call, or < code > false< / code > if data
is absolute.< / 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 = "getIdentifier()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getIdentifier< / h4 >
< pre class = "methodSignature" > < a href = "Component.Identifier.html" title = "class in net.java.games.input" > Component.Identifier< / a > getIdentifier()< / pre >
< div class = "block" > Returns the identifier of the axis.< / div >
< / li >
< / ul >
< a id = "isRelative()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isRelative< / h4 >
< pre class = "methodSignature" > boolean isRelative()< / pre >
< div class = "block" > Returns < code > true< / code > if data returned from < code > poll< / code >
is relative to the last call, or < code > false< / code > if data
is absolute.< / div >
< / li >
< / ul >
< a id = "isAnalog()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isAnalog< / h4 >
< pre class = "methodSignature" > boolean isAnalog()< / pre >
< div class = "block" > Returns whether or not the axis is analog, or false if it is digital.< / div >
< / li >
< / ul >
< a id = "getDeadZone()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getDeadZone< / h4 >
< pre class = "methodSignature" > float getDeadZone()< / pre >
< div class = "block" > Returns the suggested dead zone for this axis. Dead zone is the
amount polled data can vary before considered a significant change
in value. An application can safely ignore changes less than this
value in the positive or negative direction.< / div >
< dl >
< dt > < span class = "seeLabel" > See Also:< / span > < / dt >
< dd > < a href = "#getPollData()" > < code > getPollData()< / code > < / a > < / dd >
< / dl >
< / li >
< / ul >
< a id = "getPollData()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getPollData< / h4 >
< pre class = "methodSignature" > float getPollData()< / pre >
< div class = "block" > Returns the data from the last time the control has been polled.
If this axis is a button, the value returned will be either 0.0f or 1.0f.
If this axis is normalized, the value returned will be between -1.0f and
1.0f.< / div >
< dl >
< dt > < span class = "seeLabel" > See Also:< / span > < / dt >
< dd > < a href = "Controller.html#poll()" > < code > Controller.poll()< / code > < / a > < / dd >
< / dl >
< / li >
< / ul >
< a id = "getName()" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getName< / h4 >
< pre class = "methodSignature" > java.lang.String getName()< / pre >
< div class = "block" > Returns a human-readable name for this axis.< / 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/Component.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 > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a id = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / nav >
< / footer >
< / body >
< / html >
