classgameplay_1_1_physics_constraint.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  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>PhysicsConstraint 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_constraint.html">PhysicsConstraint</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> &#124;
  90. <a href="#pro-attribs">Protected Attributes</a> </div>
  91. <div class="headertitle">
  92. <div class="title">gameplay::PhysicsConstraint Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <!-- doxytag: class="gameplay::PhysicsConstraint" -->
  96. <p><code>#include &lt;PhysicsConstraint.h&gt;</code></p>
  97. <div class="dynheader">
  98. Inheritance diagram for gameplay::PhysicsConstraint:</div>
  99. <div class="dyncontent">
  100. <div class="center">
  101. <img src="classgameplay_1_1_physics_constraint.png" usemap="#gameplay::PhysicsConstraint_map" alt=""/>
  102. <map id="gameplay::PhysicsConstraint_map" name="gameplay::PhysicsConstraint_map">
  103. <area href="classgameplay_1_1_physics_generic_constraint.html" alt="gameplay::PhysicsGenericConstraint" shape="rect" coords="114,56,332,80"/>
  104. <area href="classgameplay_1_1_physics_hinge_constraint.html" alt="gameplay::PhysicsHingeConstraint" shape="rect" coords="342,56,560,80"/>
  105. <area href="classgameplay_1_1_physics_socket_constraint.html" alt="gameplay::PhysicsSocketConstraint" shape="rect" coords="570,56,788,80"/>
  106. <area href="classgameplay_1_1_physics_fixed_constraint.html" alt="gameplay::PhysicsFixedConstraint" shape="rect" coords="0,112,218,136"/>
  107. <area href="classgameplay_1_1_physics_spring_constraint.html" alt="gameplay::PhysicsSpringConstraint" shape="rect" coords="228,112,446,136"/>
  108. </map>
  109. </div></div>
  110. <p><a href="classgameplay_1_1_physics_constraint-members.html">List of all members.</a></p>
  111. <table class="memberdecls">
  112. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  113. Public Member Functions</h2></td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a86d8778f474d1db27317014e9cffebb1">getBreakingImpulse</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_physics_constraint.html#a749d228b9931fc253e7fd78b75ac21f8">setBreakingImpulse</a> (float impulse)</td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#abc645ab8b79b5d697a55e25ecb5c4c8f">isEnabled</a> () 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_physics_constraint.html#ad7ba664ad85f3fd0e1491e8915524728">setEnabled</a> (bool enabled)</td></tr>
  118. <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
  119. Static Public Member Functions</h2></td></tr>
  120. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#af7946d6ff918563aa47f1163acfc3328">centerOfMassMidpoint</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *a, const <a class="el" href="classgameplay_1_1_node.html">Node</a> *b)</td></tr>
  121. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_quaternion.html">Quaternion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a9d34e23d7c1557f20ce1779026ba6a54">getRotationOffset</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node, const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;point)</td></tr>
  122. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#ac925a468d45a4089cb80dba9ca92fa7e">getTranslationOffset</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node, const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;point)</td></tr>
  123. <tr><td colspan="2"><h2><a name="pro-methods"></a>
  124. Protected Member Functions</h2></td></tr>
  125. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a1403dd86eebb7625999505c5682382e2">PhysicsConstraint</a> (<a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *a, <a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *b)</td></tr>
  126. <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#afd2cfe4fd6c7d4ce35fc840a4727c4a1">~PhysicsConstraint</a> ()</td></tr>
  127. <tr><td colspan="2"><h2><a name="pro-static-methods"></a>
  128. Static Protected Member Functions</h2></td></tr>
  129. <tr><td class="memItemLeft" align="right" valign="top">static btTransform&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#af9c6d61a3f9599819117fc51a1440870">getTransformOffset</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node, const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;origin)</td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#aaeba73582a74c94a3feccf9c6098190b">getWorldCenterOfMass</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node)</td></tr>
  131. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a9a4582516a24b538ab9861e75ea6b271">offsetByCenterOfMass</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node, const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;v)</td></tr>
  132. <tr><td colspan="2"><h2><a name="pro-attribs"></a>
  133. Protected Attributes</h2></td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a35a92c318b06bcab6aa3d59dd45a976f">_a</a></td></tr>
  135. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#a0effc818674c9fbe8c3e096768e3b1df">_b</a></td></tr>
  136. <tr><td class="memItemLeft" align="right" valign="top">btTypedConstraint *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_constraint.html#aa31e5a0fb7dce4acad85613c6e9ca8fe">_constraint</a></td></tr>
  137. </table>
  138. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  139. <div class="textblock"><p>Defines the base class for physics constraints.</p>
  140. <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>
  141. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  142. <a class="anchor" id="a1403dd86eebb7625999505c5682382e2"></a><!-- doxytag: member="gameplay::PhysicsConstraint::PhysicsConstraint" ref="a1403dd86eebb7625999505c5682382e2" args="(PhysicsRigidBody *a, PhysicsRigidBody *b)" -->
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="classgameplay_1_1_physics_constraint.html#a1403dd86eebb7625999505c5682382e2">gameplay::PhysicsConstraint::PhysicsConstraint</a> </td>
  148. <td>(</td>
  149. <td class="paramtype"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td>
  150. <td class="paramname"><em>a</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td>
  156. <td class="paramname"><em>b</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td><code> [protected]</code></td>
  162. </tr>
  163. </table>
  164. </div>
  165. <div class="memdoc">
  166. <p>Constructor. </p>
  167. </div>
  168. </div>
  169. <a class="anchor" id="afd2cfe4fd6c7d4ce35fc840a4727c4a1"></a><!-- doxytag: member="gameplay::PhysicsConstraint::~PhysicsConstraint" ref="afd2cfe4fd6c7d4ce35fc840a4727c4a1" args="()" -->
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">virtual <a class="el" href="classgameplay_1_1_physics_constraint.html#afd2cfe4fd6c7d4ce35fc840a4727c4a1">gameplay::PhysicsConstraint::~PhysicsConstraint</a> </td>
  175. <td>(</td>
  176. <td class="paramname"></td><td>)</td>
  177. <td><code> [protected, virtual]</code></td>
  178. </tr>
  179. </table>
  180. </div>
  181. <div class="memdoc">
  182. <p>Destructor. </p>
  183. </div>
  184. </div>
  185. <hr/><h2>Member Function Documentation</h2>
  186. <a class="anchor" id="af7946d6ff918563aa47f1163acfc3328"></a><!-- doxytag: member="gameplay::PhysicsConstraint::centerOfMassMidpoint" ref="af7946d6ff918563aa47f1163acfc3328" args="(const Node *a, const Node *b)" -->
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> <a class="el" href="classgameplay_1_1_physics_constraint.html#af7946d6ff918563aa47f1163acfc3328">gameplay::PhysicsConstraint::centerOfMassMidpoint</a> </td>
  192. <td>(</td>
  193. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  194. <td class="paramname"><em>a</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  200. <td class="paramname"><em>b</em>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td><code> [static]</code></td>
  206. </tr>
  207. </table>
  208. </div>
  209. <div class="memdoc">
  210. <p>Calculates the midpoint between the given nodes' centers of mass.</p>
  211. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  212. <table class="params">
  213. <tr><td class="paramname">a</td><td>The first node. </td></tr>
  214. <tr><td class="paramname">b</td><td>The second node. </td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a86d8778f474d1db27317014e9cffebb1"></a><!-- doxytag: member="gameplay::PhysicsConstraint::getBreakingImpulse" ref="a86d8778f474d1db27317014e9cffebb1" args="() const " -->
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">float <a class="el" href="classgameplay_1_1_physics_constraint.html#a86d8778f474d1db27317014e9cffebb1">gameplay::PhysicsConstraint::getBreakingImpulse</a> </td>
  226. <td>(</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td> const<code> [inline]</code></td>
  229. </tr>
  230. </table>
  231. </div>
  232. <div class="memdoc">
  233. <p>Gets the impulse needed to break the constraint.</p>
  234. <dl class="return"><dt><b>Returns:</b></dt><dd>The impulse needed to break the constraint. </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="a9d34e23d7c1557f20ce1779026ba6a54"></a><!-- doxytag: member="gameplay::PhysicsConstraint::getRotationOffset" ref="a9d34e23d7c1557f20ce1779026ba6a54" args="(const Node *node, const Vector3 &amp;point)" -->
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">static <a class="el" href="classgameplay_1_1_quaternion.html">Quaternion</a> <a class="el" href="classgameplay_1_1_physics_constraint.html#a9d34e23d7c1557f20ce1779026ba6a54">gameplay::PhysicsConstraint::getRotationOffset</a> </td>
  243. <td>(</td>
  244. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  245. <td class="paramname"><em>node</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  251. <td class="paramname"><em>point</em>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td><code> [static]</code></td>
  257. </tr>
  258. </table>
  259. </div>
  260. <div class="memdoc">
  261. <p>Calculates the rotation offset to the given point in the given node's local space.</p>
  262. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  263. <table class="params">
  264. <tr><td class="paramname">node</td><td>The node to calculate a rotation offset for. </td></tr>
  265. <tr><td class="paramname">point</td><td>The point to calculate the rotation offset to. </td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="af9c6d61a3f9599819117fc51a1440870"></a><!-- doxytag: member="gameplay::PhysicsConstraint::getTransformOffset" ref="af9c6d61a3f9599819117fc51a1440870" args="(const Node *node, const Vector3 &amp;origin)" -->
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">static btTransform <a class="el" href="classgameplay_1_1_physics_constraint.html#af9c6d61a3f9599819117fc51a1440870">gameplay::PhysicsConstraint::getTransformOffset</a> </td>
  277. <td>(</td>
  278. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  279. <td class="paramname"><em>node</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  285. <td class="paramname"><em>origin</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td><code> [static, protected]</code></td>
  291. </tr>
  292. </table>
  293. </div>
  294. <div class="memdoc">
  295. <p>Calculates the transform to be used as the offset (i.e. "frame in" parameter in Bullet terms) to the given constraint origin. </p>
  296. </div>
  297. </div>
  298. <a class="anchor" id="ac925a468d45a4089cb80dba9ca92fa7e"></a><!-- doxytag: member="gameplay::PhysicsConstraint::getTranslationOffset" ref="ac925a468d45a4089cb80dba9ca92fa7e" args="(const Node *node, const Vector3 &amp;point)" -->
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> <a class="el" href="classgameplay_1_1_physics_constraint.html#ac925a468d45a4089cb80dba9ca92fa7e">gameplay::PhysicsConstraint::getTranslationOffset</a> </td>
  304. <td>(</td>
  305. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  306. <td class="paramname"><em>node</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  312. <td class="paramname"><em>point</em>&#160;</td>
  313. </tr>
  314. <tr>
  315. <td></td>
  316. <td>)</td>
  317. <td></td><td><code> [static]</code></td>
  318. </tr>
  319. </table>
  320. </div>
  321. <div class="memdoc">
  322. <p>Calculates the translation offset to the given point in the given node's local space.</p>
  323. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  324. <table class="params">
  325. <tr><td class="paramname">node</td><td>The node to calculate a translation offset for. </td></tr>
  326. <tr><td class="paramname">point</td><td>The point to calculate the translation offset to. </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. </div>
  331. </div>
  332. <a class="anchor" id="aaeba73582a74c94a3feccf9c6098190b"></a><!-- doxytag: member="gameplay::PhysicsConstraint::getWorldCenterOfMass" ref="aaeba73582a74c94a3feccf9c6098190b" args="(const Node *node)" -->
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> <a class="el" href="classgameplay_1_1_physics_constraint.html#aaeba73582a74c94a3feccf9c6098190b">gameplay::PhysicsConstraint::getWorldCenterOfMass</a> </td>
  338. <td>(</td>
  339. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  340. <td class="paramname"><em>node</em></td><td>)</td>
  341. <td><code> [static, protected]</code></td>
  342. </tr>
  343. </table>
  344. </div>
  345. <div class="memdoc">
  346. <p>Calculates the center of mass in world space of the given node. </p>
  347. </div>
  348. </div>
  349. <a class="anchor" id="abc645ab8b79b5d697a55e25ecb5c4c8f"></a><!-- doxytag: member="gameplay::PhysicsConstraint::isEnabled" ref="abc645ab8b79b5d697a55e25ecb5c4c8f" args="() const " -->
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">bool <a class="el" href="classgameplay_1_1_physics_constraint.html#abc645ab8b79b5d697a55e25ecb5c4c8f">gameplay::PhysicsConstraint::isEnabled</a> </td>
  355. <td>(</td>
  356. <td class="paramname"></td><td>)</td>
  357. <td> const<code> [inline]</code></td>
  358. </tr>
  359. </table>
  360. </div>
  361. <div class="memdoc">
  362. <p>Gets whether the constraint is enabled or not.</p>
  363. <dl class="return"><dt><b>Returns:</b></dt><dd>Whether the constraint is enabled or not. </dd></dl>
  364. </div>
  365. </div>
  366. <a class="anchor" id="a9a4582516a24b538ab9861e75ea6b271"></a><!-- doxytag: member="gameplay::PhysicsConstraint::offsetByCenterOfMass" ref="a9a4582516a24b538ab9861e75ea6b271" args="(const Node *node, const Vector3 &amp;v)" -->
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">static <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> <a class="el" href="classgameplay_1_1_physics_constraint.html#a9a4582516a24b538ab9861e75ea6b271">gameplay::PhysicsConstraint::offsetByCenterOfMass</a> </td>
  372. <td>(</td>
  373. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  374. <td class="paramname"><em>node</em>, </td>
  375. </tr>
  376. <tr>
  377. <td class="paramkey"></td>
  378. <td></td>
  379. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  380. <td class="paramname"><em>v</em>&#160;</td>
  381. </tr>
  382. <tr>
  383. <td></td>
  384. <td>)</td>
  385. <td></td><td><code> [static, protected]</code></td>
  386. </tr>
  387. </table>
  388. </div>
  389. <div class="memdoc">
  390. <p>Offsets the given vector by the given node's center of mass. </p>
  391. </div>
  392. </div>
  393. <a class="anchor" id="a749d228b9931fc253e7fd78b75ac21f8"></a><!-- doxytag: member="gameplay::PhysicsConstraint::setBreakingImpulse" ref="a749d228b9931fc253e7fd78b75ac21f8" args="(float impulse)" -->
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_constraint.html#a749d228b9931fc253e7fd78b75ac21f8">gameplay::PhysicsConstraint::setBreakingImpulse</a> </td>
  399. <td>(</td>
  400. <td class="paramtype">float&#160;</td>
  401. <td class="paramname"><em>impulse</em></td><td>)</td>
  402. <td><code> [inline]</code></td>
  403. </tr>
  404. </table>
  405. </div>
  406. <div class="memdoc">
  407. <p>Sets the impulse needed to break the constraint (if an impulse greater than or equal to the given value is applied to the constraint, the constraint will be broken).</p>
  408. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  409. <table class="params">
  410. <tr><td class="paramname">impulse</td><td>The impulse needed to break the constraint. </td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. </div>
  415. </div>
  416. <a class="anchor" id="ad7ba664ad85f3fd0e1491e8915524728"></a><!-- doxytag: member="gameplay::PhysicsConstraint::setEnabled" ref="ad7ba664ad85f3fd0e1491e8915524728" args="(bool enabled)" -->
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_constraint.html#ad7ba664ad85f3fd0e1491e8915524728">gameplay::PhysicsConstraint::setEnabled</a> </td>
  422. <td>(</td>
  423. <td class="paramtype">bool&#160;</td>
  424. <td class="paramname"><em>enabled</em></td><td>)</td>
  425. <td><code> [inline]</code></td>
  426. </tr>
  427. </table>
  428. </div>
  429. <div class="memdoc">
  430. <p>Sets whether the constraint is enabled or not.</p>
  431. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  432. <table class="params">
  433. <tr><td class="paramname">enabled</td><td>Whether the constraint is enabled or not. </td></tr>
  434. </table>
  435. </dd>
  436. </dl>
  437. </div>
  438. </div>
  439. <hr/><h2>Member Data Documentation</h2>
  440. <a class="anchor" id="a35a92c318b06bcab6aa3d59dd45a976f"></a><!-- doxytag: member="gameplay::PhysicsConstraint::_a" ref="a35a92c318b06bcab6aa3d59dd45a976f" args="" -->
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a>* <a class="el" href="classgameplay_1_1_physics_constraint.html#a35a92c318b06bcab6aa3d59dd45a976f">gameplay::PhysicsConstraint::_a</a><code> [protected]</code></td>
  446. </tr>
  447. </table>
  448. </div>
  449. <div class="memdoc">
  450. <p>Pointer to the one rigid body bound by this constraint. </p>
  451. </div>
  452. </div>
  453. <a class="anchor" id="a0effc818674c9fbe8c3e096768e3b1df"></a><!-- doxytag: member="gameplay::PhysicsConstraint::_b" ref="a0effc818674c9fbe8c3e096768e3b1df" args="" -->
  454. <div class="memitem">
  455. <div class="memproto">
  456. <table class="memname">
  457. <tr>
  458. <td class="memname"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a>* <a class="el" href="classgameplay_1_1_physics_constraint.html#a0effc818674c9fbe8c3e096768e3b1df">gameplay::PhysicsConstraint::_b</a><code> [protected]</code></td>
  459. </tr>
  460. </table>
  461. </div>
  462. <div class="memdoc">
  463. <p>Pointer to the other rigid body bound by this constraint. </p>
  464. </div>
  465. </div>
  466. <a class="anchor" id="aa31e5a0fb7dce4acad85613c6e9ca8fe"></a><!-- doxytag: member="gameplay::PhysicsConstraint::_constraint" ref="aa31e5a0fb7dce4acad85613c6e9ca8fe" args="" -->
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="memname">
  470. <tr>
  471. <td class="memname">btTypedConstraint* <a class="el" href="classgameplay_1_1_physics_constraint.html#aa31e5a0fb7dce4acad85613c6e9ca8fe">gameplay::PhysicsConstraint::_constraint</a><code> [protected]</code></td>
  472. </tr>
  473. </table>
  474. </div>
  475. <div class="memdoc">
  476. <p>Pointer to the Bullet constraint. </p>
  477. </div>
  478. </div>
  479. </div><!-- contents -->
  480. <!-- window showing the filter options -->
  481. <div id="MSearchSelectWindow"
  482. onmouseover="return searchBox.OnSearchSelectShow()"
  483. onmouseout="return searchBox.OnSearchSelectHide()"
  484. onkeydown="return searchBox.OnSearchSelectKey(event)">
  485. <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>
  486. <!-- iframe showing the search results (closed by default) -->
  487. <div id="MSearchResultsWindow">
  488. <iframe src="javascript:void(0)" frameborder="0"
  489. name="MSearchResults" id="MSearchResults">
  490. </iframe>
  491. </div>
  492. <hr class="footer"/><address class="footer"><small>
  493. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  494. <img class="footer" src="doxygen.png" alt="doxygen"/>
  495. </a> 1.7.6.1
  496. </small></address>
  497. </body>
  498. </html>