class_contact_constraint_manager_1_1_contact_allocator.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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: ContactConstraintManager::ContactAllocator 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_contact_constraint_manager_1_1_contact_allocator.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_contact_constraint_manager_1_1_contact_allocator-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">ContactConstraintManager::ContactAllocator Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Contacts are allocated in a lock free hash map.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_contact_constraint_manager_8h_source.html">ContactConstraintManager.h</a>&gt;</code></p>
  116. <div class="dynheader">
  117. Inheritance diagram for ContactConstraintManager::ContactAllocator:</div>
  118. <div class="dyncontent">
  119. <div class="center">
  120. <img src="class_contact_constraint_manager_1_1_contact_allocator.png" usemap="#ContactConstraintManager::ContactAllocator_map" alt=""/>
  121. <map id="ContactConstraintManager::ContactAllocator_map" name="ContactConstraintManager::ContactAllocator_map">
  122. <area href="class_l_f_h_m_allocator_context.html" alt="LFHMAllocatorContext" shape="rect" coords="0,56,263,80"/>
  123. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,263,24"/>
  124. </map>
  125. </div></div>
  126. <table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  128. Public Member Functions</h2></td></tr>
  129. <tr class="memitem:a4937e72fe7c08c45687b9deb3c3dba32" id="r_a4937e72fe7c08c45687b9deb3c3dba32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4937e72fe7c08c45687b9deb3c3dba32">LFHMAllocatorContext</a> (<a class="el" href="class_l_f_h_m_allocator.html">LFHMAllocator</a> &amp;inAllocator, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inBlockSize)</td></tr>
  130. <tr class="memdesc:a4937e72fe7c08c45687b9deb3c3dba32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new allocator context. <br /></td></tr>
  131. <tr class="separator:a4937e72fe7c08c45687b9deb3c3dba32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="inherit_header pub_methods_class_l_f_h_m_allocator_context"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_l_f_h_m_allocator_context')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_l_f_h_m_allocator_context.html">LFHMAllocatorContext</a></td></tr>
  133. <tr class="memitem:a4937e72fe7c08c45687b9deb3c3dba32 inherit pub_methods_class_l_f_h_m_allocator_context" id="r_a4937e72fe7c08c45687b9deb3c3dba32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_f_h_m_allocator_context.html#a4937e72fe7c08c45687b9deb3c3dba32">LFHMAllocatorContext</a> (<a class="el" href="class_l_f_h_m_allocator.html">LFHMAllocator</a> &amp;inAllocator, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inBlockSize)</td></tr>
  134. <tr class="memdesc:a4937e72fe7c08c45687b9deb3c3dba32 inherit pub_methods_class_l_f_h_m_allocator_context"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new allocator context. <br /></td></tr>
  135. <tr class="separator:a4937e72fe7c08c45687b9deb3c3dba32 inherit pub_methods_class_l_f_h_m_allocator_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:afc85e525f6ca72b286aea4cdf693ac7f inherit pub_methods_class_l_f_h_m_allocator_context" id="r_afc85e525f6ca72b286aea4cdf693ac7f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_f_h_m_allocator_context.html#afc85e525f6ca72b286aea4cdf693ac7f">Allocate</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inSize, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inAlignment, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &amp;outWriteOffset)</td></tr>
  137. <tr class="memdesc:afc85e525f6ca72b286aea4cdf693ac7f inherit pub_methods_class_l_f_h_m_allocator_context"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate data block. <br /></td></tr>
  138. <tr class="separator:afc85e525f6ca72b286aea4cdf693ac7f inherit pub_methods_class_l_f_h_m_allocator_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
  140. <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
  141. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  143. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  145. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table><table class="memberdecls">
  147. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  148. Public Attributes</h2></td></tr>
  149. <tr class="memitem:a1f988bcee137591463666032293d8357" id="r_a1f988bcee137591463666032293d8357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f988bcee137591463666032293d8357">mNumBodyPairs</a> = 0</td></tr>
  150. <tr class="memdesc:a1f988bcee137591463666032293d8357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of body pairs added using this allocator. <br /></td></tr>
  151. <tr class="separator:a1f988bcee137591463666032293d8357"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a7a95eb0a19e0b32c637eadf107977c3c" id="r_a7a95eb0a19e0b32c637eadf107977c3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a95eb0a19e0b32c637eadf107977c3c">mNumManifolds</a> = 0</td></tr>
  153. <tr class="memdesc:a7a95eb0a19e0b32c637eadf107977c3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of manifolds added using this allocator. <br /></td></tr>
  154. <tr class="separator:a7a95eb0a19e0b32c637eadf107977c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a1968130257ab4041d6e18c676869fdd3" id="r_a1968130257ab4041d6e18c676869fdd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_e_physics_update_error_8h.html#a1df3f14c5cc9f3be49f239b17470aaa1">EPhysicsUpdateError</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1968130257ab4041d6e18c676869fdd3">mErrors</a> = <a class="el" href="_e_physics_update_error_8h.html#a1df3f14c5cc9f3be49f239b17470aaa1a6adf97f83acf6453d4a6a4b1070f3754">EPhysicsUpdateError::None</a></td></tr>
  156. <tr class="memdesc:a1968130257ab4041d6e18c676869fdd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Errors reported on this allocator. <br /></td></tr>
  157. <tr class="separator:a1968130257ab4041d6e18c676869fdd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table>
  159. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  160. <div class="textblock"><p>Contacts are allocated in a lock free hash map. </p>
  161. </div><h2 class="groupheader">Member Function Documentation</h2>
  162. <a id="a4937e72fe7c08c45687b9deb3c3dba32" name="a4937e72fe7c08c45687b9deb3c3dba32"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#a4937e72fe7c08c45687b9deb3c3dba32">&#9670;&#160;</a></span>LFHMAllocatorContext()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">LFHMAllocatorContext::LFHMAllocatorContext </td>
  172. <td>(</td>
  173. <td class="paramtype"><a class="el" href="class_l_f_h_m_allocator.html">LFHMAllocator</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inAllocator</em></span>, </td>
  174. </tr>
  175. <tr>
  176. <td class="paramkey"></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>inBlockSize</em></span>&#160;)</td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Construct a new allocator context. </p>
  188. </div>
  189. </div>
  190. <h2 class="groupheader">Member Data Documentation</h2>
  191. <a id="a1968130257ab4041d6e18c676869fdd3" name="a1968130257ab4041d6e18c676869fdd3"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#a1968130257ab4041d6e18c676869fdd3">&#9670;&#160;</a></span>mErrors</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="_e_physics_update_error_8h.html#a1df3f14c5cc9f3be49f239b17470aaa1">EPhysicsUpdateError</a> ContactConstraintManager::ContactAllocator::mErrors = <a class="el" href="_e_physics_update_error_8h.html#a1df3f14c5cc9f3be49f239b17470aaa1a6adf97f83acf6453d4a6a4b1070f3754">EPhysicsUpdateError::None</a></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Errors reported on this allocator. </p>
  202. </div>
  203. </div>
  204. <a id="a1f988bcee137591463666032293d8357" name="a1f988bcee137591463666032293d8357"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a1f988bcee137591463666032293d8357">&#9670;&#160;</a></span>mNumBodyPairs</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> ContactConstraintManager::ContactAllocator::mNumBodyPairs = 0</td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Total number of body pairs added using this allocator. </p>
  215. </div>
  216. </div>
  217. <a id="a7a95eb0a19e0b32c637eadf107977c3c" name="a7a95eb0a19e0b32c637eadf107977c3c"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#a7a95eb0a19e0b32c637eadf107977c3c">&#9670;&#160;</a></span>mNumManifolds</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> ContactConstraintManager::ContactAllocator::mNumManifolds = 0</td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Total number of manifolds added using this allocator. </p>
  228. </div>
  229. </div>
  230. <hr/>The documentation for this class was generated from the following file:<ul>
  231. <li>Jolt/Physics/Constraints/<a class="el" href="_contact_constraint_manager_8h_source.html">ContactConstraintManager.h</a></li>
  232. </ul>
  233. </div><!-- contents -->
  234. </div><!-- doc-content -->
  235. <!-- start footer part -->
  236. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  237. <ul>
  238. <li class="navelem"><a class="el" href="class_contact_constraint_manager.html">ContactConstraintManager</a></li><li class="navelem"><a class="el" href="class_contact_constraint_manager_1_1_contact_allocator.html">ContactAllocator</a></li>
  239. <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>
  240. </ul>
  241. </div>
  242. </body>
  243. </html>