class_triangle.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  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: Triangle 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_triangle.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_triangle-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">Triangle Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>A simple triangle and its material.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_triangle_8h_source.html">Triangle.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:ab77028569270c58b230bade2e050f0e8" id="r_ab77028569270c58b230bade2e050f0e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab77028569270c58b230bade2e050f0e8">Triangle</a> ()=default</td></tr>
  120. <tr class="memdesc:ab77028569270c58b230bade2e050f0e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  121. <tr class="separator:ab77028569270c58b230bade2e050f0e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a63e1c516f7be617386e6fb7ba751e559" id="r_a63e1c516f7be617386e6fb7ba751e559"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a63e1c516f7be617386e6fb7ba751e559">Triangle</a> (const <a class="el" href="class_float3.html">Float3</a> &amp;inV1, const <a class="el" href="class_float3.html">Float3</a> &amp;inV2, const <a class="el" href="class_float3.html">Float3</a> &amp;inV3, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inMaterialIndex=0, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inUserData=0)</td></tr>
  123. <tr class="separator:a63e1c516f7be617386e6fb7ba751e559"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:afa9373651d38b12839903be6a01ccc6f" id="r_afa9373651d38b12839903be6a01ccc6f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa9373651d38b12839903be6a01ccc6f">Triangle</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inV1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inV2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inV3, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inMaterialIndex=0, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inUserData=0)</td></tr>
  125. <tr class="separator:afa9373651d38b12839903be6a01ccc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a680a9a904aaad1f8a495f8ec667fbf70" id="r_a680a9a904aaad1f8a495f8ec667fbf70"><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="#a680a9a904aaad1f8a495f8ec667fbf70">GetCentroid</a> () const</td></tr>
  127. <tr class="memdesc:a680a9a904aaad1f8a495f8ec667fbf70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get center of triangle. <br /></td></tr>
  128. <tr class="separator:a680a9a904aaad1f8a495f8ec667fbf70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  131. Public Attributes</h2></td></tr>
  132. <tr class="memitem:add833346b63769a08d6d868195c9b6a5" id="r_add833346b63769a08d6d868195c9b6a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float3.html">Float3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#add833346b63769a08d6d868195c9b6a5">mV</a> [3]</td></tr>
  133. <tr class="memdesc:add833346b63769a08d6d868195c9b6a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vertices. <br /></td></tr>
  134. <tr class="separator:add833346b63769a08d6d868195c9b6a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a7f441edf952be97bf6110750c69b620a" id="r_a7f441edf952be97bf6110750c69b620a"><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="#a7f441edf952be97bf6110750c69b620a">mMaterialIndex</a> = 0</td></tr>
  136. <tr class="memdesc:a7f441edf952be97bf6110750c69b620a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Follows mV[3] so that we can read mV as 4 vectors. <br /></td></tr>
  137. <tr class="separator:a7f441edf952be97bf6110750c69b620a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:aafe91e923394d83ed4ee872bc2164ca5" id="r_aafe91e923394d83ed4ee872bc2164ca5"><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="#aafe91e923394d83ed4ee872bc2164ca5">mUserData</a> = 0</td></tr>
  139. <tr class="memdesc:aafe91e923394d83ed4ee872bc2164ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data that can be used for anything by the application, e.g. for tracking the original index of the triangle. <br /></td></tr>
  140. <tr class="separator:aafe91e923394d83ed4ee872bc2164ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table>
  142. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  143. <div class="textblock"><p>A simple triangle and its material. </p>
  144. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  145. <a id="ab77028569270c58b230bade2e050f0e8" name="ab77028569270c58b230bade2e050f0e8"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#ab77028569270c58b230bade2e050f0e8">&#9670;&#160;</a></span>Triangle() <span class="overload">[1/3]</span></h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> Triangle::Triangle </td>
  155. <td>(</td>
  156. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </td>
  161. <td class="mlabels-right">
  162. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Constructor. </p>
  167. </div>
  168. </div>
  169. <a id="a63e1c516f7be617386e6fb7ba751e559" name="a63e1c516f7be617386e6fb7ba751e559"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a63e1c516f7be617386e6fb7ba751e559">&#9670;&#160;</a></span>Triangle() <span class="overload">[2/3]</span></h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">Triangle::Triangle </td>
  179. <td>(</td>
  180. <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inV1</em></span>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inV2</em></span>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inV3</em></span>, </td>
  191. </tr>
  192. <tr>
  193. <td class="paramkey"></td>
  194. <td></td>
  195. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inMaterialIndex</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inUserData</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
  201. </tr>
  202. </table>
  203. </td>
  204. <td class="mlabels-right">
  205. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. </div>
  210. </div>
  211. <a id="afa9373651d38b12839903be6a01ccc6f" name="afa9373651d38b12839903be6a01ccc6f"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#afa9373651d38b12839903be6a01ccc6f">&#9670;&#160;</a></span>Triangle() <span class="overload">[3/3]</span></h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="mlabels">
  216. <tr>
  217. <td class="mlabels-left">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">Triangle::Triangle </td>
  221. <td>(</td>
  222. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inV1</em></span>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inV2</em></span>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inV3</em></span>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inMaterialIndex</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inUserData</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
  243. </tr>
  244. </table>
  245. </td>
  246. <td class="mlabels-right">
  247. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. </div>
  252. </div>
  253. <h2 class="groupheader">Member Function Documentation</h2>
  254. <a id="a680a9a904aaad1f8a495f8ec667fbf70" name="a680a9a904aaad1f8a495f8ec667fbf70"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a680a9a904aaad1f8a495f8ec667fbf70">&#9670;&#160;</a></span>GetCentroid()</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> Triangle::GetCentroid </td>
  264. <td>(</td>
  265. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  266. <td> const</td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>Get center of triangle. </p>
  276. </div>
  277. </div>
  278. <h2 class="groupheader">Member Data Documentation</h2>
  279. <a id="a7f441edf952be97bf6110750c69b620a" name="a7f441edf952be97bf6110750c69b620a"></a>
  280. <h2 class="memtitle"><span class="permalink"><a href="#a7f441edf952be97bf6110750c69b620a">&#9670;&#160;</a></span>mMaterialIndex</h2>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> Triangle::mMaterialIndex = 0</td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Follows mV[3] so that we can read mV as 4 vectors. </p>
  290. </div>
  291. </div>
  292. <a id="aafe91e923394d83ed4ee872bc2164ca5" name="aafe91e923394d83ed4ee872bc2164ca5"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#aafe91e923394d83ed4ee872bc2164ca5">&#9670;&#160;</a></span>mUserData</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> Triangle::mUserData = 0</td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>User data that can be used for anything by the application, e.g. for tracking the original index of the triangle. </p>
  303. </div>
  304. </div>
  305. <a id="add833346b63769a08d6d868195c9b6a5" name="add833346b63769a08d6d868195c9b6a5"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#add833346b63769a08d6d868195c9b6a5">&#9670;&#160;</a></span>mV</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname"><a class="el" href="class_float3.html">Float3</a> Triangle::mV[3]</td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Vertices. </p>
  316. </div>
  317. </div>
  318. <hr/>The documentation for this class was generated from the following file:<ul>
  319. <li>Jolt/Geometry/<a class="el" href="_triangle_8h_source.html">Triangle.h</a></li>
  320. </ul>
  321. </div><!-- contents -->
  322. </div><!-- doc-content -->
  323. <!-- start footer part -->
  324. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  325. <ul>
  326. <li class="navelem"><a class="el" href="class_triangle.html">Triangle</a></li>
  327. <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>
  328. </ul>
  329. </div>
  330. </body>
  331. </html>