struct_soft_body_shared_settings_1_1_dihedral_bend.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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: SoftBodySharedSettings::DihedralBend Struct 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('struct_soft_body_shared_settings_1_1_dihedral_bend.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="struct_soft_body_shared_settings_1_1_dihedral_bend-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">SoftBodySharedSettings::DihedralBend Struct Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_soft_body_shared_settings_8h_source.html">SoftBodySharedSettings.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:abe9fe03ca75f96fea20b8ee693a2f873" id="r_abe9fe03ca75f96fea20b8ee693a2f873"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe9fe03ca75f96fea20b8ee693a2f873">DihedralBend</a> ()=default</td></tr>
  118. <tr class="memdesc:abe9fe03ca75f96fea20b8ee693a2f873"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  119. <tr class="separator:abe9fe03ca75f96fea20b8ee693a2f873"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:afe227a4f69c416f8047b276dcf350585" id="r_afe227a4f69c416f8047b276dcf350585"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe227a4f69c416f8047b276dcf350585">DihedralBend</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex1, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex2, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex3, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex4, float inCompliance=0.0f)</td></tr>
  121. <tr class="separator:afe227a4f69c416f8047b276dcf350585"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:af40fcceebc4074cd387372bb8bd60044" id="r_af40fcceebc4074cd387372bb8bd60044"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af40fcceebc4074cd387372bb8bd60044">GetMinVertexIndex</a> () const</td></tr>
  123. <tr class="memdesc:af40fcceebc4074cd387372bb8bd60044"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the lowest vertex index of this constraint. <br /></td></tr>
  124. <tr class="separator:af40fcceebc4074cd387372bb8bd60044"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table><table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  127. Public Attributes</h2></td></tr>
  128. <tr class="memitem:a8a2a36d080d6ca92f8badb53ef6e7f83" id="r_a8a2a36d080d6ca92f8badb53ef6e7f83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8a2a36d080d6ca92f8badb53ef6e7f83">mVertex</a> [4]</td></tr>
  129. <tr class="memdesc:a8a2a36d080d6ca92f8badb53ef6e7f83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indices of the vertices of the 2 triangles that share an edge (the first 2 vertices are the shared edge) <br /></td></tr>
  130. <tr class="separator:a8a2a36d080d6ca92f8badb53ef6e7f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ae2c290464bd3a9c43f12c48c8548b76d" id="r_ae2c290464bd3a9c43f12c48c8548b76d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2c290464bd3a9c43f12c48c8548b76d">mCompliance</a> = 0.0f</td></tr>
  132. <tr class="memdesc:ae2c290464bd3a9c43f12c48c8548b76d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse of the stiffness of the constraint. <br /></td></tr>
  133. <tr class="separator:ae2c290464bd3a9c43f12c48c8548b76d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a24ecaca4a5cb72ca51eef8a9fa739ea5" id="r_a24ecaca4a5cb72ca51eef8a9fa739ea5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a24ecaca4a5cb72ca51eef8a9fa739ea5">mInitialAngle</a> = 0.0f</td></tr>
  135. <tr class="memdesc:a24ecaca4a5cb72ca51eef8a9fa739ea5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initial angle between the normals of the triangles (pi - dihedral angle), calculated by CalculateBendConstraintConstants. <br /></td></tr>
  136. <tr class="separator:a24ecaca4a5cb72ca51eef8a9fa739ea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  139. <div class="textblock"><p>A dihedral bend constraint keeps the angle between two triangles constant along their shared edge. </p><pre class="fragment"> x2
  140. / \
  141. / t0 \
  142. x0----x1
  143. \ t1 /
  144. \ /
  145. x3
  146. </pre><p>x0..x3 are the vertices, t0 and t1 are the triangles that share the edge x0..x1</p>
  147. <p>Based on:</p><ul>
  148. <li>"Position Based Dynamics" - Matthias Muller et al.</li>
  149. <li>"Strain Based Dynamics" - Matthias Muller et al.</li>
  150. <li>"Simulation of Clothing with Folds and Wrinkles" - R. Bridson et al. </li>
  151. </ul>
  152. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  153. <a id="abe9fe03ca75f96fea20b8ee693a2f873" name="abe9fe03ca75f96fea20b8ee693a2f873"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#abe9fe03ca75f96fea20b8ee693a2f873">&#9670;&#160;</a></span>DihedralBend() <span class="overload">[1/2]</span></h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">SoftBodySharedSettings::DihedralBend::DihedralBend </td>
  163. <td>(</td>
  164. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Constructor. </p>
  175. </div>
  176. </div>
  177. <a id="afe227a4f69c416f8047b276dcf350585" name="afe227a4f69c416f8047b276dcf350585"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#afe227a4f69c416f8047b276dcf350585">&#9670;&#160;</a></span>DihedralBend() <span class="overload">[2/2]</span></h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="mlabels">
  182. <tr>
  183. <td class="mlabels-left">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">SoftBodySharedSettings::DihedralBend::DihedralBend </td>
  187. <td>(</td>
  188. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inVertex1</em></span>, </td>
  189. </tr>
  190. <tr>
  191. <td class="paramkey"></td>
  192. <td></td>
  193. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inVertex2</em></span>, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inVertex3</em></span>, </td>
  199. </tr>
  200. <tr>
  201. <td class="paramkey"></td>
  202. <td></td>
  203. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inVertex4</em></span>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inCompliance</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0.0f</span>&#160;)</td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. </div>
  218. </div>
  219. <h2 class="groupheader">Member Function Documentation</h2>
  220. <a id="af40fcceebc4074cd387372bb8bd60044" name="af40fcceebc4074cd387372bb8bd60044"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#af40fcceebc4074cd387372bb8bd60044">&#9670;&#160;</a></span>GetMinVertexIndex()</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> SoftBodySharedSettings::DihedralBend::GetMinVertexIndex </td>
  230. <td>(</td>
  231. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  232. <td> const</td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Return the lowest vertex index of this constraint. </p>
  242. </div>
  243. </div>
  244. <h2 class="groupheader">Member Data Documentation</h2>
  245. <a id="ae2c290464bd3a9c43f12c48c8548b76d" name="ae2c290464bd3a9c43f12c48c8548b76d"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#ae2c290464bd3a9c43f12c48c8548b76d">&#9670;&#160;</a></span>mCompliance</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">float SoftBodySharedSettings::DihedralBend::mCompliance = 0.0f</td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Inverse of the stiffness of the constraint. </p>
  256. </div>
  257. </div>
  258. <a id="a24ecaca4a5cb72ca51eef8a9fa739ea5" name="a24ecaca4a5cb72ca51eef8a9fa739ea5"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#a24ecaca4a5cb72ca51eef8a9fa739ea5">&#9670;&#160;</a></span>mInitialAngle</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">float SoftBodySharedSettings::DihedralBend::mInitialAngle = 0.0f</td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Initial angle between the normals of the triangles (pi - dihedral angle), calculated by CalculateBendConstraintConstants. </p>
  269. </div>
  270. </div>
  271. <a id="a8a2a36d080d6ca92f8badb53ef6e7f83" name="a8a2a36d080d6ca92f8badb53ef6e7f83"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a8a2a36d080d6ca92f8badb53ef6e7f83">&#9670;&#160;</a></span>mVertex</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> SoftBodySharedSettings::DihedralBend::mVertex[4]</td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Indices of the vertices of the 2 triangles that share an edge (the first 2 vertices are the shared edge) </p>
  282. </div>
  283. </div>
  284. <hr/>The documentation for this struct was generated from the following file:<ul>
  285. <li>Jolt/Physics/SoftBody/<a class="el" href="_soft_body_shared_settings_8h_source.html">SoftBodySharedSettings.h</a></li>
  286. </ul>
  287. </div><!-- contents -->
  288. </div><!-- doc-content -->
  289. <!-- start footer part -->
  290. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  291. <ul>
  292. <li class="navelem"><a class="el" href="class_soft_body_shared_settings.html">SoftBodySharedSettings</a></li><li class="navelem"><a class="el" href="struct_soft_body_shared_settings_1_1_dihedral_bend.html">DihedralBend</a></li>
  293. <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>
  294. </ul>
  295. </div>
  296. </body>
  297. </html>