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

526 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>MovementAPI</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="MovementAPI";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 MovementAPI" class="title">Class MovementAPI</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.firstinspires.ftc.teamcode.MovementAPI</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">MovementAPI</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.firstinspires.ftc.teamcode.API,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor)">MovementAPI</a></span>&#8203;(<a href="API.html" title="class in org.firstinspires.ftc.teamcode">API</a>&nbsp;api,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_fl,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_fr,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_bl,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_br)</code></th>
<td class="colLast">
<div class="block">Initializes the API</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.firstinspires.ftc.teamcode.API,org.firstinspires.ftc.teamcode.GameMotors)">MovementAPI</a></span>&#8203;(<a href="API.html" title="class in org.firstinspires.ftc.teamcode">API</a>&nbsp;api,
<a href="GameMotors.html" title="class in org.firstinspires.ftc.teamcode">GameMotors</a>&nbsp;motors)</code></th>
<td class="colLast">
<div class="block">Initializes the API with the motors in the GameMotor enum</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">&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><a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBL()">getBL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBR()">getBR</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFL()">getFL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFR()">getFR</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#move(double,double)">move</a></span>&#8203;(double&nbsp;direction,
double&nbsp;speed)</code></th>
<td class="colLast">
<div class="block">Moves the robot in a given direction with a given speed</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#move(double,double,boolean)">move</a></span>&#8203;(double&nbsp;direction,
double&nbsp;speed,
boolean&nbsp;verbose)</code></th>
<td class="colLast">
<div class="block">Moves the robot in a given direction with a given speed</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#move(double,double,double,double)">move</a></span>&#8203;(double&nbsp;powerY,
double&nbsp;powerX,
double&nbsp;turn,
double&nbsp;speed)</code></th>
<td class="colLast">
<div class="block">Moves the robot given the speed to move forward/back and left/right</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#move(double,double,double,double,boolean)">move</a></span>&#8203;(double&nbsp;powerY,
double&nbsp;powerX,
double&nbsp;turn,
double&nbsp;speed,
boolean&nbsp;verbose)</code></th>
<td class="colLast">
<div class="block">Moves the robot given the speed to move forward/back and left/right</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFlipped(boolean)">setFlipped</a></span>&#8203;(boolean&nbsp;flipped)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">
<div class="block">Stops the robot</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.firstinspires.ftc.teamcode.API,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor,org.firstinspires.ftc.teamcode.API.Motor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MovementAPI</h4>
<pre>public&nbsp;MovementAPI&#8203;(<a href="API.html" title="class in org.firstinspires.ftc.teamcode">API</a>&nbsp;api,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_fl,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_fr,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_bl,
<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;_br)</pre>
<div class="block">Initializes the API</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>_fl</code> - the front-left wheel</dd>
<dd><code>_fr</code> - the front-right wheel</dd>
<dd><code>_bl</code> - the back-left wheel</dd>
<dd><code>_br</code> - the back-right wheel</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.firstinspires.ftc.teamcode.API,org.firstinspires.ftc.teamcode.GameMotors)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MovementAPI</h4>
<pre>public&nbsp;MovementAPI&#8203;(<a href="API.html" title="class in org.firstinspires.ftc.teamcode">API</a>&nbsp;api,
<a href="GameMotors.html" title="class in org.firstinspires.ftc.teamcode">GameMotors</a>&nbsp;motors)</pre>
<div class="block">Initializes the API with the motors in the GameMotor enum</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getFL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFL</h4>
<pre class="methodSignature">public&nbsp;<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;getFL()</pre>
</li>
</ul>
<a id="getFR()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFR</h4>
<pre class="methodSignature">public&nbsp;<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;getFR()</pre>
</li>
</ul>
<a id="getBL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBL</h4>
<pre class="methodSignature">public&nbsp;<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;getBL()</pre>
</li>
</ul>
<a id="getBR()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBR</h4>
<pre class="methodSignature">public&nbsp;<a href="API.Motor.html" title="class in org.firstinspires.ftc.teamcode">API.Motor</a>&nbsp;getBR()</pre>
</li>
</ul>
<a id="setFlipped(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlipped</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFlipped&#8203;(boolean&nbsp;flipped)</pre>
</li>
</ul>
<a id="move(double,double,double,double,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>move</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;move&#8203;(double&nbsp;powerY,
double&nbsp;powerX,
double&nbsp;turn,
double&nbsp;speed,
boolean&nbsp;verbose)</pre>
<div class="block">Moves the robot given the speed to move forward/back and left/right</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>powerY</code> - the speed to move forward/back, -1 to 1, positive being forward</dd>
<dd><code>powerX</code> - the speed to move left/right, -1 to 1, positive being to the right</dd>
<dd><code>turn</code> - the speed to turn at, -1 to 1, positive being clockwise</dd>
<dd><code>speed</code> - a multiplier on the final speed</dd>
<dd><code>verbose</code> - whether or not to log extra data to telemetry</dd>
</dl>
</li>
</ul>
<a id="move(double,double,double,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>move</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;move&#8203;(double&nbsp;powerY,
double&nbsp;powerX,
double&nbsp;turn,
double&nbsp;speed)</pre>
<div class="block">Moves the robot given the speed to move forward/back and left/right</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>powerY</code> - the speed to move forward/back, -1 to 1, positive being forward</dd>
<dd><code>powerX</code> - the speed to move left/right, -1 to 1, positive being to the right</dd>
<dd><code>turn</code> - the speed to turn at, -1 to 1, positive being clockwise</dd>
<dd><code>speed</code> - a multiplier on the final speed</dd>
</dl>
</li>
</ul>
<a id="move(double,double,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>move</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;move&#8203;(double&nbsp;direction,
double&nbsp;speed,
boolean&nbsp;verbose)</pre>
<div class="block">Moves the robot in a given direction with a given speed</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>direction</code> - the direction to move in, in degrees, with positive being left of forward</dd>
<dd><code>speed</code> - the speed to move at</dd>
<dd><code>verbose</code> - whether or not to log extra data to telemetry</dd>
</dl>
</li>
</ul>
<a id="move(double,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>move</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;move&#8203;(double&nbsp;direction,
double&nbsp;speed)</pre>
<div class="block">Moves the robot in a given direction with a given speed</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>direction</code> - the direction to move in, in degrees, with positive being left of forward</dd>
<dd><code>speed</code> - the speed to move at</dd>
</dl>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
<div class="block">Stops the robot</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="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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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