<!DOCTYPE HTML>
< html lang = "en" >
< head >
<!-- Generated by javadoc (17) on Wed Jun 22 19:30:51 UTC 2022 -->
< title > Component (jinput API)< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta name = "dc.created" content = "2022-06-22" >
< meta name = "description" content = "declaration: package: net.java.games.input, interface: Component" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
< 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" >
< script type = "text/javascript" src = "../../../../script.js" > < / script >
< 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 >
< / head >
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
< nav role = "navigation" >
<!-- ========= START OF TOP NAVBAR ======= -->
< 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" >
< li > < a href = "../../../../index.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "nav-bar-cell1-rev" > Class< / li >
< li > < a href = "class-use/Component.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html#class" > Help< / a > < / li >
< / ul >
< / div >
< div class = "sub-nav" >
< div >
< ul class = "sub-nav-list" >
< 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 = "sub-nav-list" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method-detail" > Method< / a > < / li >
< / ul >
< / div >
< 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" >
< / div >
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
< / header >
< div class = "flex-content" >
< main role = "main" >
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > net.java.games.input< / a > < / div >
< h1 title = "Interface Component" class = "title" > Interface Component< / h1 >
< / div >
< section class = "class-description" id = "class-description" >
< dl class = "notes" >
< 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 >
< div class = "type-signature" > < span class = "modifiers" > public interface < / span > < span class = "element-name type-name-label" > Component< / span > < / div >
< 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 >
< / section >
< section class = "summary" >
< ul class = "summary-list" >
<!-- ======== NESTED CLASS SUMMARY ======== -->
< li >
< section class = "nested-class-summary" id = "nested-class-summary" >
< h2 > Nested Class Summary< / h2 >
< div class = "caption" > < span > Nested Classes< / span > < / div >
< div class = "summary-table three-column-summary" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Interface< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color" > < code > static class < / code > < / div >
< div class = "col-second even-row-color" > < code > < a href = "Component.Identifier.html" class = "type-name-link" title = "class in net.java.games.input" > Component.Identifier< / a > < / code > < / div >
< div class = "col-last even-row-color" >
< div class = "block" > Identifiers for different Axes.< / div >
< / div >
< div class = "col-first odd-row-color" > < code > static class < / code > < / div >
< div class = "col-second odd-row-color" > < code > < a href = "Component.POV.html" class = "type-name-link" title = "class in net.java.games.input" > Component.POV< / a > < / code > < / div >
< div class = "col-last odd-row-color" >
< div class = "block" > POV enum for different positions.< / div >
< / div >
< / div >
< / section >
< / li >
<!-- ========== METHOD SUMMARY =========== -->
< 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 > < / 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-tab3" > < code > float< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getDeadZone()" class = "member-name-link" > getDeadZone< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< div class = "block" > Returns the suggested dead zone for this axis.< / div >
< / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "Component.Identifier.html" title = "class in net.java.games.input" > Component.Identifier< / a > < / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getIdentifier()" class = "member-name-link" > getIdentifier< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< div class = "block" > Returns the identifier of the axis.< / div >
< / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < 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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getName()" class = "member-name-link" > getName< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< div class = "block" > Returns a human-readable name for this axis.< / div >
< / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > float< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getPollData()" class = "member-name-link" > getPollData< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< div class = "block" > Returns the data from the last time the control has been polled.< / div >
< / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > boolean< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#isAnalog()" class = "member-name-link" > isAnalog< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< div class = "block" > Returns whether or not the axis is analog, or false if it is digital.< / div >
< / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > boolean< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#isRelative()" class = "member-name-link" > isRelative< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" >
< 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 >
< / div >
< / div >
< / div >
< / div >
< / section >
< / li >
< / ul >
< / section >
< section class = "details" >
< ul class = "details-list" >
<!-- ============ METHOD DETAIL ========== -->
< li >
< section class = "method-details" id = "method-detail" >
< h2 > Method Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "getIdentifier()" >
< h3 > getIdentifier< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "Component.Identifier.html" title = "class in net.java.games.input" > Component.Identifier< / a > < / span > < span class = "element-name" > getIdentifier< / span > ()< / div >
< div class = "block" > Returns the identifier of the axis.< / div >
< / section >
< / li >
< li >
< section class = "detail" id = "isRelative()" >
< h3 > isRelative< / h3 >
< div class = "member-signature" > < span class = "return-type" > boolean< / span > < span class = "element-name" > isRelative< / span > ()< / div >
< 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 >
< / section >
< / li >
< li >
< section class = "detail" id = "isAnalog()" >
< h3 > isAnalog< / h3 >
< div class = "member-signature" > < span class = "return-type" > boolean< / span > < span class = "element-name" > isAnalog< / span > ()< / div >
< div class = "block" > Returns whether or not the axis is analog, or false if it is digital.< / div >
< / section >
< / li >
< li >
< section class = "detail" id = "getDeadZone()" >
< h3 > getDeadZone< / h3 >
< div class = "member-signature" > < span class = "return-type" > float< / span > < span class = "element-name" > getDeadZone< / span > ()< / div >
< 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 class = "notes" >
< dt > See Also:< / dt >
< dd >
< ul class = "see-list" >
< li > < a href = "#getPollData()" > < code > getPollData()< / code > < / a > < / li >
< / ul >
< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "getPollData()" >
< h3 > getPollData< / h3 >
< div class = "member-signature" > < span class = "return-type" > float< / span > < span class = "element-name" > getPollData< / span > ()< / div >
< 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 class = "notes" >
< dt > See Also:< / dt >
< dd >
< ul class = "see-list" >
< li > < a href = "Controller.html#poll()" > < code > Controller.poll()< / code > < / a > < / li >
< / ul >
< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "getName()" >
< h3 > getName< / h3 >
< div class = "member-signature" > < 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 > < span class = "element-name" > getName< / span > ()< / div >
< div class = "block" > Returns a human-readable name for this axis.< / div >
< / section >
< / li >
< / ul >
< / section >
< / li >
< / ul >
< / section >
<!-- ========= END OF CLASS DATA ========= -->
< / main >
< / div >
< / div >
< / body >
< / html >
