karx/FtcRobotController
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
FtcRobotController/javadoc/org/firstinspires/ftc/teamcode/API.Gamepad.html
Yash Karandikar 90f519cbad Update javadocs
2022-02-15 17:09:58 -06:00

644 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Tue Feb 15 17:09:18 CST 2022 -->
<title>API.Gamepad</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-02-15">
<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="API.Gamepad";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.firstinspires.ftc.teamcode</a></div>
<h2 title="Class API.Gamepad" class="title">Class API.Gamepad</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.firstinspires.ftc.teamcode.API.Gamepad</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="API.html" title="class in org.firstinspires.ftc.teamcode">API</a></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">API.Gamepad</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getA()">getA</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getABXY()">getABXY</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the status of all four buttons, as a 4-bit integer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllButtons()">getAllButtons</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getB()">getB</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getBack()">getBack</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBumpers()">getBumpers</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getDPad()">getDPad</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDPadDown()">getDPadDown</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDPadLeft()">getDPadLeft</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDPadRight()">getDPadRight</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getDPadUp()">getDPadUp</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGuide()">getGuide</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getL3()">getL3</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLB()">getLB</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLeftStickX()">getLeftStickX</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLeftStickY()">getLeftStickY</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLT()">getLT</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMiscButtons()">getMiscButtons</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getR3()">getR3</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRB()">getRB</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRightStickX()">getRightStickX</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRightStickY()">getRightStickY</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRT()">getRT</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStart()">getStart</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStickClicks()">getStickClicks</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getX()">getX</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getY()">getY</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="getLeftStickX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLeftStickX</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getLeftStickX()</pre>
</li>
</ul>
<a id="getLeftStickY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLeftStickY</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getLeftStickY()</pre>
</li>
</ul>
<a id="getRightStickX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRightStickX</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getRightStickX()</pre>
</li>
</ul>
<a id="getRightStickY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRightStickY</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getRightStickY()</pre>
</li>
</ul>
<a id="getA()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getA</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getA()</pre>
</li>
</ul>
<a id="getB()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getB</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getB()</pre>
</li>
</ul>
<a id="getX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getX</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getX()</pre>
</li>
</ul>
<a id="getY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getY</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getY()</pre>
</li>
</ul>
<a id="getABXY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getABXY</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getABXY()</pre>
<div class="block">Returns the status of all four buttons, as a 4-bit integer.
<br>
The four bits are A, B, X, and Y, respectively.
<br>
To get B, do: <code>(abxy &gt;&gt; 2) % 2</code>
<br>
The amount to bitshift is determined its position in the returned number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The status of all four buttons as a 4-bit integer</dd>
</dl>
</li>
</ul>
<a id="getDPadUp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDPadUp</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getDPadUp()</pre>
</li>
</ul>
<a id="getDPadDown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDPadDown</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getDPadDown()</pre>
</li>
</ul>
<a id="getDPadLeft()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDPadLeft</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getDPadLeft()</pre>
</li>
</ul>
<a id="getDPadRight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDPadRight</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getDPadRight()</pre>
</li>
</ul>
<a id="getDPad()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDPad</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getDPad()</pre>
</li>
</ul>
<a id="getLB()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLB</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getLB()</pre>
</li>
</ul>
<a id="getRB()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRB</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getRB()</pre>
</li>
</ul>
<a id="getBumpers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBumpers</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBumpers()</pre>
</li>
</ul>
<a id="getLT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLT</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getLT()</pre>
</li>
</ul>
<a id="getRT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRT</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getRT()</pre>
</li>
</ul>
<a id="getL3()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getL3</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getL3()</pre>
</li>
</ul>
<a id="getR3()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getR3</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getR3()</pre>
</li>
</ul>
<a id="getStickClicks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStickClicks</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getStickClicks()</pre>
</li>
</ul>
<a id="getGuide()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGuide</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getGuide()</pre>
</li>
</ul>
<a id="getStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStart</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getStart()</pre>
</li>
</ul>
<a id="getBack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBack</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getBack()</pre>
</li>
</ul>
<a id="getMiscButtons()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMiscButtons</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMiscButtons()</pre>
</li>
</ul>
<a id="getAllButtons()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAllButtons</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getAllButtons()</pre>
</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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in a new issue View git blame Copy permalink