struct_soft_body_shared_settings_1_1_edge.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  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::Edge 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_edge.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_edge-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">SoftBodySharedSettings::Edge Struct Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>An edge keeps two vertices at a constant distance using a spring: |x1 - x2| = rest length.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_soft_body_shared_settings_8h_source.html">SoftBodySharedSettings.h</a>&gt;</code></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  118. Public Member Functions</h2></td></tr>
  119. <tr class="memitem:a6330e512065ff11935b9fb0f04b5db6c" id="r_a6330e512065ff11935b9fb0f04b5db6c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6330e512065ff11935b9fb0f04b5db6c">Edge</a> ()=default</td></tr>
  120. <tr class="memdesc:a6330e512065ff11935b9fb0f04b5db6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  121. <tr class="separator:a6330e512065ff11935b9fb0f04b5db6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a88c7b84c4d66a6bcfd19939c30c837ac" id="r_a88c7b84c4d66a6bcfd19939c30c837ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88c7b84c4d66a6bcfd19939c30c837ac">Edge</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex1, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inVertex2, float inCompliance=0.0f)</td></tr>
  123. <tr class="separator:a88c7b84c4d66a6bcfd19939c30c837ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a2542e95a101443bb88ef41b38e569a8d" id="r_a2542e95a101443bb88ef41b38e569a8d"><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="#a2542e95a101443bb88ef41b38e569a8d">GetMinVertexIndex</a> () const</td></tr>
  125. <tr class="memdesc:a2542e95a101443bb88ef41b38e569a8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the lowest vertex index of this constraint. <br /></td></tr>
  126. <tr class="separator:a2542e95a101443bb88ef41b38e569a8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table><table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  129. Public Attributes</h2></td></tr>
  130. <tr class="memitem:a10368fe4bdfd3de764f0e5cbbf48371c" id="r_a10368fe4bdfd3de764f0e5cbbf48371c"><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="#a10368fe4bdfd3de764f0e5cbbf48371c">mVertex</a> [2]</td></tr>
  131. <tr class="memdesc:a10368fe4bdfd3de764f0e5cbbf48371c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indices of the vertices that form the edge. <br /></td></tr>
  132. <tr class="separator:a10368fe4bdfd3de764f0e5cbbf48371c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a4a1fbe8d069c6c9c13a12dc8f951959a" id="r_a4a1fbe8d069c6c9c13a12dc8f951959a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a1fbe8d069c6c9c13a12dc8f951959a">mRestLength</a> = 1.0f</td></tr>
  134. <tr class="memdesc:a4a1fbe8d069c6c9c13a12dc8f951959a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rest length of the spring, calculated by CalculateEdgeLengths. <br /></td></tr>
  135. <tr class="separator:a4a1fbe8d069c6c9c13a12dc8f951959a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a2a10f9d5aad98552ac275597a4f991fb" id="r_a2a10f9d5aad98552ac275597a4f991fb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a10f9d5aad98552ac275597a4f991fb">mCompliance</a> = 0.0f</td></tr>
  137. <tr class="memdesc:a2a10f9d5aad98552ac275597a4f991fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse of the stiffness of the spring. <br /></td></tr>
  138. <tr class="separator:a2a10f9d5aad98552ac275597a4f991fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  141. <div class="textblock"><p>An edge keeps two vertices at a constant distance using a spring: |x1 - x2| = rest length. </p>
  142. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  143. <a id="a6330e512065ff11935b9fb0f04b5db6c" name="a6330e512065ff11935b9fb0f04b5db6c"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#a6330e512065ff11935b9fb0f04b5db6c">&#9670;&#160;</a></span>Edge() <span class="overload">[1/2]</span></h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="mlabels">
  148. <tr>
  149. <td class="mlabels-left">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">SoftBodySharedSettings::Edge::Edge </td>
  153. <td>(</td>
  154. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </td>
  159. <td class="mlabels-right">
  160. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Constructor. </p>
  165. </div>
  166. </div>
  167. <a id="a88c7b84c4d66a6bcfd19939c30c837ac" name="a88c7b84c4d66a6bcfd19939c30c837ac"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#a88c7b84c4d66a6bcfd19939c30c837ac">&#9670;&#160;</a></span>Edge() <span class="overload">[2/2]</span></h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="mlabels">
  172. <tr>
  173. <td class="mlabels-left">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">SoftBodySharedSettings::Edge::Edge </td>
  177. <td>(</td>
  178. <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>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <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>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <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>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <h2 class="groupheader">Member Function Documentation</h2>
  200. <a id="a2542e95a101443bb88ef41b38e569a8d" name="a2542e95a101443bb88ef41b38e569a8d"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#a2542e95a101443bb88ef41b38e569a8d">&#9670;&#160;</a></span>GetMinVertexIndex()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> SoftBodySharedSettings::Edge::GetMinVertexIndex </td>
  210. <td>(</td>
  211. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  212. <td> const</td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Return the lowest vertex index of this constraint. </p>
  222. </div>
  223. </div>
  224. <h2 class="groupheader">Member Data Documentation</h2>
  225. <a id="a2a10f9d5aad98552ac275597a4f991fb" name="a2a10f9d5aad98552ac275597a4f991fb"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a2a10f9d5aad98552ac275597a4f991fb">&#9670;&#160;</a></span>mCompliance</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">float SoftBodySharedSettings::Edge::mCompliance = 0.0f</td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>Inverse of the stiffness of the spring. </p>
  236. </div>
  237. </div>
  238. <a id="a4a1fbe8d069c6c9c13a12dc8f951959a" name="a4a1fbe8d069c6c9c13a12dc8f951959a"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#a4a1fbe8d069c6c9c13a12dc8f951959a">&#9670;&#160;</a></span>mRestLength</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">float SoftBodySharedSettings::Edge::mRestLength = 1.0f</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Rest length of the spring, calculated by CalculateEdgeLengths. </p>
  249. </div>
  250. </div>
  251. <a id="a10368fe4bdfd3de764f0e5cbbf48371c" name="a10368fe4bdfd3de764f0e5cbbf48371c"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a10368fe4bdfd3de764f0e5cbbf48371c">&#9670;&#160;</a></span>mVertex</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> SoftBodySharedSettings::Edge::mVertex[2]</td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Indices of the vertices that form the edge. </p>
  262. </div>
  263. </div>
  264. <hr/>The documentation for this struct was generated from the following file:<ul>
  265. <li>Jolt/Physics/SoftBody/<a class="el" href="_soft_body_shared_settings_8h_source.html">SoftBodySharedSettings.h</a></li>
  266. </ul>
  267. </div><!-- contents -->
  268. </div><!-- doc-content -->
  269. <!-- start footer part -->
  270. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  271. <ul>
  272. <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_edge.html">Edge</a></li>
  273. <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>
  274. </ul>
  275. </div>
  276. </body>
  277. </html>