cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: Float3 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_float3.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_float3-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Float3 Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Class that holds 3 floats. Used as a storage class. Convert to <a class="el" href="class_vec3.html">Vec3</a> for calculations.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_float3_8h_source.html">Float3.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aba5b9d056afa088269bfe243c44380b7" id="r_aba5b9d056afa088269bfe243c44380b7"><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="#aba5b9d056afa088269bfe243c44380b7">Float3</a> ()=default</td></tr>
<tr class="memdesc:aba5b9d056afa088269bfe243c44380b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intentionally not initialized for performance reasons.  <br /></td></tr>
<tr class="separator:aba5b9d056afa088269bfe243c44380b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae71f5544521095ffdeed2109dbf54d96" id="r_ae71f5544521095ffdeed2109dbf54d96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae71f5544521095ffdeed2109dbf54d96">Float3</a> (const <a class="el" href="class_float3.html">Float3</a> &amp;inRHS)=default</td></tr>
<tr class="separator:ae71f5544521095ffdeed2109dbf54d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaafccfdb546279ec28fcabc6c3dda3e8" id="r_aaafccfdb546279ec28fcabc6c3dda3e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float3.html">Float3</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaafccfdb546279ec28fcabc6c3dda3e8">operator=</a> (const <a class="el" href="class_float3.html">Float3</a> &amp;inRHS)=default</td></tr>
<tr class="separator:aaafccfdb546279ec28fcabc6c3dda3e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d2277dc1efc95eb284c72c1313809fc" id="r_a4d2277dc1efc95eb284c72c1313809fc"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d2277dc1efc95eb284c72c1313809fc">Float3</a> (float inX, float inY, float inZ)</td></tr>
<tr class="separator:a4d2277dc1efc95eb284c72c1313809fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ad9c4781e5a529fd150e72b1e234ee" id="r_a89ad9c4781e5a529fd150e72b1e234ee"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a89ad9c4781e5a529fd150e72b1e234ee">operator[]</a> (int inCoordinate) const</td></tr>
<tr class="separator:a89ad9c4781e5a529fd150e72b1e234ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fdec8037d0ca21ee14cca74ddd00a71" id="r_a6fdec8037d0ca21ee14cca74ddd00a71"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6fdec8037d0ca21ee14cca74ddd00a71">operator==</a> (const <a class="el" href="class_float3.html">Float3</a> &amp;inRHS) const</td></tr>
<tr class="separator:a6fdec8037d0ca21ee14cca74ddd00a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc6115cac5c0209c110e319de7a5f01a" id="r_acc6115cac5c0209c110e319de7a5f01a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc6115cac5c0209c110e319de7a5f01a">operator!=</a> (const <a class="el" href="class_float3.html">Float3</a> &amp;inRHS) const</td></tr>
<tr class="separator:acc6115cac5c0209c110e319de7a5f01a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac596e0cf37e992db116ebe169ec6cd2d" id="r_ac596e0cf37e992db116ebe169ec6cd2d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac596e0cf37e992db116ebe169ec6cd2d">x</a></td></tr>
<tr class="separator:ac596e0cf37e992db116ebe169ec6cd2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86c923e4acaf36c9d325bca554b3f3a9" id="r_a86c923e4acaf36c9d325bca554b3f3a9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86c923e4acaf36c9d325bca554b3f3a9">y</a></td></tr>
<tr class="separator:a86c923e4acaf36c9d325bca554b3f3a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a921399d2713f5b390fcf6060d7ccac00" id="r_a921399d2713f5b390fcf6060d7ccac00"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a921399d2713f5b390fcf6060d7ccac00">z</a></td></tr>
<tr class="separator:a921399d2713f5b390fcf6060d7ccac00"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class that holds 3 floats. Used as a storage class. Convert to <a class="el" href="class_vec3.html">Vec3</a> for calculations. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aba5b9d056afa088269bfe243c44380b7" name="aba5b9d056afa088269bfe243c44380b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba5b9d056afa088269bfe243c44380b7">&#9670;&#160;</a></span>Float3() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> Float3::Float3 </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Intentionally not initialized for performance reasons. </p>

</div>
</div>
<a id="ae71f5544521095ffdeed2109dbf54d96" name="ae71f5544521095ffdeed2109dbf54d96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae71f5544521095ffdeed2109dbf54d96">&#9670;&#160;</a></span>Float3() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Float3::Float3 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a4d2277dc1efc95eb284c72c1313809fc" name="a4d2277dc1efc95eb284c72c1313809fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2277dc1efc95eb284c72c1313809fc">&#9670;&#160;</a></span>Float3() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Float3::Float3 </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inY</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inZ</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acc6115cac5c0209c110e319de7a5f01a" name="acc6115cac5c0209c110e319de7a5f01a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc6115cac5c0209c110e319de7a5f01a">&#9670;&#160;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool Float3::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aaafccfdb546279ec28fcabc6c3dda3e8" name="aaafccfdb546279ec28fcabc6c3dda3e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaafccfdb546279ec28fcabc6c3dda3e8">&#9670;&#160;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_float3.html">Float3</a> &amp; Float3::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a6fdec8037d0ca21ee14cca74ddd00a71" name="a6fdec8037d0ca21ee14cca74ddd00a71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fdec8037d0ca21ee14cca74ddd00a71">&#9670;&#160;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool Float3::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_float3.html">Float3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a89ad9c4781e5a529fd150e72b1e234ee" name="a89ad9c4781e5a529fd150e72b1e234ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89ad9c4781e5a529fd150e72b1e234ee">&#9670;&#160;</a></span>operator[]()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float Float3::operator[] </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCoordinate</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac596e0cf37e992db116ebe169ec6cd2d" name="ac596e0cf37e992db116ebe169ec6cd2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac596e0cf37e992db116ebe169ec6cd2d">&#9670;&#160;</a></span>x</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Float3::x</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a86c923e4acaf36c9d325bca554b3f3a9" name="a86c923e4acaf36c9d325bca554b3f3a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86c923e4acaf36c9d325bca554b3f3a9">&#9670;&#160;</a></span>y</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Float3::y</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a921399d2713f5b390fcf6060d7ccac00" name="a921399d2713f5b390fcf6060d7ccac00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a921399d2713f5b390fcf6060d7ccac00">&#9670;&#160;</a></span>z</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Float3::z</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Math/<a class="el" href="_float3_8h_source.html">Float3.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_float3.html">Float3</a></li>
    <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>
  </ul>
</div>
</body>
</html>