classgameplay_1_1_joystick_control.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  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>JoystickControl 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_joystick_control.html">JoystickControl</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-methods">Public Member Functions</a> &#124;
  87. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  88. <a href="#pro-methods">Protected Member Functions</a> &#124;
  89. <a href="#pro-static-methods">Static Protected Member Functions</a> </div>
  90. <div class="headertitle">
  91. <div class="title">gameplay::JoystickControl Class Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <!-- doxytag: class="gameplay::JoystickControl" --><!-- doxytag: inherits="gameplay::Control" -->
  95. <p><code>#include &lt;JoystickControl.h&gt;</code></p>
  96. <div class="dynheader">
  97. Inheritance diagram for gameplay::JoystickControl:</div>
  98. <div class="dyncontent">
  99. <div class="center">
  100. <img src="classgameplay_1_1_joystick_control.png" usemap="#gameplay::JoystickControl_map" alt=""/>
  101. <map id="gameplay::JoystickControl_map" name="gameplay::JoystickControl_map">
  102. <area href="classgameplay_1_1_control.html" alt="gameplay::Control" shape="rect" coords="173,56,336,80"/>
  103. <area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,163,24"/>
  104. <area href="classgameplay_1_1_animation_target.html" alt="gameplay::AnimationTarget" shape="rect" coords="173,0,336,24"/>
  105. <area href="classgameplay_1_1_script_target.html" alt="gameplay::ScriptTarget" shape="rect" coords="346,0,509,24"/>
  106. </map>
  107. </div></div>
  108. <p><a href="classgameplay_1_1_joystick_control-members.html">List of all members.</a></p>
  109. <table class="memberdecls">
  110. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  111. Public Member Functions</h2></td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a42f26dc2b895883b7376b999abc03561">getTypeName</a> () const </td></tr>
  113. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a3b080b9c7cb5f1de44da750cd1739f9d">addListener</a> (<a class="el" href="classgameplay_1_1_control_1_1_listener.html">Control::Listener</a> *listener, int eventFlags)</td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a1dc561bb9d47d9271a72c184ec25e605">getValue</a> () const </td></tr>
  115. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a449df40d1f11c684eb7c003df0b4c576">setInnerRegionSize</a> (const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;size, bool <a class="el" href="classgameplay_1_1_control.html#aa0e51a41446aa0589c4da8b3b2d2ab22">isWidthPercentage</a>=false, bool <a class="el" href="classgameplay_1_1_control.html#ac57bb6782911dd3a96739fd753cde408">isHeightPercentage</a>=false)</td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a9ab1de7592629ebff9c677f751a5d9a4">getInnerRegionSize</a> (bool *<a class="el" href="classgameplay_1_1_control.html#aa0e51a41446aa0589c4da8b3b2d2ab22">isWidthPercentage</a>=NULL, bool *<a class="el" href="classgameplay_1_1_control.html#ac57bb6782911dd3a96739fd753cde408">isHeightPercentage</a>=NULL) const </td></tr>
  117. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a9586e6cf46822f099d3b3155059d5689">setOuterRegionSize</a> (const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;size, bool <a class="el" href="classgameplay_1_1_control.html#aa0e51a41446aa0589c4da8b3b2d2ab22">isWidthPercentage</a>=false, bool <a class="el" href="classgameplay_1_1_control.html#ac57bb6782911dd3a96739fd753cde408">isHeightPercentage</a>=false)</td></tr>
  118. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a1adbbfa24323b1a9f32c2f97d6abb81d">getOuterRegionSize</a> (bool *<a class="el" href="classgameplay_1_1_control.html#aa0e51a41446aa0589c4da8b3b2d2ab22">isWidthPercentage</a>=NULL, bool *<a class="el" href="classgameplay_1_1_control.html#ac57bb6782911dd3a96739fd753cde408">isHeightPercentage</a>=NULL) const </td></tr>
  119. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a9ac3375664ec4ff21425be12b336e8f1">setRelative</a> (bool relative)</td></tr>
  120. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a368f36b7a2326a28902155631552bcfe">isRelative</a> () const </td></tr>
  121. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a0567b0cadd3b265b9f7256f7687dce28">getIndex</a> () const </td></tr>
  122. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a767efe2db78001d1185236b4b9ec0712">setRadius</a> (float radius, bool isPercentage=false)</td></tr>
  123. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a562a8744af05473237991d904e11a1c9">getRadius</a> () const </td></tr>
  124. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a70f1ae1e7aac0716fa46010b1aa93e49">isRadiusPercentage</a> () const </td></tr>
  125. <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
  126. Static Public Member Functions</h2></td></tr>
  127. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_joystick_control.html">JoystickControl</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a3fa5ad42d7cecf6512915a8c4b730d28">create</a> (const char *id, <a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *style=NULL)</td></tr>
  128. <tr><td colspan="2"><h2><a name="pro-methods"></a>
  129. Protected Member Functions</h2></td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#ad90b6792eb5e417b8aface2809550107">JoystickControl</a> ()</td></tr>
  131. <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a36a1555d9727afc0c7d3c00dcbac1e59">~JoystickControl</a> ()</td></tr>
  132. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a45b2ce0385c50569dd9b05e3351f5922">initialize</a> (const char *typeName, <a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *style, <a class="el" href="classgameplay_1_1_properties.html">Properties</a> *properties)</td></tr>
  133. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#afd76dc4745677058ced1132d142a74d9">touchEvent</a> (<a class="el" href="classgameplay_1_1_touch.html#a6563b3b4c9e7ffedfb6be99582290320">Touch::TouchEvent</a> evt, int x, int y, unsigned int contactIndex)</td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#a6c2b6a3635a109f2c26d259b7d74db02">updateAbsoluteBounds</a> (const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;offset)</td></tr>
  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_joystick_control.html#ad4ed5a99982d9e5a84b4c1ae205e41c4">drawImages</a> (<a class="el" href="classgameplay_1_1_form.html">Form</a> *form, const <a class="el" href="classgameplay_1_1_rectangle.html">Rectangle</a> &amp;clip)</td></tr>
  136. <tr><td colspan="2"><h2><a name="pro-static-methods"></a>
  137. Static Protected Member Functions</h2></td></tr>
  138. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_control.html">Control</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_joystick_control.html#aa9ed3c14d40d91318472c243002863a7">create</a> (<a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *style, <a class="el" href="classgameplay_1_1_properties.html">Properties</a> *properties=NULL)</td></tr>
  139. </table>
  140. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  141. <div class="textblock"><p>Defines a control representing a joystick (axis).</p>
  142. <p>This is used in virtual <a class="el" href="classgameplay_1_1_gamepad.html">Gamepad</a> instances.</p>
  143. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://gameplay3d.github.io/GamePlay/docs/file-formats.html#wiki-UI_Forms">http://gameplay3d.github.io/GamePlay/docs/file-formats.html#wiki-UI_Forms</a> </dd></dl>
  144. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  145. <a class="anchor" id="ad90b6792eb5e417b8aface2809550107"></a><!-- doxytag: member="gameplay::JoystickControl::JoystickControl" ref="ad90b6792eb5e417b8aface2809550107" args="()" -->
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname"><a class="el" href="classgameplay_1_1_joystick_control.html#ad90b6792eb5e417b8aface2809550107">gameplay::JoystickControl::JoystickControl</a> </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td><code> [protected]</code></td>
  154. </tr>
  155. </table>
  156. </div>
  157. <div class="memdoc">
  158. <p>Constructor. </p>
  159. </div>
  160. </div>
  161. <a class="anchor" id="a36a1555d9727afc0c7d3c00dcbac1e59"></a><!-- doxytag: member="gameplay::JoystickControl::~JoystickControl" ref="a36a1555d9727afc0c7d3c00dcbac1e59" args="()" -->
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">virtual <a class="el" href="classgameplay_1_1_joystick_control.html#a36a1555d9727afc0c7d3c00dcbac1e59">gameplay::JoystickControl::~JoystickControl</a> </td>
  167. <td>(</td>
  168. <td class="paramname"></td><td>)</td>
  169. <td><code> [protected, virtual]</code></td>
  170. </tr>
  171. </table>
  172. </div>
  173. <div class="memdoc">
  174. <p>Destructor. </p>
  175. </div>
  176. </div>
  177. <hr/><h2>Member Function Documentation</h2>
  178. <a class="anchor" id="a3b080b9c7cb5f1de44da750cd1739f9d"></a><!-- doxytag: member="gameplay::JoystickControl::addListener" ref="a3b080b9c7cb5f1de44da750cd1739f9d" args="(Control::Listener *listener, int eventFlags)" -->
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a3b080b9c7cb5f1de44da750cd1739f9d">gameplay::JoystickControl::addListener</a> </td>
  184. <td>(</td>
  185. <td class="paramtype"><a class="el" href="classgameplay_1_1_control_1_1_listener.html">Control::Listener</a> *&#160;</td>
  186. <td class="paramname"><em>listener</em>, </td>
  187. </tr>
  188. <tr>
  189. <td class="paramkey"></td>
  190. <td></td>
  191. <td class="paramtype">int&#160;</td>
  192. <td class="paramname"><em>eventFlags</em>&#160;</td>
  193. </tr>
  194. <tr>
  195. <td></td>
  196. <td>)</td>
  197. <td></td><td><code> [virtual]</code></td>
  198. </tr>
  199. </table>
  200. </div>
  201. <div class="memdoc">
  202. <p>Add a listener to be notified of specific events affecting this control. Event types can be OR'ed together. E.g. To listen to touch-press and touch-release events, pass <code>Control::Listener::TOUCH | <a class="el" href="classgameplay_1_1_control_1_1_listener.html#aa9f8812153823b2902149969a083af7ba4d6d0d7568cba92935eb52fff947a985">Control::Listener::RELEASE</a></code> as the second parameter.</p>
  203. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  204. <table class="params">
  205. <tr><td class="paramname">listener</td><td>The listener to add. </td></tr>
  206. <tr><td class="paramname">eventFlags</td><td>The events to listen for. </td></tr>
  207. </table>
  208. </dd>
  209. </dl>
  210. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#ac15ca1b3063f4ad9b0fc1b54a6e2f535">gameplay::Control</a>.</p>
  211. </div>
  212. </div>
  213. <a class="anchor" id="a3fa5ad42d7cecf6512915a8c4b730d28"></a><!-- doxytag: member="gameplay::JoystickControl::create" ref="a3fa5ad42d7cecf6512915a8c4b730d28" args="(const char *id, Theme::Style *style=NULL)" -->
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">static <a class="el" href="classgameplay_1_1_joystick_control.html">JoystickControl</a>* <a class="el" href="classgameplay_1_1_joystick_control.html#a3fa5ad42d7cecf6512915a8c4b730d28">gameplay::JoystickControl::create</a> </td>
  219. <td>(</td>
  220. <td class="paramtype">const char *&#160;</td>
  221. <td class="paramname"><em>id</em>, </td>
  222. </tr>
  223. <tr>
  224. <td class="paramkey"></td>
  225. <td></td>
  226. <td class="paramtype"><a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *&#160;</td>
  227. <td class="paramname"><em>style</em> = <code>NULL</code>&#160;</td>
  228. </tr>
  229. <tr>
  230. <td></td>
  231. <td>)</td>
  232. <td></td><td><code> [static]</code></td>
  233. </tr>
  234. </table>
  235. </div>
  236. <div class="memdoc">
  237. <p>Creates a new Joystick control.</p>
  238. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  239. <table class="params">
  240. <tr><td class="paramname">id</td><td>The joystick ID. </td></tr>
  241. <tr><td class="paramname">style</td><td>The joystick style.</td></tr>
  242. </table>
  243. </dd>
  244. </dl>
  245. <dl class="return"><dt><b>Returns:</b></dt><dd>The new joystick. </dd></dl>
  246. </div>
  247. </div>
  248. <a class="anchor" id="aa9ed3c14d40d91318472c243002863a7"></a><!-- doxytag: member="gameplay::JoystickControl::create" ref="aa9ed3c14d40d91318472c243002863a7" args="(Theme::Style *style, Properties *properties=NULL)" -->
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">static <a class="el" href="classgameplay_1_1_control.html">Control</a>* <a class="el" href="classgameplay_1_1_joystick_control.html#a3fa5ad42d7cecf6512915a8c4b730d28">gameplay::JoystickControl::create</a> </td>
  254. <td>(</td>
  255. <td class="paramtype"><a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *&#160;</td>
  256. <td class="paramname"><em>style</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype"><a class="el" href="classgameplay_1_1_properties.html">Properties</a> *&#160;</td>
  262. <td class="paramname"><em>properties</em> = <code>NULL</code>&#160;</td>
  263. </tr>
  264. <tr>
  265. <td></td>
  266. <td>)</td>
  267. <td></td><td><code> [static, protected]</code></td>
  268. </tr>
  269. </table>
  270. </div>
  271. <div class="memdoc">
  272. <p>Create a joystick control with a given style and properties.</p>
  273. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  274. <table class="params">
  275. <tr><td class="paramname">style</td><td>The style to apply to this joystick. </td></tr>
  276. <tr><td class="paramname">properties</td><td>A properties object containing a definition of the joystick.</td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. <dl class="return"><dt><b>Returns:</b></dt><dd>The new joystick. </dd></dl>
  281. </div>
  282. </div>
  283. <a class="anchor" id="ad4ed5a99982d9e5a84b4c1ae205e41c4"></a><!-- doxytag: member="gameplay::JoystickControl::drawImages" ref="ad4ed5a99982d9e5a84b4c1ae205e41c4" args="(Form *form, const Rectangle &amp;clip)" -->
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_joystick_control.html#ad4ed5a99982d9e5a84b4c1ae205e41c4">gameplay::JoystickControl::drawImages</a> </td>
  289. <td>(</td>
  290. <td class="paramtype"><a class="el" href="classgameplay_1_1_form.html">Form</a> *&#160;</td>
  291. <td class="paramname"><em>form</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">const <a class="el" href="classgameplay_1_1_rectangle.html">Rectangle</a> &amp;&#160;</td>
  297. <td class="paramname"><em>clip</em>&#160;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td><code> [protected, virtual]</code></td>
  303. </tr>
  304. </table>
  305. </div>
  306. <div class="memdoc">
  307. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_control.html#a67c2fadd5033f40517c34c60b1718b28">Control::drawImages</a> </dd></dl>
  308. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#a67c2fadd5033f40517c34c60b1718b28">gameplay::Control</a>.</p>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a0567b0cadd3b265b9f7256f7687dce28"></a><!-- doxytag: member="gameplay::JoystickControl::getIndex" ref="a0567b0cadd3b265b9f7256f7687dce28" args="() const " -->
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_joystick_control.html#a0567b0cadd3b265b9f7256f7687dce28">gameplay::JoystickControl::getIndex</a> </td>
  317. <td>(</td>
  318. <td class="paramname"></td><td>)</td>
  319. <td> const</td>
  320. </tr>
  321. </table>
  322. </div>
  323. <div class="memdoc">
  324. <p>Gets the index of this joystick across all joysticks on a form.</p>
  325. <dl class="return"><dt><b>Returns:</b></dt><dd>The index of this joystick on a form. </dd></dl>
  326. </div>
  327. </div>
  328. <a class="anchor" id="a9ab1de7592629ebff9c677f751a5d9a4"></a><!-- doxytag: member="gameplay::JoystickControl::getInnerRegionSize" ref="a9ab1de7592629ebff9c677f751a5d9a4" args="(bool *isWidthPercentage=NULL, bool *isHeightPercentage=NULL) const " -->
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a>&amp; <a class="el" href="classgameplay_1_1_joystick_control.html#a9ab1de7592629ebff9c677f751a5d9a4">gameplay::JoystickControl::getInnerRegionSize</a> </td>
  334. <td>(</td>
  335. <td class="paramtype">bool *&#160;</td>
  336. <td class="paramname"><em>isWidthPercentage</em> = <code>NULL</code>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">bool *&#160;</td>
  342. <td class="paramname"><em>isHeightPercentage</em> = <code>NULL</code>&#160;</td>
  343. </tr>
  344. <tr>
  345. <td></td>
  346. <td>)</td>
  347. <td></td><td> const</td>
  348. </tr>
  349. </table>
  350. </div>
  351. <div class="memdoc">
  352. <p>Gets the image size of the inner region of the joystick. Returns (0,0) if there is no inner image region defined.</p>
  353. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  354. <table class="params">
  355. <tr><td class="paramname">isWidthPercentage</td><td>Set to true if the width value is a percentage value of the relative size of this control </td></tr>
  356. <tr><td class="paramname">isHeightPercentage</td><td>Set to true if the height value is a percentage value of the relative size of this control</td></tr>
  357. </table>
  358. </dd>
  359. </dl>
  360. <dl class="return"><dt><b>Returns:</b></dt><dd>The image size of the inner region of the joystick. (x, y) == (width, height) </dd></dl>
  361. </div>
  362. </div>
  363. <a class="anchor" id="a1adbbfa24323b1a9f32c2f97d6abb81d"></a><!-- doxytag: member="gameplay::JoystickControl::getOuterRegionSize" ref="a1adbbfa24323b1a9f32c2f97d6abb81d" args="(bool *isWidthPercentage=NULL, bool *isHeightPercentage=NULL) const " -->
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a>&amp; <a class="el" href="classgameplay_1_1_joystick_control.html#a1adbbfa24323b1a9f32c2f97d6abb81d">gameplay::JoystickControl::getOuterRegionSize</a> </td>
  369. <td>(</td>
  370. <td class="paramtype">bool *&#160;</td>
  371. <td class="paramname"><em>isWidthPercentage</em> = <code>NULL</code>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype">bool *&#160;</td>
  377. <td class="paramname"><em>isHeightPercentage</em> = <code>NULL</code>&#160;</td>
  378. </tr>
  379. <tr>
  380. <td></td>
  381. <td>)</td>
  382. <td></td><td> const</td>
  383. </tr>
  384. </table>
  385. </div>
  386. <div class="memdoc">
  387. <p>Gets the image size of the outer region of the joystick. Returns (0,0) if there is no outer image region defined.</p>
  388. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  389. <table class="params">
  390. <tr><td class="paramname">isWidthPercentage</td><td>Set to true if the width value is a percentage value of the relative size of this control </td></tr>
  391. <tr><td class="paramname">isHeightPercentage</td><td>Set to true if the height value is a percentage value of the relative size of this control</td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. <dl class="return"><dt><b>Returns:</b></dt><dd>The image size of the outer region of the joystick. (x, y) == (width, height) </dd></dl>
  396. </div>
  397. </div>
  398. <a class="anchor" id="a562a8744af05473237991d904e11a1c9"></a><!-- doxytag: member="gameplay::JoystickControl::getRadius" ref="a562a8744af05473237991d904e11a1c9" args="() const " -->
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">float <a class="el" href="classgameplay_1_1_joystick_control.html#a562a8744af05473237991d904e11a1c9">gameplay::JoystickControl::getRadius</a> </td>
  404. <td>(</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td> const</td>
  407. </tr>
  408. </table>
  409. </div>
  410. <div class="memdoc">
  411. <p>Gets the radius of joystick motion</p>
  412. <dl class="return"><dt><b>Returns:</b></dt><dd>The radius of joystick motion </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="a42f26dc2b895883b7376b999abc03561"></a><!-- doxytag: member="gameplay::JoystickControl::getTypeName" ref="a42f26dc2b895883b7376b999abc03561" args="() const " -->
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">const char* <a class="el" href="classgameplay_1_1_joystick_control.html#a42f26dc2b895883b7376b999abc03561">gameplay::JoystickControl::getTypeName</a> </td>
  421. <td>(</td>
  422. <td class="paramname"></td><td>)</td>
  423. <td> const<code> [virtual]</code></td>
  424. </tr>
  425. </table>
  426. </div>
  427. <div class="memdoc">
  428. <p>Extends <a class="el" href="classgameplay_1_1_script_target.html#ac419e98f0eac8a52a6095da0e3853df3">ScriptTarget::getTypeName()</a> to return the type name of this class.</p>
  429. <p>Child controls should override this function to return the correct type name.</p>
  430. <dl class="return"><dt><b>Returns:</b></dt><dd>The type name of this class: "JoystickControl" </dd></dl>
  431. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_script_target.html#ac419e98f0eac8a52a6095da0e3853df3">ScriptTarget::getTypeName()</a> </dd></dl>
  432. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#a5e00321d739db9b2055478bc978d2aab">gameplay::Control</a>.</p>
  433. </div>
  434. </div>
  435. <a class="anchor" id="a1dc561bb9d47d9271a72c184ec25e605"></a><!-- doxytag: member="gameplay::JoystickControl::getValue" ref="a1dc561bb9d47d9271a72c184ec25e605" args="() const " -->
  436. <div class="memitem">
  437. <div class="memproto">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a>&amp; <a class="el" href="classgameplay_1_1_joystick_control.html#a1dc561bb9d47d9271a72c184ec25e605">gameplay::JoystickControl::getValue</a> </td>
  441. <td>(</td>
  442. <td class="paramname"></td><td>)</td>
  443. <td> const</td>
  444. </tr>
  445. </table>
  446. </div>
  447. <div class="memdoc">
  448. <p>Gets the value (2-dimensional direction) of the joystick.</p>
  449. <dl class="return"><dt><b>Returns:</b></dt><dd>The value of the joystick. </dd></dl>
  450. </div>
  451. </div>
  452. <a class="anchor" id="a45b2ce0385c50569dd9b05e3351f5922"></a><!-- doxytag: member="gameplay::JoystickControl::initialize" ref="a45b2ce0385c50569dd9b05e3351f5922" args="(const char *typeName, Theme::Style *style, Properties *properties)" -->
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a45b2ce0385c50569dd9b05e3351f5922">gameplay::JoystickControl::initialize</a> </td>
  458. <td>(</td>
  459. <td class="paramtype">const char *&#160;</td>
  460. <td class="paramname"><em>typeName</em>, </td>
  461. </tr>
  462. <tr>
  463. <td class="paramkey"></td>
  464. <td></td>
  465. <td class="paramtype"><a class="el" href="classgameplay_1_1_theme_1_1_style.html">Theme::Style</a> *&#160;</td>
  466. <td class="paramname"><em>style</em>, </td>
  467. </tr>
  468. <tr>
  469. <td class="paramkey"></td>
  470. <td></td>
  471. <td class="paramtype"><a class="el" href="classgameplay_1_1_properties.html">Properties</a> *&#160;</td>
  472. <td class="paramname"><em>properties</em>&#160;</td>
  473. </tr>
  474. <tr>
  475. <td></td>
  476. <td>)</td>
  477. <td></td><td><code> [protected, virtual]</code></td>
  478. </tr>
  479. </table>
  480. </div>
  481. <div class="memdoc">
  482. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_control.html#a1c7de615c9b99672573327c5fb342ba7">Control::initialize</a> </dd></dl>
  483. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#a1c7de615c9b99672573327c5fb342ba7">gameplay::Control</a>.</p>
  484. </div>
  485. </div>
  486. <a class="anchor" id="a70f1ae1e7aac0716fa46010b1aa93e49"></a><!-- doxytag: member="gameplay::JoystickControl::isRadiusPercentage" ref="a70f1ae1e7aac0716fa46010b1aa93e49" args="() const " -->
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">bool <a class="el" href="classgameplay_1_1_joystick_control.html#a70f1ae1e7aac0716fa46010b1aa93e49">gameplay::JoystickControl::isRadiusPercentage</a> </td>
  492. <td>(</td>
  493. <td class="paramname"></td><td>)</td>
  494. <td> const</td>
  495. </tr>
  496. </table>
  497. </div>
  498. <div class="memdoc">
  499. <p>Determines if the radius of joystick motion is a percentage value of the relative size of this control</p>
  500. <dl class="return"><dt><b>Returns:</b></dt><dd>True if the radius of joystick motion is a percentage value of the relative size of this control </dd></dl>
  501. </div>
  502. </div>
  503. <a class="anchor" id="a368f36b7a2326a28902155631552bcfe"></a><!-- doxytag: member="gameplay::JoystickControl::isRelative" ref="a368f36b7a2326a28902155631552bcfe" args="() const " -->
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname">bool <a class="el" href="classgameplay_1_1_joystick_control.html#a368f36b7a2326a28902155631552bcfe">gameplay::JoystickControl::isRelative</a> </td>
  509. <td>(</td>
  510. <td class="paramname"></td><td>)</td>
  511. <td> const</td>
  512. </tr>
  513. </table>
  514. </div>
  515. <div class="memdoc">
  516. <p>Gets whether absolute positioning is enabled or not.</p>
  517. <p>Note: The default behavior is absolute positioning, and not relative.</p>
  518. <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if relative positioning is enabled; <code>false</code> otherwise. </dd></dl>
  519. </div>
  520. </div>
  521. <a class="anchor" id="a449df40d1f11c684eb7c003df0b4c576"></a><!-- doxytag: member="gameplay::JoystickControl::setInnerRegionSize" ref="a449df40d1f11c684eb7c003df0b4c576" args="(const Vector2 &amp;size, bool isWidthPercentage=false, bool isHeightPercentage=false)" -->
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a449df40d1f11c684eb7c003df0b4c576">gameplay::JoystickControl::setInnerRegionSize</a> </td>
  527. <td>(</td>
  528. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td>
  529. <td class="paramname"><em>size</em>, </td>
  530. </tr>
  531. <tr>
  532. <td class="paramkey"></td>
  533. <td></td>
  534. <td class="paramtype">bool&#160;</td>
  535. <td class="paramname"><em>isWidthPercentage</em> = <code>false</code>, </td>
  536. </tr>
  537. <tr>
  538. <td class="paramkey"></td>
  539. <td></td>
  540. <td class="paramtype">bool&#160;</td>
  541. <td class="paramname"><em>isHeightPercentage</em> = <code>false</code>&#160;</td>
  542. </tr>
  543. <tr>
  544. <td></td>
  545. <td>)</td>
  546. <td></td><td></td>
  547. </tr>
  548. </table>
  549. </div>
  550. <div class="memdoc">
  551. <p>Sets the image size of the inner region of the joystick. Does not do anything if there is no inner image region defined.</p>
  552. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  553. <table class="params">
  554. <tr><td class="paramname">size</td><td>The size of the inner region of the joystick. (x, y) == (width, height) </td></tr>
  555. <tr><td class="paramname">isWidthPercentage</td><td>If the width value should be computed as a percentage of the relative size of this control </td></tr>
  556. <tr><td class="paramname">isHeightPercentage</td><td>If the height value should be computed as a percentage of the relative size of this control </td></tr>
  557. </table>
  558. </dd>
  559. </dl>
  560. </div>
  561. </div>
  562. <a class="anchor" id="a9586e6cf46822f099d3b3155059d5689"></a><!-- doxytag: member="gameplay::JoystickControl::setOuterRegionSize" ref="a9586e6cf46822f099d3b3155059d5689" args="(const Vector2 &amp;size, bool isWidthPercentage=false, bool isHeightPercentage=false)" -->
  563. <div class="memitem">
  564. <div class="memproto">
  565. <table class="memname">
  566. <tr>
  567. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a9586e6cf46822f099d3b3155059d5689">gameplay::JoystickControl::setOuterRegionSize</a> </td>
  568. <td>(</td>
  569. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td>
  570. <td class="paramname"><em>size</em>, </td>
  571. </tr>
  572. <tr>
  573. <td class="paramkey"></td>
  574. <td></td>
  575. <td class="paramtype">bool&#160;</td>
  576. <td class="paramname"><em>isWidthPercentage</em> = <code>false</code>, </td>
  577. </tr>
  578. <tr>
  579. <td class="paramkey"></td>
  580. <td></td>
  581. <td class="paramtype">bool&#160;</td>
  582. <td class="paramname"><em>isHeightPercentage</em> = <code>false</code>&#160;</td>
  583. </tr>
  584. <tr>
  585. <td></td>
  586. <td>)</td>
  587. <td></td><td></td>
  588. </tr>
  589. </table>
  590. </div>
  591. <div class="memdoc">
  592. <p>Sets the image size of the outer region of the joystick. Does not do anything if there is no outer image region defined.</p>
  593. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  594. <table class="params">
  595. <tr><td class="paramname">size</td><td>The size of the outer region of the joystick. (x, y) == (width, height) </td></tr>
  596. <tr><td class="paramname">isWidthPercentage</td><td>If the width value should be computed as a percentage of the relative size of this control </td></tr>
  597. <tr><td class="paramname">isHeightPercentage</td><td>If the height value should be computed as a percentage of the relative size of this control </td></tr>
  598. </table>
  599. </dd>
  600. </dl>
  601. </div>
  602. </div>
  603. <a class="anchor" id="a767efe2db78001d1185236b4b9ec0712"></a><!-- doxytag: member="gameplay::JoystickControl::setRadius" ref="a767efe2db78001d1185236b4b9ec0712" args="(float radius, bool isPercentage=false)" -->
  604. <div class="memitem">
  605. <div class="memproto">
  606. <table class="memname">
  607. <tr>
  608. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a767efe2db78001d1185236b4b9ec0712">gameplay::JoystickControl::setRadius</a> </td>
  609. <td>(</td>
  610. <td class="paramtype">float&#160;</td>
  611. <td class="paramname"><em>radius</em>, </td>
  612. </tr>
  613. <tr>
  614. <td class="paramkey"></td>
  615. <td></td>
  616. <td class="paramtype">bool&#160;</td>
  617. <td class="paramname"><em>isPercentage</em> = <code>false</code>&#160;</td>
  618. </tr>
  619. <tr>
  620. <td></td>
  621. <td>)</td>
  622. <td></td><td></td>
  623. </tr>
  624. </table>
  625. </div>
  626. <div class="memdoc">
  627. <p>Sets the radius of joystick motion</p>
  628. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  629. <table class="params">
  630. <tr><td class="paramname">radius</td><td>The radius to be set. </td></tr>
  631. <tr><td class="paramname">isPercentage</td><td>If the radius value is a percentage value of the relative size of this control </td></tr>
  632. </table>
  633. </dd>
  634. </dl>
  635. </div>
  636. </div>
  637. <a class="anchor" id="a9ac3375664ec4ff21425be12b336e8f1"></a><!-- doxytag: member="gameplay::JoystickControl::setRelative" ref="a9ac3375664ec4ff21425be12b336e8f1" args="(bool relative)" -->
  638. <div class="memitem">
  639. <div class="memproto">
  640. <table class="memname">
  641. <tr>
  642. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a9ac3375664ec4ff21425be12b336e8f1">gameplay::JoystickControl::setRelative</a> </td>
  643. <td>(</td>
  644. <td class="paramtype">bool&#160;</td>
  645. <td class="paramname"><em>relative</em></td><td>)</td>
  646. <td></td>
  647. </tr>
  648. </table>
  649. </div>
  650. <div class="memdoc">
  651. <p>Sets whether relative positioning is enabled or not.</p>
  652. <p>Note: The default behavior is absolute positioning, and not relative.</p>
  653. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  654. <table class="params">
  655. <tr><td class="paramname">relative</td><td>Whether relative positioning should be enabled or not. </td></tr>
  656. </table>
  657. </dd>
  658. </dl>
  659. </div>
  660. </div>
  661. <a class="anchor" id="afd76dc4745677058ced1132d142a74d9"></a><!-- doxytag: member="gameplay::JoystickControl::touchEvent" ref="afd76dc4745677058ced1132d142a74d9" args="(Touch::TouchEvent evt, int x, int y, unsigned int contactIndex)" -->
  662. <div class="memitem">
  663. <div class="memproto">
  664. <table class="memname">
  665. <tr>
  666. <td class="memname">bool <a class="el" href="classgameplay_1_1_joystick_control.html#afd76dc4745677058ced1132d142a74d9">gameplay::JoystickControl::touchEvent</a> </td>
  667. <td>(</td>
  668. <td class="paramtype"><a class="el" href="classgameplay_1_1_touch.html#a6563b3b4c9e7ffedfb6be99582290320">Touch::TouchEvent</a>&#160;</td>
  669. <td class="paramname"><em>evt</em>, </td>
  670. </tr>
  671. <tr>
  672. <td class="paramkey"></td>
  673. <td></td>
  674. <td class="paramtype">int&#160;</td>
  675. <td class="paramname"><em>x</em>, </td>
  676. </tr>
  677. <tr>
  678. <td class="paramkey"></td>
  679. <td></td>
  680. <td class="paramtype">int&#160;</td>
  681. <td class="paramname"><em>y</em>, </td>
  682. </tr>
  683. <tr>
  684. <td class="paramkey"></td>
  685. <td></td>
  686. <td class="paramtype">unsigned int&#160;</td>
  687. <td class="paramname"><em>contactIndex</em>&#160;</td>
  688. </tr>
  689. <tr>
  690. <td></td>
  691. <td>)</td>
  692. <td></td><td><code> [protected, virtual]</code></td>
  693. </tr>
  694. </table>
  695. </div>
  696. <div class="memdoc">
  697. <p><a class="el" href="classgameplay_1_1_touch.html">Touch</a> callback on touch events. Controls return true if they consume the touch event.</p>
  698. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  699. <table class="params">
  700. <tr><td class="paramname">evt</td><td>The touch event that occurred. </td></tr>
  701. <tr><td class="paramname">x</td><td>The x position of the touch in pixels. Left edge is zero. </td></tr>
  702. <tr><td class="paramname">y</td><td>The y position of the touch in pixels. Top edge is zero. </td></tr>
  703. <tr><td class="paramname">contactIndex</td><td>The order of occurrence for multiple touch contacts starting at zero.</td></tr>
  704. </table>
  705. </dd>
  706. </dl>
  707. <dl class="return"><dt><b>Returns:</b></dt><dd>Whether the touch event was consumed by the control.</dd></dl>
  708. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_touch.html#a6563b3b4c9e7ffedfb6be99582290320">Touch::TouchEvent</a> </dd></dl>
  709. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#a4c9fdfd5a48360be13e7925323513d52">gameplay::Control</a>.</p>
  710. </div>
  711. </div>
  712. <a class="anchor" id="a6c2b6a3635a109f2c26d259b7d74db02"></a><!-- doxytag: member="gameplay::JoystickControl::updateAbsoluteBounds" ref="a6c2b6a3635a109f2c26d259b7d74db02" args="(const Vector2 &amp;offset)" -->
  713. <div class="memitem">
  714. <div class="memproto">
  715. <table class="memname">
  716. <tr>
  717. <td class="memname">void <a class="el" href="classgameplay_1_1_joystick_control.html#a6c2b6a3635a109f2c26d259b7d74db02">gameplay::JoystickControl::updateAbsoluteBounds</a> </td>
  718. <td>(</td>
  719. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector2.html">Vector2</a> &amp;&#160;</td>
  720. <td class="paramname"><em>offset</em></td><td>)</td>
  721. <td><code> [protected, virtual]</code></td>
  722. </tr>
  723. </table>
  724. </div>
  725. <div class="memdoc">
  726. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_control.html#a3dce8f933d7ad495179a390a8622b0a3">Control::updateAbsoluteBounds</a> </dd></dl>
  727. <p>Reimplemented from <a class="el" href="classgameplay_1_1_control.html#a3dce8f933d7ad495179a390a8622b0a3">gameplay::Control</a>.</p>
  728. </div>
  729. </div>
  730. </div><!-- contents -->
  731. <!-- window showing the filter options -->
  732. <div id="MSearchSelectWindow"
  733. onmouseover="return searchBox.OnSearchSelectShow()"
  734. onmouseout="return searchBox.OnSearchSelectHide()"
  735. onkeydown="return searchBox.OnSearchSelectKey(event)">
  736. <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>
  737. <!-- iframe showing the search results (closed by default) -->
  738. <div id="MSearchResultsWindow">
  739. <iframe src="javascript:void(0)" frameborder="0"
  740. name="MSearchResults" id="MSearchResults">
  741. </iframe>
  742. </div>
  743. <hr class="footer"/><address class="footer"><small>
  744. Generated on Sat Jan 24 2015 15:29:42 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  745. <img class="footer" src="doxygen.png" alt="doxygen"/>
  746. </a> 1.7.6.1
  747. </small></address>
  748. </body>
  749. </html>