Accueil Explorer Aide
Connexion
cpp
/
GamePlay
miroir de https://github.com/gameplay3d/GamePlay
2
0
Fork 0
Fichiers Tickets 0 Wiki
Branche: gh-pages
Branches Tags
GamePlay
/
api
/
classgameplay_1_1_gamepad.html

classgameplay_1_1_gamepad.html 23 KB
Lien permanent Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Gamepad Class Reference</title>
    7. 

  7. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    10. 

  10. <link href="custom.css" rel="stylesheet" type="text/css" />
    11. 

  11. 

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="jquery.js"></script>
    14. 

  14. <script type="text/javascript" src="search/search.js"></script>
    15. 

  15. <script type="text/javascript">
    16. 

  16.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    17. 

  17. </script>
    18. 

  18. 

  19. </head>
    20. 

  20. <body>
    21. 

  21. <div id="top"><!-- do not remove this div! -->
    22. 

  22. <table class="header" border="0">
    23. 

  23. <tbody>
    24. 

  24. <tr>
    25. 

  25. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
    26. 

  26. <td width="100%"/>
    27. 

  27. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
    28. 

  28. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
    29. 

  29. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
    30. 

  30. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
    31. 

  31. </tr>
    32. 

  32. </tbody>
    33. 

  33. </table>
    34. 

  34. <!-- Generated by Doxygen 1.7.6.1 -->
    35. 

  35. <script type="text/javascript">
    36. 

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    37. 

  37. </script>
    38. 

  38.   <div id="navrow1" class="tabs">
    39. 

  39.     <ul class="tablist">
    40. 

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    41. 

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    42. 

  42.       <li>
    43. 

  43.         <div id="MSearchBox" class="MSearchBoxInactive">
    44. 

  44.         <span class="left">
    45. 

  45.           <img id="MSearchSelect" src="search/mag_sel.png"
    46. 

  46.                onmouseover="return searchBox.OnSearchSelectShow()"
    47. 

  47.                onmouseout="return searchBox.OnSearchSelectHide()"
    48. 

  48.                alt=""/>
    49. 

  49.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    50. 

  50.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    51. 

  51.                onblur="searchBox.OnSearchFieldFocus(false)" 
    52. 

  52.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    53. 

  53.           </span><span class="right">
    54. 

  54.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    55. 

  55.           </span>
    56. 

  56.         </div>
    57. 

  57.       </li>
    58. 

  58.     </ul>
    59. 

  59.   </div>
    60. 

  60.   <div id="navrow2" class="tabs2">
    61. 

  61.     <ul class="tablist">
    62. 

  62.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
    63. 

  63.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
    64. 

  64.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    65. 

  65.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    66. 

  66.     </ul>
    67. 

  67.   </div>
    68. 

  68. <!-- window showing the filter options -->
    69. 

  69. <div id="MSearchSelectWindow"
    70. 

  70.      onmouseover="return searchBox.OnSearchSelectShow()"
    71. 

  71.      onmouseout="return searchBox.OnSearchSelectHide()"
    72. 

  72.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    73. 

  73. <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>
    74. 

  74. 

  75. <!-- iframe showing the search results (closed by default) -->
    76. 

  76. <div id="MSearchResultsWindow">
    77. 

  77. <iframe src="javascript:void(0)" frameborder="0" 
    78. 

  78.         name="MSearchResults" id="MSearchResults">
    79. 

  79. </iframe>
    80. 

  80. </div>
    81. 

  81. 

  82.   <div id="nav-path" class="navpath">
    83. 

  83.     <ul>
    84. 

  84.       <li class="navelem"><b>gameplay</b>      </li>
    85. 

  85.       <li class="navelem"><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a>      </li>
    86. 

  86.     </ul>
    87. 

  87.   </div>
    88. 

  88. </div>
    89. 

  89. <div class="header">
    90. 

  90.   <div class="summary">
    91. 

  91. <a href="#pub-types">Public Types</a> &#124;
    92. 

  92. <a href="#pub-methods">Public Member Functions</a>  </div>
    93. 

  93.   <div class="headertitle">
    94. 

  94. <div class="title">gameplay::Gamepad Class Reference</div>  </div>
    95. 

  95. </div><!--header-->
    96. 

  96. <div class="contents">
    97. 

  97. <!-- doxytag: class="gameplay::Gamepad" -->
    98. 

  98. <p><code>#include &lt;Gamepad.h&gt;</code></p>
    99. 

  99. 

  100. <p><a href="classgameplay_1_1_gamepad-members.html">List of all members.</a></p>
    101. 

  101. <table class="memberdecls">
    102. 

  102. <tr><td colspan="2"><h2><a name="pub-types"></a>
    103. 

  103. Public Types</h2></td></tr>
    104. 

  104. <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>, 
    105. 

  105. <b>DISCONNECTED_EVENT</b>
    106. 

  106.  }</td></tr>
    107. 

  107. <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/>
    108. 

  108. &#160;&#160;<b>BUTTON_A</b>, 
    109. 

  109. <b>BUTTON_B</b>, 
    110. 

  110. <b>BUTTON_X</b>, 
    111. 

  111. <b>BUTTON_Y</b>, 
    112. 

  112. <br/>
    113. 

  113. &#160;&#160;<b>BUTTON_L1</b>, 
    114. 

  114. <b>BUTTON_L2</b>, 
    115. 

  115. <b>BUTTON_L3</b>, 
    116. 

  116. <b>BUTTON_R1</b>, 
    117. 

  117. <br/>
    118. 

  118. &#160;&#160;<b>BUTTON_R2</b>, 
    119. 

  119. <b>BUTTON_R3</b>, 
    120. 

  120. <b>BUTTON_UP</b>, 
    121. 

  121. <b>BUTTON_DOWN</b>, 
    122. 

  122. <br/>
    123. 

  123. &#160;&#160;<b>BUTTON_LEFT</b>, 
    124. 

  124. <b>BUTTON_RIGHT</b>, 
    125. 

  125. <b>BUTTON_MENU1</b>, 
    126. 

  126. <b>BUTTON_MENU2</b>, 
    127. 

  127. <br/>
    128. 

  128. &#160;&#160;<b>BUTTON_MENU3</b>
    129. 

  129. <br/>
    130. 

  130.  }</td></tr>
    131. 

  131. <tr><td colspan="2"><h2><a name="pub-methods"></a>
    132. 

  132. Public Member Functions</h2></td></tr>
    133. 

  133. <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>
    134. 

  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#aa69e8bf61d41cd55f55a67a6974c1694">isButtonDown</a> (<a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">ButtonMapping</a> button) const </td></tr>
    135. 

  135. <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>
    136. 

  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#ab3e57827cfdbf0e18d37aa7ae03d452f">getJoystickValues</a> (unsigned int joystickId, <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> *outValues) const </td></tr>
    137. 

  137. <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>
    138. 

  138. <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>
    139. 

  139. <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>
    140. 

  140. <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>
    141. 

  141. <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>
    142. 

  142. <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>
    143. 

  143. <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>
    144. 

  144. </table>
    145. 

  145. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
    146. 

  146. <div class="textblock"><p>Defines a gamepad interface for handling input from joysticks and buttons.</p>
    147. 

  147. <p>A gamepad can be either physical or virtual. Most platform support up to 4 gamepad controllers connected simulataneously. </p>
    148. 

  148. </div><hr/><h2>Member Enumeration Documentation</h2>
    149. 

  149. <a class="anchor" id="a91729957739fbe8a6b88f3e17c2a7ff9"></a><!-- doxytag: member="gameplay::Gamepad::ButtonMapping" ref="a91729957739fbe8a6b88f3e17c2a7ff9" args="" -->
    150. 

  150. <div class="memitem">
    151. 

  151. <div class="memproto">
    152. 

  152.       <table class="memname">
    153. 

  153.         <tr>
    154. 

  154.           <td class="memname">enum <a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">gameplay::Gamepad::ButtonMapping</a></td>
    155. 

  155.         </tr>
    156. 

  156.       </table>
    157. 

  157. </div>
    158. 

  158. <div class="memdoc">
    159. 

  159. <p><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> buttons. </p>
    160. 

  160. 

  161. </div>
    162. 

  162. </div>
    163. 

  163. <a class="anchor" id="ab79068c8eeaa3a4daf6ea1f7a8adc3c9"></a><!-- doxytag: member="gameplay::Gamepad::GamepadEvent" ref="ab79068c8eeaa3a4daf6ea1f7a8adc3c9" args="" -->
    164. 

  164. <div class="memitem">
    165. 

  165. <div class="memproto">
    166. 

  166.       <table class="memname">
    167. 

  167.         <tr>
    168. 

  168.           <td class="memname">enum <a class="el" href="classgameplay_1_1_gamepad.html#ab79068c8eeaa3a4daf6ea1f7a8adc3c9">gameplay::Gamepad::GamepadEvent</a></td>
    169. 

  169.         </tr>
    170. 

  170.       </table>
    171. 

  171. </div>
    172. 

  172. <div class="memdoc">
    173. 

  173. <p><a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> events. </p>
    174. 

  174. 

  175. </div>
    176. 

  176. </div>
    177. 

  177. <hr/><h2>Member Function Documentation</h2>
    178. 

  178. <a class="anchor" id="abf82a1c115c12b76a4078e389b9d27de"></a><!-- doxytag: member="gameplay::Gamepad::draw" ref="abf82a1c115c12b76a4078e389b9d27de" args="()" -->
    179. 

  179. <div class="memitem">
    180. 

  180. <div class="memproto">
    181. 

  181.       <table class="memname">
    182. 

  182.         <tr>
    183. 

  183.           <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#abf82a1c115c12b76a4078e389b9d27de">gameplay::Gamepad::draw</a> </td>
    184. 

  184.           <td>(</td>
    185. 

  185.           <td class="paramname"></td><td>)</td>
    186. 

  186.           <td></td>
    187. 

  187.         </tr>
    188. 

  188.       </table>
    189. 

  189. </div>
    190. 

  190. <div class="memdoc">
    191. 

  191. <p>Draws the gamepad if it is based on a form and if the form is enabled. </p>
    192. 

  192. 

  193. </div>
    194. 

  194. </div>
    195. 

  195. <a class="anchor" id="a7f292bade95f2d7ee16450b90ce0625d"></a><!-- doxytag: member="gameplay::Gamepad::getButtonCount" ref="a7f292bade95f2d7ee16450b90ce0625d" args="() const " -->
    196. 

  196. <div class="memitem">
    197. 

  197. <div class="memproto">
    198. 

  198.       <table class="memname">
    199. 

  199.         <tr>
    200. 

  200.           <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#a7f292bade95f2d7ee16450b90ce0625d">gameplay::Gamepad::getButtonCount</a> </td>
    201. 

  201.           <td>(</td>
    202. 

  202.           <td class="paramname"></td><td>)</td>
    203. 

  203.           <td> const</td>
    204. 

  204.         </tr>
    205. 

  205.       </table>
    206. 

  206. </div>
    207. 

  207. <div class="memdoc">
    208. 

  208. <p>Gets the number of buttons on this gamepad.</p>
    209. 

  209. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of buttons on this gamepad. </dd></dl>
    210. 

  210. 

  211. </div>
    212. 

  212. </div>
    213. 

  213. <a class="anchor" id="a0b2de80713f58635c141a66717b9683a"></a><!-- doxytag: member="gameplay::Gamepad::getForm" ref="a0b2de80713f58635c141a66717b9683a" args="() const " -->
    214. 

  214. <div class="memitem">
    215. 

  215. <div class="memproto">
    216. 

  216.       <table class="memname">
    217. 

  217.         <tr>
    218. 

  218.           <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>
    219. 

  219.           <td>(</td>
    220. 

  220.           <td class="paramname"></td><td>)</td>
    221. 

  221.           <td> const</td>
    222. 

  222.         </tr>
    223. 

  223.       </table>
    224. 

  224. </div>
    225. 

  225. <div class="memdoc">
    226. 

  226. <p>Gets the <a class="el" href="classgameplay_1_1_form.html">Form</a> used to represent this gamepad.</p>
    227. 

  227. <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>
    228. 

  228. 

  229. </div>
    230. 

  230. </div>
    231. 

  231. <a class="anchor" id="af6b0a3adba913eb7b987e98934016137"></a><!-- doxytag: member="gameplay::Gamepad::getJoystickCount" ref="af6b0a3adba913eb7b987e98934016137" args="() const " -->
    232. 

  232. <div class="memitem">
    233. 

  233. <div class="memproto">
    234. 

  234.       <table class="memname">
    235. 

  235.         <tr>
    236. 

  236.           <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#af6b0a3adba913eb7b987e98934016137">gameplay::Gamepad::getJoystickCount</a> </td>
    237. 

  237.           <td>(</td>
    238. 

  238.           <td class="paramname"></td><td>)</td>
    239. 

  239.           <td> const</td>
    240. 

  240.         </tr>
    241. 

  241.       </table>
    242. 

  242. </div>
    243. 

  243. <div class="memdoc">
    244. 

  244. <p>Gets the number of joysticks on the gamepad.</p>
    245. 

  245. <dl class="return"><dt><b>Returns:</b></dt><dd>the number of joysticks on the gamepad. </dd></dl>
    246. 

  246. 

  247. </div>
    248. 

  248. </div>
    249. 

  249. <a class="anchor" id="ab3e57827cfdbf0e18d37aa7ae03d452f"></a><!-- doxytag: member="gameplay::Gamepad::getJoystickValues" ref="ab3e57827cfdbf0e18d37aa7ae03d452f" args="(unsigned int joystickId, Vector2 *outValues) const " -->
    250. 

  250. <div class="memitem">
    251. 

  251. <div class="memproto">
    252. 

  252.       <table class="memname">
    253. 

  253.         <tr>
    254. 

  254.           <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#ab3e57827cfdbf0e18d37aa7ae03d452f">gameplay::Gamepad::getJoystickValues</a> </td>
    255. 

  255.           <td>(</td>
    256. 

  256.           <td class="paramtype">unsigned int&#160;</td>
    257. 

  257.           <td class="paramname"><em>joystickId</em>, </td>
    258. 

  258.         </tr>
    259. 

  259.         <tr>
    260. 

  260.           <td class="paramkey"></td>
    261. 

  261.           <td></td>
    262. 

  262.           <td class="paramtype"><a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> *&#160;</td>
    263. 

  263.           <td class="paramname"><em>outValues</em>&#160;</td>
    264. 

  264.         </tr>
    265. 

  265.         <tr>
    266. 

  266.           <td></td>
    267. 

  267.           <td>)</td>
    268. 

  268.           <td></td><td> const</td>
    269. 

  269.         </tr>
    270. 

  270.       </table>
    271. 

  271. </div>
    272. 

  272. <div class="memdoc">
    273. 

  273. <p>Returns the specified joystick's value as a <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a>.</p>
    274. 

  274. <dl class="params"><dt><b>Parameters:</b></dt><dd>
    275. 

  275.   <table class="params">
    276. 

  276.     <tr><td class="paramname">joystickId</td><td>The index of the joystick to get the value for. </td></tr>
    277. 

  277.     <tr><td class="paramname">outValues</td><td>The current x-axis and y-axis values of the joystick. </td></tr>
    278. 

  278.   </table>
    279. 

  279.   </dd>
    280. 

  280. </dl>
    281. 

  281. 

  282. </div>
    283. 

  283. </div>
    284. 

  284. <a class="anchor" id="aa1f2a111cf6758ec17e51fcc6ba671db"></a><!-- doxytag: member="gameplay::Gamepad::getName" ref="aa1f2a111cf6758ec17e51fcc6ba671db" args="() const " -->
    285. 

  285. <div class="memitem">
    286. 

  286. <div class="memproto">
    287. 

  287.       <table class="memname">
    288. 

  288.         <tr>
    289. 

  289.           <td class="memname">const char* <a class="el" href="classgameplay_1_1_gamepad.html#aa1f2a111cf6758ec17e51fcc6ba671db">gameplay::Gamepad::getName</a> </td>
    290. 

  290.           <td>(</td>
    291. 

  291.           <td class="paramname"></td><td>)</td>
    292. 

  292.           <td> const</td>
    293. 

  293.         </tr>
    294. 

  294.       </table>
    295. 

  295. </div>
    296. 

  296. <div class="memdoc">
    297. 

  297. <p>Get this gamepad's device/product name.</p>
    298. 

  298. <dl class="return"><dt><b>Returns:</b></dt><dd>This gamepad's device/product name. </dd></dl>
    299. 

  299. 

  300. </div>
    301. 

  301. </div>
    302. 

  302. <a class="anchor" id="aa33cea2b84705953d296b3586a4cdbf6"></a><!-- doxytag: member="gameplay::Gamepad::getTriggerCount" ref="aa33cea2b84705953d296b3586a4cdbf6" args="() const " -->
    303. 

  303. <div class="memitem">
    304. 

  304. <div class="memproto">
    305. 

  305.       <table class="memname">
    306. 

  306.         <tr>
    307. 

  307.           <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_gamepad.html#aa33cea2b84705953d296b3586a4cdbf6">gameplay::Gamepad::getTriggerCount</a> </td>
    308. 

  308.           <td>(</td>
    309. 

  309.           <td class="paramname"></td><td>)</td>
    310. 

  310.           <td> const</td>
    311. 

  311.         </tr>
    312. 

  312.       </table>
    313. 

  313. </div>
    314. 

  314. <div class="memdoc">
    315. 

  315. <p>Returns the number of analog triggers (as opposed to digital shoulder buttons) on this gamepad.</p>
    316. 

  316. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of analog triggers on this gamepad. </dd></dl>
    317. 

  317. 

  318. </div>
    319. 

  319. </div>
    320. 

  320. <a class="anchor" id="a7e1b24552efae9bd23cb24bd29a5d157"></a><!-- doxytag: member="gameplay::Gamepad::getTriggerValue" ref="a7e1b24552efae9bd23cb24bd29a5d157" args="(unsigned int triggerId) const " -->
    321. 

  321. <div class="memitem">
    322. 

  322. <div class="memproto">
    323. 

  323.       <table class="memname">
    324. 

  324.         <tr>
    325. 

  325.           <td class="memname">float <a class="el" href="classgameplay_1_1_gamepad.html#a7e1b24552efae9bd23cb24bd29a5d157">gameplay::Gamepad::getTriggerValue</a> </td>
    326. 

  326.           <td>(</td>
    327. 

  327.           <td class="paramtype">unsigned int&#160;</td>
    328. 

  328.           <td class="paramname"><em>triggerId</em></td><td>)</td>
    329. 

  329.           <td> const</td>
    330. 

  330.         </tr>
    331. 

  331.       </table>
    332. 

  332. </div>
    333. 

  333. <div class="memdoc">
    334. 

  334. <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>
    335. 

  335. <dl class="params"><dt><b>Parameters:</b></dt><dd>
    336. 

  336.   <table class="params">
    337. 

  337.     <tr><td class="paramname">triggerId</td><td>The trigger to query. </td></tr>
    338. 

  338.   </table>
    339. 

  339.   </dd>
    340. 

  340. </dl>
    341. 

  341. <dl class="return"><dt><b>Returns:</b></dt><dd>The value of the given trigger. </dd></dl>
    342. 

  342. 

  343. </div>
    344. 

  344. </div>
    345. 

  345. <a class="anchor" id="aa69e8bf61d41cd55f55a67a6974c1694"></a><!-- doxytag: member="gameplay::Gamepad::isButtonDown" ref="aa69e8bf61d41cd55f55a67a6974c1694" args="(ButtonMapping button) const " -->
    346. 

  346. <div class="memitem">
    347. 

  347. <div class="memproto">
    348. 

  348.       <table class="memname">
    349. 

  349.         <tr>
    350. 

  350.           <td class="memname">bool <a class="el" href="classgameplay_1_1_gamepad.html#aa69e8bf61d41cd55f55a67a6974c1694">gameplay::Gamepad::isButtonDown</a> </td>
    351. 

  351.           <td>(</td>
    352. 

  352.           <td class="paramtype"><a class="el" href="classgameplay_1_1_gamepad.html#a91729957739fbe8a6b88f3e17c2a7ff9">ButtonMapping</a>&#160;</td>
    353. 

  353.           <td class="paramname"><em>button</em></td><td>)</td>
    354. 

  354.           <td> const</td>
    355. 

  355.         </tr>
    356. 

  356.       </table>
    357. 

  357. </div>
    358. 

  358. <div class="memdoc">
    359. 

  359. <p>Gets whether the given button is currently pressed down.</p>
    360. 

  360. <dl class="params"><dt><b>Parameters:</b></dt><dd>
    361. 

  361.   <table class="params">
    362. 

  362.     <tr><td class="paramname">button</td><td>The enum of the button on the gamepad to get the state for. </td></tr>
    363. 

  363.   </table>
    364. 

  364.   </dd>
    365. 

  365. </dl>
    366. 

  366. <dl class="return"><dt><b>Returns:</b></dt><dd>Whether the button is currently pressed or not. </dd></dl>
    367. 

  367. 

  368. </div>
    369. 

  369. </div>
    370. 

  370. <a class="anchor" id="aad447cbdd1a03ae1fd27b7d7ac2da17d"></a><!-- doxytag: member="gameplay::Gamepad::isVirtual" ref="aad447cbdd1a03ae1fd27b7d7ac2da17d" args="() const " -->
    371. 

  371. <div class="memitem">
    372. 

  372. <div class="memproto">
    373. 

  373.       <table class="memname">
    374. 

  374.         <tr>
    375. 

  375.           <td class="memname">bool <a class="el" href="classgameplay_1_1_gamepad.html#aad447cbdd1a03ae1fd27b7d7ac2da17d">gameplay::Gamepad::isVirtual</a> </td>
    376. 

  376.           <td>(</td>
    377. 

  377.           <td class="paramname"></td><td>)</td>
    378. 

  378.           <td> const</td>
    379. 

  379.         </tr>
    380. 

  380.       </table>
    381. 

  381. </div>
    382. 

  382. <div class="memdoc">
    383. 

  383. <p>Returns whether the gamepad is currently represented with a UI form or not.</p>
    384. 

  384. <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>
    385. 

  385. 

  386. </div>
    387. 

  387. </div>
    388. 

  388. <a class="anchor" id="ad38b2f6bee5c6cdf8a9a4222a84df7c5"></a><!-- doxytag: member="gameplay::Gamepad::update" ref="ad38b2f6bee5c6cdf8a9a4222a84df7c5" args="(float elapsedTime)" -->
    389. 

  389. <div class="memitem">
    390. 

  390. <div class="memproto">
    391. 

  391.       <table class="memname">
    392. 

  392.         <tr>
    393. 

  393.           <td class="memname">void <a class="el" href="classgameplay_1_1_gamepad.html#ad38b2f6bee5c6cdf8a9a4222a84df7c5">gameplay::Gamepad::update</a> </td>
    394. 

  394.           <td>(</td>
    395. 

  395.           <td class="paramtype">float&#160;</td>
    396. 

  396.           <td class="paramname"><em>elapsedTime</em></td><td>)</td>
    397. 

  397.           <td></td>
    398. 

  398.         </tr>
    399. 

  399.       </table>
    400. 

  400. </div>
    401. 

  401. <div class="memdoc">
    402. 

  402. <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>
    403. 

  403. <dl class="params"><dt><b>Parameters:</b></dt><dd>
    404. 

  404.   <table class="params">
    405. 

  405.     <tr><td class="paramname">elapsedTime</td><td>The elapsed game time. </td></tr>
    406. 

  406.   </table>
    407. 

  407.   </dd>
    408. 

  408. </dl>
    409. 

  409. 

  410. </div>
    411. 

  411. </div>
    412. 

  412. </div><!-- contents -->
    413. 

  413. <!-- window showing the filter options -->
    414. 

  414. <div id="MSearchSelectWindow"
    415. 

  415.      onmouseover="return searchBox.OnSearchSelectShow()"
    416. 

  416.      onmouseout="return searchBox.OnSearchSelectHide()"
    417. 

  417.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    418. 

  418. <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>
    419. 

  419. 

  420. <!-- iframe showing the search results (closed by default) -->
    421. 

  421. <div id="MSearchResultsWindow">
    422. 

  422. <iframe src="javascript:void(0)" frameborder="0" 
    423. 

  423.         name="MSearchResults" id="MSearchResults">
    424. 

  424. </iframe>
    425. 

  425. </div>
    426. 

  426. 

  427. 

  428. 

  429. <hr class="footer"/><address class="footer"><small>
    430. 

  430. Generated on Sat Jan 24 2015 15:29:42 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
    431. 

  431. <img class="footer" src="doxygen.png" alt="doxygen"/>
    432. 

  432. </a> 1.7.6.1
    433. 

  433. </small></address>
    434. 

  434. 

  435. </body>
    436. 

  436. </html>
    437.