backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Input/GamePadState.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

450 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:32 CEST 2013 -->
<title>GamePadState</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GamePadState";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/GamePadState.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Input/GamePadState.html" target="_top">Frames</a></li>
<li><a href="GamePadState.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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">Microsoft.Xna.Framework.Input</div>
<h2 title="Class GamePadState" class="title">Class GamePadState</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../System/ValueType.html" title="class in System">System.ValueType</a></li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.Input.GamePadState</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">GamePadState</span>
extends <a href="../../../../System/ValueType.html" title="class in System">ValueType</a></pre>
<div class="block">Represents specific information about the state of an Xbox 360 Controller, including the current state of buttons and sticks.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input">GamePadButtons</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#Buttons">Buttons</a></strong></code>
<div class="block">Returns a structure that identifies what buttons on the Xbox 360 controller are pressed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input">GamePadDPad</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#DPad">DPad</a></strong></code>
<div class="block">Returns a structure that identifies what directions of the directional pad on the Xbox 360 Controller are pressed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#IsConnected">IsConnected</a></strong></code>
<div class="block">Indicates whether the Xbox 360 Controller is connected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input">GamePadThumbSticks</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#ThumbSticks">ThumbSticks</a></strong></code>
<div class="block">Returns a structure that indicates the position of the Xbox 360 Controller sticks (thumbsticks).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/GamePadTriggers.html" title="class in Microsoft.Xna.Framework.Input">GamePadTriggers</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#Triggers">Triggers</a></strong></code>
<div class="block">Returns a structure that identifies the position of triggers on the Xbox 360 controller.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#GamePadState(Microsoft.Xna.Framework.Input.GamePadThumbSticks, Microsoft.Xna.Framework.Input.GamePadTriggers, Microsoft.Xna.Framework.Input.GamePadButtons, Microsoft.Xna.Framework.Input.GamePadDPad)">GamePadState</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input">GamePadThumbSticks</a>&nbsp;thumbSticks,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadTriggers.html" title="class in Microsoft.Xna.Framework.Input">GamePadTriggers</a>&nbsp;triggers,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input">GamePadButtons</a>&nbsp;buttons,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input">GamePadDPad</a>&nbsp;dPad)</code>
<div class="block">Initializes a new instance of the GamePadState class using the specified GamePadThumbSticks, GamePadTriggers, GamePadButtons, and GamePadDPad.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#GamePadState(Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Vector2, float, float, Microsoft.Xna.Framework.Input.Buttons...)">GamePadState</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a>&nbsp;leftThumbStick,
<a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a>&nbsp;rightThumbStick,
float&nbsp;leftTrigger,
float&nbsp;rightTrigger,
<a href="../../../../Microsoft/Xna/Framework/Input/Buttons.html" title="enum in Microsoft.Xna.Framework.Input">Buttons</a>...&nbsp;buttons)</code>
<div class="block">Initializes a new instance of the GamePadState class with the specified stick, trigger, and button values.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">Returns a value that indicates whether the current instance is equal to a specified object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets the hash code for this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/GamePadState.html#toString()">toString</a></strong>()</code>
<div class="block">Retrieves a string representation of this object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="Buttons">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Buttons</h4>
<pre>public final&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input">GamePadButtons</a> Buttons</pre>
<div class="block">Returns a structure that identifies what buttons on the Xbox 360 controller are pressed. Reference page contains links to related code samples.</div>
</li>
</ul>
<a name="IsConnected">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IsConnected</h4>
<pre>public final&nbsp;boolean IsConnected</pre>
<div class="block">Indicates whether the Xbox 360 Controller is connected. Reference page contains links to related code samples.</div>
</li>
</ul>
<a name="DPad">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DPad</h4>
<pre>public final&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input">GamePadDPad</a> DPad</pre>
<div class="block">Returns a structure that identifies what directions of the directional pad on the Xbox 360 Controller are pressed.</div>
</li>
</ul>
<a name="ThumbSticks">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ThumbSticks</h4>
<pre>public final&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input">GamePadThumbSticks</a> ThumbSticks</pre>
<div class="block">Returns a structure that indicates the position of the Xbox 360 Controller sticks (thumbsticks).</div>
</li>
</ul>
<a name="Triggers">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Triggers</h4>
<pre>public final&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/GamePadTriggers.html" title="class in Microsoft.Xna.Framework.Input">GamePadTriggers</a> Triggers</pre>
<div class="block">Returns a structure that identifies the position of triggers on the Xbox 360 controller.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GamePadState(Microsoft.Xna.Framework.Input.GamePadThumbSticks, Microsoft.Xna.Framework.Input.GamePadTriggers, Microsoft.Xna.Framework.Input.GamePadButtons, Microsoft.Xna.Framework.Input.GamePadDPad)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GamePadState</h4>
<pre>public&nbsp;GamePadState(<a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input">GamePadThumbSticks</a>&nbsp;thumbSticks,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadTriggers.html" title="class in Microsoft.Xna.Framework.Input">GamePadTriggers</a>&nbsp;triggers,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input">GamePadButtons</a>&nbsp;buttons,
<a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input">GamePadDPad</a>&nbsp;dPad)</pre>
<div class="block">Initializes a new instance of the GamePadState class using the specified GamePadThumbSticks, GamePadTriggers, GamePadButtons, and GamePadDPad.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thumbSticks</code> - Initial stick state.</dd><dd><code>triggers</code> - Initial trigger state.</dd><dd><code>buttons</code> - Initial button state.</dd><dd><code>dPad</code> - Initial directional pad state.</dd></dl>
</li>
</ul>
<a name="GamePadState(Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Vector2, float, float, Microsoft.Xna.Framework.Input.Buttons...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GamePadState</h4>
<pre>public&nbsp;GamePadState(<a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a>&nbsp;leftThumbStick,
<a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a>&nbsp;rightThumbStick,
float&nbsp;leftTrigger,
float&nbsp;rightTrigger,
<a href="../../../../Microsoft/Xna/Framework/Input/Buttons.html" title="enum in Microsoft.Xna.Framework.Input">Buttons</a>...&nbsp;buttons)</pre>
<div class="block">Initializes a new instance of the GamePadState class with the specified stick, trigger, and button values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>leftThumbStick</code> - Left stick value. Each axis is clamped between -1.0 and 1.0.</dd><dd><code>rightThumbStick</code> - Right stick value. Each axis is clamped between -1.0 and 1.0.</dd><dd><code>leftTrigger</code> - Left trigger value. This value is clamped between 0.0 and 1.0.</dd><dd><code>rightTrigger</code> - Right trigger value. This value is clamped between 0.0 and 1.0.</dd><dd><code>buttons</code> - Array or parameter list of Buttons to initialize as pressed.</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="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">Returns a value that indicates whether the current instance is equal to a specified object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - Object with which to make the comparison.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the current instance is equal to the specified object; false otherwise.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Gets the hash code for this instance.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Hash code for this object.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Retrieves a string representation of this object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>String representation of this object.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/GamePadState.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Input/GamePadDPad.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Input/GamePadThumbSticks.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Input/GamePadState.html" target="_top">Frames</a></li>
<li><a href="GamePadState.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink