classgameplay_1_1_physics_hinge_constraint.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  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>PhysicsHingeConstraint 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_physics_hinge_constraint.html">PhysicsHingeConstraint</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> </div>
  87. <div class="headertitle">
  88. <div class="title">gameplay::PhysicsHingeConstraint Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <!-- doxytag: class="gameplay::PhysicsHingeConstraint" --><!-- doxytag: inherits="gameplay::PhysicsConstraint" -->
  92. <p><code>#include &lt;PhysicsHingeConstraint.h&gt;</code></p>
  93. <div class="dynheader">
  94. Inheritance diagram for gameplay::PhysicsHingeConstraint:</div>
  95. <div class="dyncontent">
  96. <div class="center">
  97. <img src="classgameplay_1_1_physics_hinge_constraint.png" usemap="#gameplay::PhysicsHingeConstraint_map" alt=""/>
  98. <map id="gameplay::PhysicsHingeConstraint_map" name="gameplay::PhysicsHingeConstraint_map">
  99. <area href="classgameplay_1_1_physics_constraint.html" alt="gameplay::PhysicsConstraint" shape="rect" coords="0,0,206,24"/>
  100. </map>
  101. </div></div>
  102. <p><a href="classgameplay_1_1_physics_hinge_constraint-members.html">List of all members.</a></p>
  103. <table class="memberdecls">
  104. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  105. Public Member Functions</h2></td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_hinge_constraint.html#ac05a7a2481b821201dc7cc321159cad8">setLimits</a> (float minAngle, float maxAngle, float bounciness=1.0f)</td></tr>
  107. </table>
  108. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  109. <div class="textblock"><p>Defines a hinge constraint between two rigid bodies (or one rigid body and the world) where movement is restricted to rotation about one axis.</p>
  110. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://gameplay3d.github.io/GamePlay/docs/file-formats.html#wiki-Constraints">http://gameplay3d.github.io/GamePlay/docs/file-formats.html#wiki-Constraints</a> </dd></dl>
  111. </div><hr/><h2>Member Function Documentation</h2>
  112. <a class="anchor" id="ac05a7a2481b821201dc7cc321159cad8"></a><!-- doxytag: member="gameplay::PhysicsHingeConstraint::setLimits" ref="ac05a7a2481b821201dc7cc321159cad8" args="(float minAngle, float maxAngle, float bounciness=1.0f)" -->
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_hinge_constraint.html#ac05a7a2481b821201dc7cc321159cad8">gameplay::PhysicsHingeConstraint::setLimits</a> </td>
  118. <td>(</td>
  119. <td class="paramtype">float&#160;</td>
  120. <td class="paramname"><em>minAngle</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype">float&#160;</td>
  126. <td class="paramname"><em>maxAngle</em>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype">float&#160;</td>
  132. <td class="paramname"><em>bounciness</em> = <code>1.0f</code>&#160;</td>
  133. </tr>
  134. <tr>
  135. <td></td>
  136. <td>)</td>
  137. <td></td><td></td>
  138. </tr>
  139. </table>
  140. </div>
  141. <div class="memdoc">
  142. <p>Sets the limits (and optionally, some properties) for the hinge.</p>
  143. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  144. <table class="params">
  145. <tr><td class="paramname">minAngle</td><td>The minimum angle for the hinge. </td></tr>
  146. <tr><td class="paramname">maxAngle</td><td>The maximum angle for the hinge. </td></tr>
  147. <tr><td class="paramname">bounciness</td><td>The bounciness of the hinge (this is applied as a factor to the incoming velocity when a hinge limit is met in order to calculate the outgoing velocity-for example, 0.0 corresponds to no bounce and 1.0 corresponds to an outgoing velocity that is equal in magnitude to the incoming velocity). </td></tr>
  148. </table>
  149. </dd>
  150. </dl>
  151. </div>
  152. </div>
  153. </div><!-- contents -->
  154. <!-- window showing the filter options -->
  155. <div id="MSearchSelectWindow"
  156. onmouseover="return searchBox.OnSearchSelectShow()"
  157. onmouseout="return searchBox.OnSearchSelectHide()"
  158. onkeydown="return searchBox.OnSearchSelectKey(event)">
  159. <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>
  160. <!-- iframe showing the search results (closed by default) -->
  161. <div id="MSearchResultsWindow">
  162. <iframe src="javascript:void(0)" frameborder="0"
  163. name="MSearchResults" id="MSearchResults">
  164. </iframe>
  165. </div>
  166. <hr class="footer"/><address class="footer"><small>
  167. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  168. <img class="footer" src="doxygen.png" alt="doxygen"/>
  169. </a> 1.7.6.1
  170. </small></address>
  171. </body>
  172. </html>