classgameplay_1_1_physics_fixed_constraint.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  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>PhysicsFixedConstraint 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_fixed_constraint.html">PhysicsFixedConstraint</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pro-methods">Protected Member Functions</a> </div>
  87. <div class="headertitle">
  88. <div class="title">gameplay::PhysicsFixedConstraint Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <!-- doxytag: class="gameplay::PhysicsFixedConstraint" --><!-- doxytag: inherits="gameplay::PhysicsGenericConstraint" -->
  92. <p><code>#include &lt;PhysicsFixedConstraint.h&gt;</code></p>
  93. <div class="dynheader">
  94. Inheritance diagram for gameplay::PhysicsFixedConstraint:</div>
  95. <div class="dyncontent">
  96. <div class="center">
  97. <img src="classgameplay_1_1_physics_fixed_constraint.png" usemap="#gameplay::PhysicsFixedConstraint_map" alt=""/>
  98. <map id="gameplay::PhysicsFixedConstraint_map" name="gameplay::PhysicsFixedConstraint_map">
  99. <area href="classgameplay_1_1_physics_generic_constraint.html" alt="gameplay::PhysicsGenericConstraint" shape="rect" coords="0,56,218,80"/>
  100. <area href="classgameplay_1_1_physics_constraint.html" alt="gameplay::PhysicsConstraint" shape="rect" coords="0,0,218,24"/>
  101. </map>
  102. </div></div>
  103. <p><a href="classgameplay_1_1_physics_fixed_constraint-members.html">List of all members.</a></p>
  104. <table class="memberdecls">
  105. <tr><td colspan="2"><h2><a name="pro-methods"></a>
  106. Protected Member Functions</h2></td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a5c32bbac8dee1c22e57cd4ea97b2c064">PhysicsFixedConstraint</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>
  108. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#adae59b17cddaeed983f680ae875c4218">~PhysicsFixedConstraint</a> ()</td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a87e1d7d8a8225e684567246fffd98679">setAngularLowerLimit</a> (const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;limit)</td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#ae9506f4c185ee917de87ee5810298eee">setAngularUpperLimit</a> (const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;limit)</td></tr>
  111. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a0f6921061b0e164f34a806c9524dc445">setLinearLowerLimit</a> (const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;limit)</td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a28d4fa6a7fab3e6643569c02c5d0faad">setLinearUpperLimit</a> (const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;limit)</td></tr>
  113. </table>
  114. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  115. <div class="textblock"><p>Defines a constraint where two rigid bodies (or one rigid body and the world) are bound together.</p>
  116. <p>This is similar in concept to parenting one node to another, but can be used in specific situations for a more appropriate effect Ex. for implementing sticky projectiles, etc.</p>
  117. <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>
  118. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  119. <a class="anchor" id="a5c32bbac8dee1c22e57cd4ea97b2c064"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::PhysicsFixedConstraint" ref="a5c32bbac8dee1c22e57cd4ea97b2c064" args="(PhysicsRigidBody *a, PhysicsRigidBody *b)" -->
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a5c32bbac8dee1c22e57cd4ea97b2c064">gameplay::PhysicsFixedConstraint::PhysicsFixedConstraint</a> </td>
  125. <td>(</td>
  126. <td class="paramtype"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td>
  127. <td class="paramname"><em>a</em>, </td>
  128. </tr>
  129. <tr>
  130. <td class="paramkey"></td>
  131. <td></td>
  132. <td class="paramtype"><a class="el" href="classgameplay_1_1_physics_rigid_body.html">PhysicsRigidBody</a> *&#160;</td>
  133. <td class="paramname"><em>b</em>&#160;</td>
  134. </tr>
  135. <tr>
  136. <td></td>
  137. <td>)</td>
  138. <td></td><td><code> [protected]</code></td>
  139. </tr>
  140. </table>
  141. </div>
  142. <div class="memdoc">
  143. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_physics_generic_constraint.html">PhysicsGenericConstraint</a> </dd></dl>
  144. </div>
  145. </div>
  146. <a class="anchor" id="adae59b17cddaeed983f680ae875c4218"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::~PhysicsFixedConstraint" ref="adae59b17cddaeed983f680ae875c4218" args="()" -->
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname"><a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#adae59b17cddaeed983f680ae875c4218">gameplay::PhysicsFixedConstraint::~PhysicsFixedConstraint</a> </td>
  152. <td>(</td>
  153. <td class="paramname"></td><td>)</td>
  154. <td><code> [protected]</code></td>
  155. </tr>
  156. </table>
  157. </div>
  158. <div class="memdoc">
  159. <p>Destructor. </p>
  160. </div>
  161. </div>
  162. <hr/><h2>Member Function Documentation</h2>
  163. <a class="anchor" id="a87e1d7d8a8225e684567246fffd98679"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::setAngularLowerLimit" ref="a87e1d7d8a8225e684567246fffd98679" args="(const Vector3 &amp;limit)" -->
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a87e1d7d8a8225e684567246fffd98679">gameplay::PhysicsFixedConstraint::setAngularLowerLimit</a> </td>
  169. <td>(</td>
  170. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  171. <td class="paramname"><em>limit</em></td><td>)</td>
  172. <td><code> [inline, protected]</code></td>
  173. </tr>
  174. </table>
  175. </div>
  176. <div class="memdoc">
  177. <p>Protected to prevent usage. </p>
  178. <p>Reimplemented from <a class="el" href="classgameplay_1_1_physics_generic_constraint.html#aabcda26aca77120a17553966e06592a9">gameplay::PhysicsGenericConstraint</a>.</p>
  179. </div>
  180. </div>
  181. <a class="anchor" id="ae9506f4c185ee917de87ee5810298eee"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::setAngularUpperLimit" ref="ae9506f4c185ee917de87ee5810298eee" args="(const Vector3 &amp;limit)" -->
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#ae9506f4c185ee917de87ee5810298eee">gameplay::PhysicsFixedConstraint::setAngularUpperLimit</a> </td>
  187. <td>(</td>
  188. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  189. <td class="paramname"><em>limit</em></td><td>)</td>
  190. <td><code> [inline, protected]</code></td>
  191. </tr>
  192. </table>
  193. </div>
  194. <div class="memdoc">
  195. <p>Protected to prevent usage. </p>
  196. <p>Reimplemented from <a class="el" href="classgameplay_1_1_physics_generic_constraint.html#aeeb772acc01cd5bd57b06ac8c0cd9abf">gameplay::PhysicsGenericConstraint</a>.</p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="a0f6921061b0e164f34a806c9524dc445"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::setLinearLowerLimit" ref="a0f6921061b0e164f34a806c9524dc445" args="(const Vector3 &amp;limit)" -->
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a0f6921061b0e164f34a806c9524dc445">gameplay::PhysicsFixedConstraint::setLinearLowerLimit</a> </td>
  205. <td>(</td>
  206. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  207. <td class="paramname"><em>limit</em></td><td>)</td>
  208. <td><code> [inline, protected]</code></td>
  209. </tr>
  210. </table>
  211. </div>
  212. <div class="memdoc">
  213. <p>Protected to prevent usage. </p>
  214. <p>Reimplemented from <a class="el" href="classgameplay_1_1_physics_generic_constraint.html#a746a5369813df4cbda8b835d03491c0c">gameplay::PhysicsGenericConstraint</a>.</p>
  215. </div>
  216. </div>
  217. <a class="anchor" id="a28d4fa6a7fab3e6643569c02c5d0faad"></a><!-- doxytag: member="gameplay::PhysicsFixedConstraint::setLinearUpperLimit" ref="a28d4fa6a7fab3e6643569c02c5d0faad" args="(const Vector3 &amp;limit)" -->
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">void <a class="el" href="classgameplay_1_1_physics_fixed_constraint.html#a28d4fa6a7fab3e6643569c02c5d0faad">gameplay::PhysicsFixedConstraint::setLinearUpperLimit</a> </td>
  223. <td>(</td>
  224. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  225. <td class="paramname"><em>limit</em></td><td>)</td>
  226. <td><code> [inline, protected]</code></td>
  227. </tr>
  228. </table>
  229. </div>
  230. <div class="memdoc">
  231. <p>Protected to prevent usage. </p>
  232. <p>Reimplemented from <a class="el" href="classgameplay_1_1_physics_generic_constraint.html#a233e0a2fd47e6e2d5f286ca68e619f7b">gameplay::PhysicsGenericConstraint</a>.</p>
  233. </div>
  234. </div>
  235. </div><!-- contents -->
  236. <!-- window showing the filter options -->
  237. <div id="MSearchSelectWindow"
  238. onmouseover="return searchBox.OnSearchSelectShow()"
  239. onmouseout="return searchBox.OnSearchSelectHide()"
  240. onkeydown="return searchBox.OnSearchSelectKey(event)">
  241. <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>
  242. <!-- iframe showing the search results (closed by default) -->
  243. <div id="MSearchResultsWindow">
  244. <iframe src="javascript:void(0)" frameborder="0"
  245. name="MSearchResults" id="MSearchResults">
  246. </iframe>
  247. </div>
  248. <hr class="footer"/><address class="footer"><small>
  249. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  250. <img class="footer" src="doxygen.png" alt="doxygen"/>
  251. </a> 1.7.6.1
  252. </small></address>
  253. </body>
  254. </html>