class_soft_body_vertex.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: SoftBodyVertex Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_soft_body_vertex.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="#pub-attribs">Public Attributes</a> &#124;
  109. <a href="class_soft_body_vertex-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">SoftBodyVertex Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_soft_body_vertex_8h_source.html">SoftBodyVertex.h</a>&gt;</code></p>
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  116. Public Member Functions</h2></td></tr>
  117. <tr class="memitem:a086157ae91ab52e169a13e9575fa1431" id="r_a086157ae91ab52e169a13e9575fa1431"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a086157ae91ab52e169a13e9575fa1431">ResetCollision</a> ()</td></tr>
  118. <tr class="memdesc:a086157ae91ab52e169a13e9575fa1431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset collision information to prepare for a new collision check. <br /></td></tr>
  119. <tr class="separator:a086157ae91ab52e169a13e9575fa1431"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  122. Public Attributes</h2></td></tr>
  123. <tr class="memitem:a43610d9ba8e79136479fd22eb83e3ece" id="r_a43610d9ba8e79136479fd22eb83e3ece"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a43610d9ba8e79136479fd22eb83e3ece">mPreviousPosition</a></td></tr>
  124. <tr class="memdesc:a43610d9ba8e79136479fd22eb83e3ece"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal use only. Position at the previous time step. <br /></td></tr>
  125. <tr class="separator:a43610d9ba8e79136479fd22eb83e3ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:afad3ccc1b361c0c7607d14cbb0b61660" id="r_afad3ccc1b361c0c7607d14cbb0b61660"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afad3ccc1b361c0c7607d14cbb0b61660">mPosition</a></td></tr>
  127. <tr class="memdesc:afad3ccc1b361c0c7607d14cbb0b61660"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position, relative to the center of mass of the soft body. <br /></td></tr>
  128. <tr class="separator:afad3ccc1b361c0c7607d14cbb0b61660"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a5cb33a0b7a5c5085ddffe35daadd784c" id="r_a5cb33a0b7a5c5085ddffe35daadd784c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5cb33a0b7a5c5085ddffe35daadd784c">mVelocity</a></td></tr>
  130. <tr class="memdesc:a5cb33a0b7a5c5085ddffe35daadd784c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Velocity, relative to the center of mass of the soft body. <br /></td></tr>
  131. <tr class="separator:a5cb33a0b7a5c5085ddffe35daadd784c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ad875325c3ade4ca33d6b96716b8a2b07" id="r_ad875325c3ade4ca33d6b96716b8a2b07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad875325c3ade4ca33d6b96716b8a2b07">mCollisionPlane</a></td></tr>
  133. <tr class="memdesc:ad875325c3ade4ca33d6b96716b8a2b07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal use only. Nearest collision plane, relative to the center of mass of the soft body. <br /></td></tr>
  134. <tr class="separator:ad875325c3ade4ca33d6b96716b8a2b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a887112c6a59e554fd15aac62b7e84dfe" id="r_a887112c6a59e554fd15aac62b7e84dfe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a887112c6a59e554fd15aac62b7e84dfe">mCollidingShapeIndex</a></td></tr>
  136. <tr class="memdesc:a887112c6a59e554fd15aac62b7e84dfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal use only. Index in the colliding shapes list of the body we may collide with. <br /></td></tr>
  137. <tr class="separator:a887112c6a59e554fd15aac62b7e84dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a7a7cadb5a9910d419f7e42ad78079c67" id="r_a7a7cadb5a9910d419f7e42ad78079c67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a7cadb5a9910d419f7e42ad78079c67">mHasContact</a></td></tr>
  139. <tr class="memdesc:a7a7cadb5a9910d419f7e42ad78079c67"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the vertex has collided with anything in the last update. <br /></td></tr>
  140. <tr class="separator:a7a7cadb5a9910d419f7e42ad78079c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a8277ada20f83ca568c1e6173720fbf23" id="r_a8277ada20f83ca568c1e6173720fbf23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8277ada20f83ca568c1e6173720fbf23">mLargestPenetration</a></td></tr>
  142. <tr class="memdesc:a8277ada20f83ca568c1e6173720fbf23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal use only. Used while finding the collision plane, stores the largest penetration found so far. <br /></td></tr>
  143. <tr class="separator:a8277ada20f83ca568c1e6173720fbf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a43d59fd48a3f5955b220d29e2b3bb3f6" id="r_a43d59fd48a3f5955b220d29e2b3bb3f6"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a43d59fd48a3f5955b220d29e2b3bb3f6">mInvMass</a></td></tr>
  145. <tr class="memdesc:a43d59fd48a3f5955b220d29e2b3bb3f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse mass (1 / mass) <br /></td></tr>
  146. <tr class="separator:a43d59fd48a3f5955b220d29e2b3bb3f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  149. <div class="textblock"><p>Run time information for a single particle of a soft body Note that at run-time you should only modify the inverse mass and/or velocity of a vertex to control the soft body. Modifying the position can lead to missed collisions. The other members are used internally by the soft body solver. </p>
  150. </div><h2 class="groupheader">Member Function Documentation</h2>
  151. <a id="a086157ae91ab52e169a13e9575fa1431" name="a086157ae91ab52e169a13e9575fa1431"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a086157ae91ab52e169a13e9575fa1431">&#9670;&#160;</a></span>ResetCollision()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">void SoftBodyVertex::ResetCollision </td>
  161. <td>(</td>
  162. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </td>
  167. <td class="mlabels-right">
  168. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Reset collision information to prepare for a new collision check. </p>
  173. </div>
  174. </div>
  175. <h2 class="groupheader">Member Data Documentation</h2>
  176. <a id="a887112c6a59e554fd15aac62b7e84dfe" name="a887112c6a59e554fd15aac62b7e84dfe"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#a887112c6a59e554fd15aac62b7e84dfe">&#9670;&#160;</a></span>mCollidingShapeIndex</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">int SoftBodyVertex::mCollidingShapeIndex</td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Internal use only. Index in the colliding shapes list of the body we may collide with. </p>
  187. </div>
  188. </div>
  189. <a id="ad875325c3ade4ca33d6b96716b8a2b07" name="ad875325c3ade4ca33d6b96716b8a2b07"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#ad875325c3ade4ca33d6b96716b8a2b07">&#9670;&#160;</a></span>mCollisionPlane</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname"><a class="el" href="class_plane.html">Plane</a> SoftBodyVertex::mCollisionPlane</td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Internal use only. Nearest collision plane, relative to the center of mass of the soft body. </p>
  200. </div>
  201. </div>
  202. <a id="a7a7cadb5a9910d419f7e42ad78079c67" name="a7a7cadb5a9910d419f7e42ad78079c67"></a>
  203. <h2 class="memtitle"><span class="permalink"><a href="#a7a7cadb5a9910d419f7e42ad78079c67">&#9670;&#160;</a></span>mHasContact</h2>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">bool SoftBodyVertex::mHasContact</td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>True if the vertex has collided with anything in the last update. </p>
  213. </div>
  214. </div>
  215. <a id="a43d59fd48a3f5955b220d29e2b3bb3f6" name="a43d59fd48a3f5955b220d29e2b3bb3f6"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a43d59fd48a3f5955b220d29e2b3bb3f6">&#9670;&#160;</a></span>mInvMass</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">float SoftBodyVertex::mInvMass</td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Inverse mass (1 / mass) </p>
  226. </div>
  227. </div>
  228. <a id="a8277ada20f83ca568c1e6173720fbf23" name="a8277ada20f83ca568c1e6173720fbf23"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#a8277ada20f83ca568c1e6173720fbf23">&#9670;&#160;</a></span>mLargestPenetration</h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">float SoftBodyVertex::mLargestPenetration</td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Internal use only. Used while finding the collision plane, stores the largest penetration found so far. </p>
  239. </div>
  240. </div>
  241. <a id="afad3ccc1b361c0c7607d14cbb0b61660" name="afad3ccc1b361c0c7607d14cbb0b61660"></a>
  242. <h2 class="memtitle"><span class="permalink"><a href="#afad3ccc1b361c0c7607d14cbb0b61660">&#9670;&#160;</a></span>mPosition</h2>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> SoftBodyVertex::mPosition</td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Position, relative to the center of mass of the soft body. </p>
  252. </div>
  253. </div>
  254. <a id="a43610d9ba8e79136479fd22eb83e3ece" name="a43610d9ba8e79136479fd22eb83e3ece"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a43610d9ba8e79136479fd22eb83e3ece">&#9670;&#160;</a></span>mPreviousPosition</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> SoftBodyVertex::mPreviousPosition</td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Internal use only. Position at the previous time step. </p>
  265. </div>
  266. </div>
  267. <a id="a5cb33a0b7a5c5085ddffe35daadd784c" name="a5cb33a0b7a5c5085ddffe35daadd784c"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#a5cb33a0b7a5c5085ddffe35daadd784c">&#9670;&#160;</a></span>mVelocity</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> SoftBodyVertex::mVelocity</td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Velocity, relative to the center of mass of the soft body. </p>
  278. </div>
  279. </div>
  280. <hr/>The documentation for this class was generated from the following file:<ul>
  281. <li>Jolt/Physics/SoftBody/<a class="el" href="_soft_body_vertex_8h_source.html">SoftBodyVertex.h</a></li>
  282. </ul>
  283. </div><!-- contents -->
  284. </div><!-- doc-content -->
  285. <!-- start footer part -->
  286. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  287. <ul>
  288. <li class="navelem"><a class="el" href="class_soft_body_vertex.html">SoftBodyVertex</a></li>
  289. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  290. </ul>
  291. </div>
  292. </body>
  293. </html>