classgameplay_1_1_gamepad.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Gamepad Class Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-types">Public Types</a> &#124;
  87. <a href="#pub-methods">Public Member Functions</a> </div>
  88. <div class="headertitle">
  89. <div class="title">gameplay::Gamepad Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <!-- doxytag: class="gameplay::Gamepad" -->
  93. <p><code>#include &lt;Gamepad.h&gt;</code></p>
  94. <p><a href="classgameplay_1_1_gamepad-members.html">List of all members.</a></p>
  95. <table class="memberdecls">
  96. <tr><td colspan="2"><h2><a name="pub-types"></a>
  97. Public Types</h2></td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#ab79068c8eeaa3a4daf6ea1f7a8adc3c9">GamepadEvent</a> { <b>CONNECTED_EVENT</b>,
  99. <b>DISCONNECTED_EVENT</b>
  100. }</td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">ButtonMapping</a> { <br/>
  102. &#160;&#160;<b>BUTTON_A</b>,
  103. <b>BUTTON_B</b>,
  104. <b>BUTTON_X</b>,
  105. <b>BUTTON_Y</b>,
  106. <br/>
  107. &#160;&#160;<b>BUTTON_L1</b>,
  108. <b>BUTTON_L2</b>,
  109. <b>BUTTON_L3</b>,
  110. <b>BUTTON_R1</b>,
  111. <br/>
  112. &#160;&#160;<b>BUTTON_R2</b>,
  113. <b>BUTTON_R3</b>,
  114. <b>BUTTON_UP</b>,
  115. <b>BUTTON_DOWN</b>,
  116. <br/>
  117. &#160;&#160;<b>BUTTON_LEFT</b>,
  118. <b>BUTTON_RIGHT</b>,
  119. <b>BUTTON_MENU1</b>,
  120. <b>BUTTON_MENU2</b>,
  121. <br/>
  122. &#160;&#160;<b>BUTTON_MENU3</b>
  123. <br/>
  124. }</td></tr>
  125. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  126. Public Member Functions</h2></td></tr>
  127. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#a7f292bade95f2d7ee16450b90ce0625d">getButtonCount</a> () const </td></tr>
  128. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#aa69e8bf61d41cd55f55a67a6974c1694">isButtonDown</a> (<a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">ButtonMapping</a> button) const </td></tr>
  129. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#af6b0a3adba913eb7b987e98934016137">getJoystickCount</a> () const </td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#ab3e57827cfdbf0e18d37aa7ae03d452f">getJoystickValues</a> (unsigned int joystickId, <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> *outValues) const </td></tr>
  131. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#aa33cea2b84705953d296b3586a4cdbf6">getTriggerCount</a> () const </td></tr>
  132. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#a7e1b24552efae9bd23cb24bd29a5d157">getTriggerValue</a> (unsigned int triggerId) const </td></tr>
  133. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#aa1f2a111cf6758ec17e51fcc6ba671db">getName</a> () const </td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#aad447cbdd1a03ae1fd27b7d7ac2da17d">isVirtual</a> () const </td></tr>
  135. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_form.html">Form</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#a0b2de80713f58635c141a66717b9683a">getForm</a> () const </td></tr>
  136. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#ad38b2f6bee5c6cdf8a9a4222a84df7c5">update</a> (float elapsedTime)</td></tr>
  137. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_gamepad.html#abf82a1c115c12b76a4078e389b9d27de">draw</a> ()</td></tr>
  138. </table>
  139. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  140. <div class="textblock"><p>Defines a gamepad interface for handling input from joysticks and buttons.</p>
  141. <p>A gamepad can be either physical or virtual. Most platform support up to 4 gamepad controllers connected simulataneously. </p>
  142. </div><hr/><h2>Member Enumeration Documentation</h2>
  143. <a class="anchor" id="a91729957739fbe8a6b88f3e17c2a7ff9"></a><!-- doxytag: member="gameplay::Gamepad::ButtonMapping" ref="a91729957739fbe8a6b88f3e17c2a7ff9" args="" -->
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">enum <a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">gameplay::Gamepad::ButtonMapping</a></td>
  149. </tr>
  150. </table>
  151. </div>
  152. <div class="memdoc">
  153. <p><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> buttons. </p>
  154. </div>
  155. </div>
  156. <a class="anchor" id="ab79068c8eeaa3a4daf6ea1f7a8adc3c9"></a><!-- doxytag: member="gameplay::Gamepad::GamepadEvent" ref="ab79068c8eeaa3a4daf6ea1f7a8adc3c9" args="" -->
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">enum <a class="el" href="classgameplay_1_1_gamepad.html#ab79068c8eeaa3a4daf6ea1f7a8adc3c9">gameplay::Gamepad::GamepadEvent</a></td>
  162. </tr>
  163. </table>
  164. </div>
  165. <div class="memdoc">
  166. <p><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> events. </p>
  167. </div>
  168. </div>
  169. <hr/><h2>Member Function Documentation</h2>
  170. <a class="anchor" id="abf82a1c115c12b76a4078e389b9d27de"></a><!-- doxytag: member="gameplay::Gamepad::draw" ref="abf82a1c115c12b76a4078e389b9d27de" args="()" -->
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#abf82a1c115c12b76a4078e389b9d27de">gameplay::Gamepad::draw</a> </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div>
  182. <div class="memdoc">
  183. <p>Draws the gamepad if it is based on a form and if the form is enabled. </p>
  184. </div>
  185. </div>
  186. <a class="anchor" id="a7f292bade95f2d7ee16450b90ce0625d"></a><!-- doxytag: member="gameplay::Gamepad::getButtonCount" ref="a7f292bade95f2d7ee16450b90ce0625d" args="() const " -->
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#a7f292bade95f2d7ee16450b90ce0625d">gameplay::Gamepad::getButtonCount</a> </td>
  192. <td>(</td>
  193. <td class="paramname"></td><td>)</td>
  194. <td> const</td>
  195. </tr>
  196. </table>
  197. </div>
  198. <div class="memdoc">
  199. <p>Gets the number of buttons on this gamepad.</p>
  200. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of buttons on this gamepad. </dd></dl>
  201. </div>
  202. </div>
  203. <a class="anchor" id="a0b2de80713f58635c141a66717b9683a"></a><!-- doxytag: member="gameplay::Gamepad::getForm" ref="a0b2de80713f58635c141a66717b9683a" args="() const " -->
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname"><a class="el" href="classgameplay_1_1_form.html">Form</a>* <a class="el" href="classgameplay_1_1_gamepad.html#a0b2de80713f58635c141a66717b9683a">gameplay::Gamepad::getForm</a> </td>
  209. <td>(</td>
  210. <td class="paramname"></td><td>)</td>
  211. <td> const</td>
  212. </tr>
  213. </table>
  214. </div>
  215. <div class="memdoc">
  216. <p>Gets the <a class="el" href="classgameplay_1_1_form.html">Form</a> used to represent this gamepad.</p>
  217. <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgameplay_1_1_form.html">Form</a> used to represent this gamepad. NULL if the gamepad is not represented with a <a class="el" href="classgameplay_1_1_form.html">Form</a>. </dd></dl>
  218. </div>
  219. </div>
  220. <a class="anchor" id="af6b0a3adba913eb7b987e98934016137"></a><!-- doxytag: member="gameplay::Gamepad::getJoystickCount" ref="af6b0a3adba913eb7b987e98934016137" args="() const " -->
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#af6b0a3adba913eb7b987e98934016137">gameplay::Gamepad::getJoystickCount</a> </td>
  226. <td>(</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td> const</td>
  229. </tr>
  230. </table>
  231. </div>
  232. <div class="memdoc">
  233. <p>Gets the number of joysticks on the gamepad.</p>
  234. <dl class="return"><dt><b>Returns:</b></dt><dd>the number of joysticks on the gamepad. </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="ab3e57827cfdbf0e18d37aa7ae03d452f"></a><!-- doxytag: member="gameplay::Gamepad::getJoystickValues" ref="ab3e57827cfdbf0e18d37aa7ae03d452f" args="(unsigned int joystickId, Vector2 *outValues) const " -->
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#ab3e57827cfdbf0e18d37aa7ae03d452f">gameplay::Gamepad::getJoystickValues</a> </td>
  243. <td>(</td>
  244. <td class="paramtype">unsigned int&#160;</td>
  245. <td class="paramname"><em>joystickId</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype"><a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> *&#160;</td>
  251. <td class="paramname"><em>outValues</em>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td> const</td>
  257. </tr>
  258. </table>
  259. </div>
  260. <div class="memdoc">
  261. <p>Returns the specified joystick's value as a <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a>.</p>
  262. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  263. <table class="params">
  264. <tr><td class="paramname">joystickId</td><td>The index of the joystick to get the value for. </td></tr>
  265. <tr><td class="paramname">outValues</td><td>The current x-axis and y-axis values of the joystick. </td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="aa1f2a111cf6758ec17e51fcc6ba671db"></a><!-- doxytag: member="gameplay::Gamepad::getName" ref="aa1f2a111cf6758ec17e51fcc6ba671db" args="() const " -->
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">const char* <a class="el" href="classgameplay_1_1_gamepad.html#aa1f2a111cf6758ec17e51fcc6ba671db">gameplay::Gamepad::getName</a> </td>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td> const</td>
  280. </tr>
  281. </table>
  282. </div>
  283. <div class="memdoc">
  284. <p>Get this gamepad's device/product name.</p>
  285. <dl class="return"><dt><b>Returns:</b></dt><dd>This gamepad's device/product name. </dd></dl>
  286. </div>
  287. </div>
  288. <a class="anchor" id="aa33cea2b84705953d296b3586a4cdbf6"></a><!-- doxytag: member="gameplay::Gamepad::getTriggerCount" ref="aa33cea2b84705953d296b3586a4cdbf6" args="() const " -->
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#aa33cea2b84705953d296b3586a4cdbf6">gameplay::Gamepad::getTriggerCount</a> </td>
  294. <td>(</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td> const</td>
  297. </tr>
  298. </table>
  299. </div>
  300. <div class="memdoc">
  301. <p>Returns the number of analog triggers (as opposed to digital shoulder buttons) on this gamepad.</p>
  302. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of analog triggers on this gamepad. </dd></dl>
  303. </div>
  304. </div>
  305. <a class="anchor" id="a7e1b24552efae9bd23cb24bd29a5d157"></a><!-- doxytag: member="gameplay::Gamepad::getTriggerValue" ref="a7e1b24552efae9bd23cb24bd29a5d157" args="(unsigned int triggerId) const " -->
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">float <a class="el" href="classgameplay_1_1_gamepad.html#a7e1b24552efae9bd23cb24bd29a5d157">gameplay::Gamepad::getTriggerValue</a> </td>
  311. <td>(</td>
  312. <td class="paramtype">unsigned int&#160;</td>
  313. <td class="paramname"><em>triggerId</em></td><td>)</td>
  314. <td> const</td>
  315. </tr>
  316. </table>
  317. </div>
  318. <div class="memdoc">
  319. <p>Returns the value of an analog trigger on this gamepad. This value will be a number between 0 and 1, where 0 means the trigger is in its resting (unpressed) state and 1 means the trigger has been completely pressed down.</p>
  320. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  321. <table class="params">
  322. <tr><td class="paramname">triggerId</td><td>The trigger to query. </td></tr>
  323. </table>
  324. </dd>
  325. </dl>
  326. <dl class="return"><dt><b>Returns:</b></dt><dd>The value of the given trigger. </dd></dl>
  327. </div>
  328. </div>
  329. <a class="anchor" id="aa69e8bf61d41cd55f55a67a6974c1694"></a><!-- doxytag: member="gameplay::Gamepad::isButtonDown" ref="aa69e8bf61d41cd55f55a67a6974c1694" args="(ButtonMapping button) const " -->
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">bool <a class="el" href="classgameplay_1_1_gamepad.html#aa69e8bf61d41cd55f55a67a6974c1694">gameplay::Gamepad::isButtonDown</a> </td>
  335. <td>(</td>
  336. <td class="paramtype"><a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">ButtonMapping</a>&#160;</td>
  337. <td class="paramname"><em>button</em></td><td>)</td>
  338. <td> const</td>
  339. </tr>
  340. </table>
  341. </div>
  342. <div class="memdoc">
  343. <p>Gets whether the given button is currently pressed down.</p>
  344. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  345. <table class="params">
  346. <tr><td class="paramname">button</td><td>The enum of the button on the gamepad to get the state for. </td></tr>
  347. </table>
  348. </dd>
  349. </dl>
  350. <dl class="return"><dt><b>Returns:</b></dt><dd>Whether the button is currently pressed or not. </dd></dl>
  351. </div>
  352. </div>
  353. <a class="anchor" id="aad447cbdd1a03ae1fd27b7d7ac2da17d"></a><!-- doxytag: member="gameplay::Gamepad::isVirtual" ref="aad447cbdd1a03ae1fd27b7d7ac2da17d" args="() const " -->
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">bool <a class="el" href="classgameplay_1_1_gamepad.html#aad447cbdd1a03ae1fd27b7d7ac2da17d">gameplay::Gamepad::isVirtual</a> </td>
  359. <td>(</td>
  360. <td class="paramname"></td><td>)</td>
  361. <td> const</td>
  362. </tr>
  363. </table>
  364. </div>
  365. <div class="memdoc">
  366. <p>Returns whether the gamepad is currently represented with a UI form or not.</p>
  367. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the gamepad is currently represented by a UI form; false if the gamepad is not represented by a UI form. </dd></dl>
  368. </div>
  369. </div>
  370. <a class="anchor" id="ad38b2f6bee5c6cdf8a9a4222a84df7c5"></a><!-- doxytag: member="gameplay::Gamepad::update" ref="ad38b2f6bee5c6cdf8a9a4222a84df7c5" args="(float elapsedTime)" -->
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#ad38b2f6bee5c6cdf8a9a4222a84df7c5">gameplay::Gamepad::update</a> </td>
  376. <td>(</td>
  377. <td class="paramtype">float&#160;</td>
  378. <td class="paramname"><em>elapsedTime</em></td><td>)</td>
  379. <td></td>
  380. </tr>
  381. </table>
  382. </div>
  383. <div class="memdoc">
  384. <p>Updates the gamepad's state. For a virtual gamepad, this results in calling <a class="el" href="classgameplay_1_1_gamepad.html#ad38b2f6bee5c6cdf8a9a4222a84df7c5">update()</a> on the gamepad's form. For physical gamepads, this polls the gamepad's state at the platform level. Either way, this should be called once a frame before getting and using a gamepad's current state.</p>
  385. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  386. <table class="params">
  387. <tr><td class="paramname">elapsedTime</td><td>The elapsed game time. </td></tr>
  388. </table>
  389. </dd>
  390. </dl>
  391. </div>
  392. </div>
  393. </div><!-- contents -->
  394. <!-- window showing the filter options -->
  395. <div id="MSearchSelectWindow"
  396. onmouseover="return searchBox.OnSearchSelectShow()"
  397. onmouseout="return searchBox.OnSearchSelectHide()"
  398. onkeydown="return searchBox.OnSearchSelectKey(event)">
  399. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  400. <!-- iframe showing the search results (closed by default) -->
  401. <div id="MSearchResultsWindow">
  402. <iframe src="javascript:void(0)" frameborder="0"
  403. name="MSearchResults" id="MSearchResults">
  404. </iframe>
  405. </div>
  406. <hr class="footer"/><address class="footer"><small>
  407. Generated on Sat Jan 24 2015 15:29:42 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  408. <img class="footer" src="doxygen.png" alt="doxygen"/>
  409. </a> 1.7.6.1
  410. </small></address>
  411. </body>
  412. </html>