class_float2.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  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: Float2 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_float2.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="#friends">Friends</a> &#124;
  110. <a href="class_float2-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">Float2 Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Class that holds 2 floats, used as a storage class mainly.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_float2_8h_source.html">Float2.h</a>&gt;</code></p>
  117. <table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  119. Public Member Functions</h2></td></tr>
  120. <tr class="memitem:a31453e22a3a71b53b16f33c8ea050fa3" id="r_a31453e22a3a71b53b16f33c8ea050fa3"><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="#a31453e22a3a71b53b16f33c8ea050fa3">Float2</a> ()=default</td></tr>
  121. <tr class="memdesc:a31453e22a3a71b53b16f33c8ea050fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intentionally not initialized for performance reasons. <br /></td></tr>
  122. <tr class="separator:a31453e22a3a71b53b16f33c8ea050fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a242b0c3c7ee3f270ad64a0a3ee6e0286" id="r_a242b0c3c7ee3f270ad64a0a3ee6e0286"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a242b0c3c7ee3f270ad64a0a3ee6e0286">Float2</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inRHS)=default</td></tr>
  124. <tr class="separator:a242b0c3c7ee3f270ad64a0a3ee6e0286"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ae430c9638f1d2c59dff1a3ef1367709c" id="r_ae430c9638f1d2c59dff1a3ef1367709c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float2.html">Float2</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae430c9638f1d2c59dff1a3ef1367709c">operator=</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inRHS)=default</td></tr>
  126. <tr class="separator:ae430c9638f1d2c59dff1a3ef1367709c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:abb998c59ebedddb6fe8742b7e7f8e990" id="r_abb998c59ebedddb6fe8742b7e7f8e990"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb998c59ebedddb6fe8742b7e7f8e990">Float2</a> (float inX, float inY)</td></tr>
  128. <tr class="separator:abb998c59ebedddb6fe8742b7e7f8e990"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a7ac3a21d32590f4e2fb7d5d12800175d" id="r_a7ac3a21d32590f4e2fb7d5d12800175d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ac3a21d32590f4e2fb7d5d12800175d">operator==</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inRHS) const</td></tr>
  130. <tr class="separator:a7ac3a21d32590f4e2fb7d5d12800175d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a96fca2374dcba65591ea81c7d16b9aa9" id="r_a96fca2374dcba65591ea81c7d16b9aa9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a96fca2374dcba65591ea81c7d16b9aa9">operator!=</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inRHS) const</td></tr>
  132. <tr class="separator:a96fca2374dcba65591ea81c7d16b9aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  135. Public Attributes</h2></td></tr>
  136. <tr class="memitem:a9f4577102bc9a7bdf9355b5776301485" id="r_a9f4577102bc9a7bdf9355b5776301485"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f4577102bc9a7bdf9355b5776301485">x</a></td></tr>
  137. <tr class="separator:a9f4577102bc9a7bdf9355b5776301485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a53deb463e8335f53a8f5454c9c3c0503" id="r_a53deb463e8335f53a8f5454c9c3c0503"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53deb463e8335f53a8f5454c9c3c0503">y</a></td></tr>
  139. <tr class="separator:a53deb463e8335f53a8f5454c9c3c0503"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
  142. Friends</h2></td></tr>
  143. <tr class="memitem:af71f1835f0b82c7faac9d7c3d27558e8" id="r_af71f1835f0b82c7faac9d7c3d27558e8"><td class="memItemLeft" align="right" valign="top">ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af71f1835f0b82c7faac9d7c3d27558e8">operator&lt;&lt;</a> (ostream &amp;inStream, const <a class="el" href="class_float2.html">Float2</a> &amp;inV)</td></tr>
  144. <tr class="memdesc:af71f1835f0b82c7faac9d7c3d27558e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">To String. <br /></td></tr>
  145. <tr class="separator:af71f1835f0b82c7faac9d7c3d27558e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  148. <div class="textblock"><p>Class that holds 2 floats, used as a storage class mainly. </p>
  149. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  150. <a id="a31453e22a3a71b53b16f33c8ea050fa3" name="a31453e22a3a71b53b16f33c8ea050fa3"></a>
  151. <h2 class="memtitle"><span class="permalink"><a href="#a31453e22a3a71b53b16f33c8ea050fa3">&#9670;&#160;</a></span>Float2() <span class="overload">[1/3]</span></h2>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="mlabels">
  155. <tr>
  156. <td class="mlabels-left">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> Float2::Float2 </td>
  160. <td>(</td>
  161. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </td>
  166. <td class="mlabels-right">
  167. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Intentionally not initialized for performance reasons. </p>
  172. </div>
  173. </div>
  174. <a id="a242b0c3c7ee3f270ad64a0a3ee6e0286" name="a242b0c3c7ee3f270ad64a0a3ee6e0286"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#a242b0c3c7ee3f270ad64a0a3ee6e0286">&#9670;&#160;</a></span>Float2() <span class="overload">[2/3]</span></h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">Float2::Float2 </td>
  184. <td>(</td>
  185. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. </div>
  196. </div>
  197. <a id="abb998c59ebedddb6fe8742b7e7f8e990" name="abb998c59ebedddb6fe8742b7e7f8e990"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#abb998c59ebedddb6fe8742b7e7f8e990">&#9670;&#160;</a></span>Float2() <span class="overload">[3/3]</span></h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="mlabels">
  202. <tr>
  203. <td class="mlabels-left">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">Float2::Float2 </td>
  207. <td>(</td>
  208. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inX</em></span>, </td>
  209. </tr>
  210. <tr>
  211. <td class="paramkey"></td>
  212. <td></td>
  213. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inY</em></span>&#160;)</td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. </div>
  223. </div>
  224. <h2 class="groupheader">Member Function Documentation</h2>
  225. <a id="a96fca2374dcba65591ea81c7d16b9aa9" name="a96fca2374dcba65591ea81c7d16b9aa9"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a96fca2374dcba65591ea81c7d16b9aa9">&#9670;&#160;</a></span>operator!=()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">bool Float2::operator!= </td>
  235. <td>(</td>
  236. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  237. <td> const</td>
  238. </tr>
  239. </table>
  240. </td>
  241. <td class="mlabels-right">
  242. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. </div>
  247. </div>
  248. <a id="ae430c9638f1d2c59dff1a3ef1367709c" name="ae430c9638f1d2c59dff1a3ef1367709c"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#ae430c9638f1d2c59dff1a3ef1367709c">&#9670;&#160;</a></span>operator=()</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname"><a class="el" href="class_float2.html">Float2</a> &amp; Float2::operator= </td>
  258. <td>(</td>
  259. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. </div>
  270. </div>
  271. <a id="a7ac3a21d32590f4e2fb7d5d12800175d" name="a7ac3a21d32590f4e2fb7d5d12800175d"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a7ac3a21d32590f4e2fb7d5d12800175d">&#9670;&#160;</a></span>operator==()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">bool Float2::operator== </td>
  281. <td>(</td>
  282. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  283. <td> const</td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. </div>
  293. </div>
  294. <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
  295. <a id="af71f1835f0b82c7faac9d7c3d27558e8" name="af71f1835f0b82c7faac9d7c3d27558e8"></a>
  296. <h2 class="memtitle"><span class="permalink"><a href="#af71f1835f0b82c7faac9d7c3d27558e8">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="mlabels">
  300. <tr>
  301. <td class="mlabels-left">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">ostream &amp; operator&lt;&lt; </td>
  305. <td>(</td>
  306. <td class="paramtype">ostream &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inV</em></span>&#160;)</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>To String. </p>
  321. </div>
  322. </div>
  323. <h2 class="groupheader">Member Data Documentation</h2>
  324. <a id="a9f4577102bc9a7bdf9355b5776301485" name="a9f4577102bc9a7bdf9355b5776301485"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a9f4577102bc9a7bdf9355b5776301485">&#9670;&#160;</a></span>x</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">float Float2::x</td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. </div>
  335. </div>
  336. <a id="a53deb463e8335f53a8f5454c9c3c0503" name="a53deb463e8335f53a8f5454c9c3c0503"></a>
  337. <h2 class="memtitle"><span class="permalink"><a href="#a53deb463e8335f53a8f5454c9c3c0503">&#9670;&#160;</a></span>y</h2>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">float Float2::y</td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. </div>
  347. </div>
  348. <hr/>The documentation for this class was generated from the following file:<ul>
  349. <li>Jolt/Math/<a class="el" href="_float2_8h_source.html">Float2.h</a></li>
  350. </ul>
  351. </div><!-- contents -->
  352. </div><!-- doc-content -->
  353. <!-- start footer part -->
  354. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  355. <ul>
  356. <li class="navelem"><a class="el" href="class_float2.html">Float2</a></li>
  357. <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>
  358. </ul>
  359. </div>
  360. </body>
  361. </html>