wpilib18/java/current/javadoc/edu/wpi/first/wpilibj/Joystick.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 05:22:53 EDT 2017 -->
<title>Joystick (Documentation - Release API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Joystick (Documentation - Release API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":42,"i1":42,"i2":42,"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":42,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/wpilibj/Jaguar.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/Joystick.html" target="_top">Frames</a></li>
<li><a href="Joystick.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.wpi.first.wpilibj</div>
<h2 title="Class Joystick" class="title">Class Joystick</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">edu.wpi.first.wpilibj.GenericHID</a></li>
<li>
<ul class="inheritance">
<li>edu.wpi.first.wpilibj.Joystick</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Joystick</span>
extends <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></pre>
<div class="block">Handle input from standard Joysticks connected to the Driver Station.
<p>This class handles standard input that comes from the Driver Station. Each time a value is
requested the most recent value is returned. There is a single class instance for each joystick
and the mapping of ports to hardware buttons depends on the code in the Driver Station.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a></span></code>
<div class="block">Represents an analog axis on a joystick.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.ButtonType.html" title="enum in edu.wpi.first.wpilibj">Joystick.ButtonType</a></span></code>
<div class="block">Represents a digital button on a joystick.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.edu.wpi.first.wpilibj.GenericHID">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.<a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></h3>
<code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.HIDType.html" title="enum in edu.wpi.first.wpilibj">GenericHID.HIDType</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.RumbleType.html" title="enum in edu.wpi.first.wpilibj">GenericHID.RumbleType</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#Joystick-int-">Joystick</a></span>(int port)</code>
<div class="block">Construct an instance of a joystick.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getAxis-edu.wpi.first.wpilibj.Joystick.AxisType-">getAxis</a></span>(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">Use the more specific axis getter functions.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getAxisChannel-edu.wpi.first.wpilibj.Joystick.AxisType-">getAxisChannel</a></span>(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">Use the more specific axis channel getter functions.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getButton-edu.wpi.first.wpilibj.Joystick.ButtonType-">getButton</a></span>(<a href="../../../../edu/wpi/first/wpilibj/Joystick.ButtonType.html" title="enum in edu.wpi.first.wpilibj">Joystick.ButtonType</a> button)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">Use Button enum values instead of ButtonType.</span></div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getDirectionDegrees--">getDirectionDegrees</a></span>()</code>
<div class="block">Get the direction of the vector formed by the joystick and its origin in degrees.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getDirectionRadians--">getDirectionRadians</a></span>()</code>
<div class="block">Get the direction of the vector formed by the joystick and its origin in radians.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getMagnitude--">getMagnitude</a></span>()</code>
<div class="block">Get the magnitude of the direction vector formed by the joystick's current position relative to
its origin.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getThrottle--">getThrottle</a></span>()</code>
<div class="block">Get the throttle value of the current joystick.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getThrottleChannel--">getThrottleChannel</a></span>()</code>
<div class="block">Get the channel currently associated with the throttle axis.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTop--">getTop</a></span>()</code>
<div class="block">Read the state of the top button on the joystick.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTopPressed--">getTopPressed</a></span>()</code>
<div class="block">Whether the top button was pressed since the last check.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTopReleased--">getTopReleased</a></span>()</code>
<div class="block">Whether the top button was released since the last check.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTrigger--">getTrigger</a></span>()</code>
<div class="block">Read the state of the trigger on the joystick.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTriggerPressed--">getTriggerPressed</a></span>()</code>
<div class="block">Whether the trigger was pressed since the last check.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTriggerReleased--">getTriggerReleased</a></span>()</code>
<div class="block">Whether the trigger was released since the last check.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTwist--">getTwist</a></span>()</code>
<div class="block">Get the twist value of the current joystick.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getTwistChannel--">getTwistChannel</a></span>()</code>
<div class="block">Get the channel currently associated with the twist axis.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getX-edu.wpi.first.wpilibj.GenericHID.Hand-">getX</a></span>(<a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a> hand)</code>
<div class="block">Get the X value of the joystick.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getXChannel--">getXChannel</a></span>()</code>
<div class="block">Get the channel currently associated with the X axis.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getY-edu.wpi.first.wpilibj.GenericHID.Hand-">getY</a></span>(<a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a> hand)</code>
<div class="block">Get the Y value of the joystick.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getYChannel--">getYChannel</a></span>()</code>
<div class="block">Get the channel currently associated with the Y axis.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getZ--">getZ</a></span>()</code>
<div class="block">Get the z position of the HID.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#getZChannel--">getZChannel</a></span>()</code>
<div class="block">Get the channel currently associated with the Z axis.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setAxisChannel-edu.wpi.first.wpilibj.Joystick.AxisType-int-">setAxisChannel</a></span>(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis,
int channel)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">Use the more specific axis channel setter functions.</span></div>
</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setThrottleChannel-int-">setThrottleChannel</a></span>(int channel)</code>
<div class="block">Set the channel associated with the throttle axis.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setTwistChannel-int-">setTwistChannel</a></span>(int channel)</code>
<div class="block">Set the channel associated with the twist axis.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setXChannel-int-">setXChannel</a></span>(int channel)</code>
<div class="block">Set the channel associated with the X axis.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setYChannel-int-">setYChannel</a></span>(int channel)</code>
<div class="block">Set the channel associated with the Y axis.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html#setZChannel-int-">setZChannel</a></span>(int channel)</code>
<div class="block">Set the channel associated with the Z axis.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.edu.wpi.first.wpilibj.GenericHID">
<!-- -->
</a>
<h3>Methods inherited from class edu.wpi.first.wpilibj.<a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></h3>
<code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getAxisCount--">getAxisCount</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getAxisType-int-">getAxisType</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getButtonCount--">getButtonCount</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getName--">getName</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getPort--">getPort</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getPOV--">getPOV</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getPOV-int-">getPOV</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getPOVCount--">getPOVCount</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getRawAxis-int-">getRawAxis</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getRawButton-int-">getRawButton</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getRawButtonPressed-int-">getRawButtonPressed</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getRawButtonReleased-int-">getRawButtonReleased</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getType--">getType</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getX--">getX</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getY--">getY</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#setOutput-int-boolean-">setOutput</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#setOutputs-int-">setOutputs</a>, <a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#setRumble-edu.wpi.first.wpilibj.GenericHID.RumbleType-double-">setRumble</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Joystick-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Joystick</h4>
<pre>public Joystick(int port)</pre>
<div class="block">Construct an instance of a joystick. The joystick index is the USB port on the drivers
station.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - The port on the Driver Station that the joystick is plugged into.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setXChannel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXChannel</h4>
<pre>public void setXChannel(int channel)</pre>
<div class="block">Set the channel associated with the X axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="setYChannel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setYChannel</h4>
<pre>public void setYChannel(int channel)</pre>
<div class="block">Set the channel associated with the Y axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="setZChannel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setZChannel</h4>
<pre>public void setZChannel(int channel)</pre>
<div class="block">Set the channel associated with the Z axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="setThrottleChannel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThrottleChannel</h4>
<pre>public void setThrottleChannel(int channel)</pre>
<div class="block">Set the channel associated with the throttle axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="setTwistChannel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTwistChannel</h4>
<pre>public void setTwistChannel(int channel)</pre>
<div class="block">Set the channel associated with the twist axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="setAxisChannel-edu.wpi.first.wpilibj.Joystick.AxisType-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAxisChannel</h4>
<pre>@Deprecated
public void setAxisChannel(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis,
int channel)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use the more specific axis channel setter functions.</span></div>
<div class="block">Set the channel associated with a specified axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>axis</code> - The axis to set the channel for.</dd>
<dd><code>channel</code> - The channel to set the axis to.</dd>
</dl>
</li>
</ul>
<a name="getXChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXChannel</h4>
<pre>public int getXChannel()</pre>
<div class="block">Get the channel currently associated with the X axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getYChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYChannel</h4>
<pre>public int getYChannel()</pre>
<div class="block">Get the channel currently associated with the Y axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getZChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZChannel</h4>
<pre>public int getZChannel()</pre>
<div class="block">Get the channel currently associated with the Z axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getTwistChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTwistChannel</h4>
<pre>public int getTwistChannel()</pre>
<div class="block">Get the channel currently associated with the twist axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getThrottleChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrottleChannel</h4>
<pre>public int getThrottleChannel()</pre>
<div class="block">Get the channel currently associated with the throttle axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getAxisChannel-edu.wpi.first.wpilibj.Joystick.AxisType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAxisChannel</h4>
<pre>@Deprecated
public int getAxisChannel(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use the more specific axis channel getter functions.</span></div>
<div class="block">Get the channel currently associated with the specified axis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>axis</code> - The axis to look up the channel for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The channel for the axis.</dd>
</dl>
</li>
</ul>
<a name="getX-edu.wpi.first.wpilibj.GenericHID.Hand-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getX</h4>
<pre>public final double getX(<a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a> hand)</pre>
<div class="block">Get the X value of the joystick. This depends on the mapping of the joystick connected to the
current port.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getX-edu.wpi.first.wpilibj.GenericHID.Hand-">getX</a></code> in class <code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hand</code> - Unused</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The X value of the joystick.</dd>
</dl>
</li>
</ul>
<a name="getY-edu.wpi.first.wpilibj.GenericHID.Hand-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getY</h4>
<pre>public final double getY(<a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a> hand)</pre>
<div class="block">Get the Y value of the joystick. This depends on the mapping of the joystick connected to the
current port.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html#getY-edu.wpi.first.wpilibj.GenericHID.Hand-">getY</a></code> in class <code><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hand</code> - Unused</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Y value of the joystick.</dd>
</dl>
</li>
</ul>
<a name="getZ--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZ</h4>
<pre>public double getZ()</pre>
<div class="block">Get the z position of the HID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the z position</dd>
</dl>
</li>
</ul>
<a name="getTwist--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTwist</h4>
<pre>public double getTwist()</pre>
<div class="block">Get the twist value of the current joystick. This depends on the mapping of the joystick
connected to the current port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Twist value of the joystick.</dd>
</dl>
</li>
</ul>
<a name="getThrottle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrottle</h4>
<pre>public double getThrottle()</pre>
<div class="block">Get the throttle value of the current joystick. This depends on the mapping of the joystick
connected to the current port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Throttle value of the joystick.</dd>
</dl>
</li>
</ul>
<a name="getAxis-edu.wpi.first.wpilibj.Joystick.AxisType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAxis</h4>
<pre>@Deprecated
public double getAxis(<a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a> axis)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use the more specific axis getter functions.</span></div>
<div class="block">For the current joystick, return the axis determined by the argument.
<p>This is for cases where the joystick axis is returned programmatically, otherwise one of the
previous functions would be preferable (for example getX()).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>axis</code> - The axis to read.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the axis.</dd>
</dl>
</li>
</ul>
<a name="getTrigger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrigger</h4>
<pre>public boolean getTrigger()</pre>
<div class="block">Read the state of the trigger on the joystick.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state of the trigger.</dd>
</dl>
</li>
</ul>
<a name="getTriggerPressed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTriggerPressed</h4>
<pre>public boolean getTriggerPressed()</pre>
<div class="block">Whether the trigger was pressed since the last check.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the button was pressed since the last check.</dd>
</dl>
</li>
</ul>
<a name="getTriggerReleased--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTriggerReleased</h4>
<pre>public boolean getTriggerReleased()</pre>
<div class="block">Whether the trigger was released since the last check.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the button was released since the last check.</dd>
</dl>
</li>
</ul>
<a name="getTop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTop</h4>
<pre>public boolean getTop()</pre>
<div class="block">Read the state of the top button on the joystick.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state of the top button.</dd>
</dl>
</li>
</ul>
<a name="getTopPressed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopPressed</h4>
<pre>public boolean getTopPressed()</pre>
<div class="block">Whether the top button was pressed since the last check.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the button was pressed since the last check.</dd>
</dl>
</li>
</ul>
<a name="getTopReleased--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopReleased</h4>
<pre>public boolean getTopReleased()</pre>
<div class="block">Whether the top button was released since the last check.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the button was released since the last check.</dd>
</dl>
</li>
</ul>
<a name="getButton-edu.wpi.first.wpilibj.Joystick.ButtonType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getButton</h4>
<pre>@Deprecated
public boolean getButton(<a href="../../../../edu/wpi/first/wpilibj/Joystick.ButtonType.html" title="enum in edu.wpi.first.wpilibj">Joystick.ButtonType</a> button)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use Button enum values instead of ButtonType.</span></div>
<div class="block">Get buttons based on an enumerated type.
<p>The button type will be looked up in the list of buttons and then read.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>button</code> - The type of button to read.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state of the button.</dd>
</dl>
</li>
</ul>
<a name="getMagnitude--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMagnitude</h4>
<pre>public double getMagnitude()</pre>
<div class="block">Get the magnitude of the direction vector formed by the joystick's current position relative to
its origin.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The magnitude of the direction vector</dd>
</dl>
</li>
</ul>
<a name="getDirectionRadians--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectionRadians</h4>
<pre>public double getDirectionRadians()</pre>
<div class="block">Get the direction of the vector formed by the joystick and its origin in radians.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The direction of the vector in radians</dd>
</dl>
</li>
</ul>
<a name="getDirectionDegrees--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDirectionDegrees</h4>
<pre>public double getDirectionDegrees()</pre>
<div class="block">Get the direction of the vector formed by the joystick and its origin in degrees.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The direction of the vector in degrees</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/wpilibj/Jaguar.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/Joystick.html" target="_top">Frames</a></li>
<li><a href="Joystick.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>