_register_types_8h.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  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: Jolt/RegisterTypes.h File 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('_register_types_8h.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="#func-members">Functions</a> </div>
  108. <div class="headertitle"><div class="title">RegisterTypes.h File Reference</div></div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <p><a href="_register_types_8h_source.html">Go to the source code of this file.</a></p>
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  114. Functions</h2></td></tr>
  115. <tr class="memitem:a620b2773885e137277e118ddfee651bf" id="r_a620b2773885e137277e118ddfee651bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a620b2773885e137277e118ddfee651bf">VerifyJoltVersionIDInternal</a> (<a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inVersionID)</td></tr>
  116. <tr class="memdesc:a620b2773885e137277e118ddfee651bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal helper function. <br /></td></tr>
  117. <tr class="separator:a620b2773885e137277e118ddfee651bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a5f4143a97d828fbf326eaf25a5323e17" id="r_a5f4143a97d828fbf326eaf25a5323e17"><td class="memItemLeft" align="right" valign="top">JPH_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f4143a97d828fbf326eaf25a5323e17">VerifyJoltVersionID</a> ()</td></tr>
  119. <tr class="separator:a5f4143a97d828fbf326eaf25a5323e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a8df860236f81c6ffec261b6bd62847ba" id="r_a8df860236f81c6ffec261b6bd62847ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8df860236f81c6ffec261b6bd62847ba">RegisterTypesInternal</a> (<a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inVersionID)</td></tr>
  121. <tr class="memdesc:a8df860236f81c6ffec261b6bd62847ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal helper function. <br /></td></tr>
  122. <tr class="separator:a8df860236f81c6ffec261b6bd62847ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a033e662bc8b7d5a8acd9adcc692b7cb4" id="r_a033e662bc8b7d5a8acd9adcc692b7cb4"><td class="memItemLeft" align="right" valign="top">JPH_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a033e662bc8b7d5a8acd9adcc692b7cb4">RegisterTypes</a> ()</td></tr>
  124. <tr class="separator:a033e662bc8b7d5a8acd9adcc692b7cb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a1e0db6031789e773039c7fc15ef47057" id="r_a1e0db6031789e773039c7fc15ef47057"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e0db6031789e773039c7fc15ef47057">UnregisterTypes</a> ()</td></tr>
  126. <tr class="memdesc:a1e0db6031789e773039c7fc15ef47057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters all types with the factory and cleans up the default material. <br /></td></tr>
  127. <tr class="separator:a1e0db6031789e773039c7fc15ef47057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table>
  129. <h2 class="groupheader">Function Documentation</h2>
  130. <a id="a033e662bc8b7d5a8acd9adcc692b7cb4" name="a033e662bc8b7d5a8acd9adcc692b7cb4"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a033e662bc8b7d5a8acd9adcc692b7cb4">&#9670;&#160;</a></span>RegisterTypes()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">JPH_INLINE void RegisterTypes </td>
  137. <td>(</td>
  138. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Register all physics types with the factory and install their collision handlers with the <a class="el" href="class_collision_dispatch.html" title="Dispatch function, main function to handle collisions between shapes.">CollisionDispatch</a> class. If you have your own custom shape types you probably need to register their handlers with the <a class="el" href="class_collision_dispatch.html" title="Dispatch function, main function to handle collisions between shapes.">CollisionDispatch</a> before calling this function. If you implement your own default material (<a class="el" href="class_physics_material.html#af51825c643c3cafc49e007d8ca1c14cd" title="Default material that is used when a shape has no materials defined.">PhysicsMaterial::sDefault</a>) make sure to initialize it before this function or else this function will create one for you. </p>
  144. </div>
  145. </div>
  146. <a id="a8df860236f81c6ffec261b6bd62847ba" name="a8df860236f81c6ffec261b6bd62847ba"></a>
  147. <h2 class="memtitle"><span class="permalink"><a href="#a8df860236f81c6ffec261b6bd62847ba">&#9670;&#160;</a></span>RegisterTypesInternal()</h2>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void RegisterTypesInternal </td>
  156. <td>(</td>
  157. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inVersionID</em></span></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Internal helper function. </p>
  168. </div>
  169. </div>
  170. <a id="a1e0db6031789e773039c7fc15ef47057" name="a1e0db6031789e773039c7fc15ef47057"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#a1e0db6031789e773039c7fc15ef47057">&#9670;&#160;</a></span>UnregisterTypes()</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="mlabels">
  175. <tr>
  176. <td class="mlabels-left">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void UnregisterTypes </td>
  180. <td>(</td>
  181. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  182. <td></td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Unregisters all types with the factory and cleans up the default material. </p>
  192. </div>
  193. </div>
  194. <a id="a5f4143a97d828fbf326eaf25a5323e17" name="a5f4143a97d828fbf326eaf25a5323e17"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#a5f4143a97d828fbf326eaf25a5323e17">&#9670;&#160;</a></span>VerifyJoltVersionID()</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">JPH_INLINE bool VerifyJoltVersionID </td>
  201. <td>(</td>
  202. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>This function can be used to verify the library ABI is compatible with your application. Use it in this way: <code>assert(VerifyJoltVersionID());</code>. Returns <code>false</code> if the library used is not compatible with your app. </p>
  208. </div>
  209. </div>
  210. <a id="a620b2773885e137277e118ddfee651bf" name="a620b2773885e137277e118ddfee651bf"></a>
  211. <h2 class="memtitle"><span class="permalink"><a href="#a620b2773885e137277e118ddfee651bf">&#9670;&#160;</a></span>VerifyJoltVersionIDInternal()</h2>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="mlabels">
  215. <tr>
  216. <td class="mlabels-left">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> bool VerifyJoltVersionIDInternal </td>
  220. <td>(</td>
  221. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inVersionID</em></span></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Internal helper function. </p>
  232. </div>
  233. </div>
  234. </div><!-- contents -->
  235. </div><!-- doc-content -->
  236. <!-- start footer part -->
  237. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  238. <ul>
  239. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="_register_types_8h.html">RegisterTypes.h</a></li>
  240. <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>
  241. </ul>
  242. </div>
  243. </body>
  244. </html>