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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703
							<!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: Plane 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_plane.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-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_plane-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Plane Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An infinite plane described by the formula X . Normal + Constant = 0.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_plane_8h_source.html">Plane.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:ac7a2eaef6e334fba41a0ac6ab7a97a6e" id="r_ac7a2eaef6e334fba41a0ac6ab7a97a6e"><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="#ac7a2eaef6e334fba41a0ac6ab7a97a6e">Plane</a> ()=default</td></tr>
<tr class="memdesc:ac7a2eaef6e334fba41a0ac6ab7a97a6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:ac7a2eaef6e334fba41a0ac6ab7a97a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71ec3665a225eda8f201e30fa2ee5544" id="r_a71ec3665a225eda8f201e30fa2ee5544"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71ec3665a225eda8f201e30fa2ee5544">Plane</a> (<a class="el" href="_math_types_8h.html#a2f6a6bbc069039fb4bc5813de8e77aa1">Vec4Arg</a> inNormalAndConstant)</td></tr>
<tr class="separator:a71ec3665a225eda8f201e30fa2ee5544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06bce37f1586abd31ea5c2863f5ff2a3" id="r_a06bce37f1586abd31ea5c2863f5ff2a3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a06bce37f1586abd31ea5c2863f5ff2a3">Plane</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal, float inConstant)</td></tr>
<tr class="separator:a06bce37f1586abd31ea5c2863f5ff2a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70e66a46d4eb8b334c929ad71c48ba42" id="r_a70e66a46d4eb8b334c929ad71c48ba42"><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="#a70e66a46d4eb8b334c929ad71c48ba42">GetNormal</a> () const</td></tr>
<tr class="separator:a70e66a46d4eb8b334c929ad71c48ba42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa792e95ef15c14271bdf9c1d43c85d90" id="r_aa792e95ef15c14271bdf9c1d43c85d90"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa792e95ef15c14271bdf9c1d43c85d90">SetNormal</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal)</td></tr>
<tr class="separator:aa792e95ef15c14271bdf9c1d43c85d90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3510818ed64a5d821041da28102fc4d1" id="r_a3510818ed64a5d821041da28102fc4d1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3510818ed64a5d821041da28102fc4d1">GetConstant</a> () const</td></tr>
<tr class="separator:a3510818ed64a5d821041da28102fc4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25c2359dcb8d679f5730ff10119cba45" id="r_a25c2359dcb8d679f5730ff10119cba45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25c2359dcb8d679f5730ff10119cba45">SetConstant</a> (float inConstant)</td></tr>
<tr class="separator:a25c2359dcb8d679f5730ff10119cba45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaec16f5e1e4c4ee9d546f3c5bcb52550" id="r_aaec16f5e1e4c4ee9d546f3c5bcb52550"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaec16f5e1e4c4ee9d546f3c5bcb52550">StoreFloat4</a> (<a class="el" href="class_float4.html">Float4</a> *outV) const</td></tr>
<tr class="memdesc:aaec16f5e1e4c4ee9d546f3c5bcb52550"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store as 4 floats.  <br /></td></tr>
<tr class="separator:aaec16f5e1e4c4ee9d546f3c5bcb52550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adce0e2bf9f6e85a2788ede7adfbe031d" id="r_adce0e2bf9f6e85a2788ede7adfbe031d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adce0e2bf9f6e85a2788ede7adfbe031d">Offset</a> (float inDistance) const</td></tr>
<tr class="memdesc:adce0e2bf9f6e85a2788ede7adfbe031d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset the plane (positive value means move it in the direction of the plane normal)  <br /></td></tr>
<tr class="separator:adce0e2bf9f6e85a2788ede7adfbe031d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23c3f6c2eaf6344447cb5e0a8a52d63d" id="r_a23c3f6c2eaf6344447cb5e0a8a52d63d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23c3f6c2eaf6344447cb5e0a8a52d63d">GetTransformed</a> (<a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a> inTransform) const</td></tr>
<tr class="memdesc:a23c3f6c2eaf6344447cb5e0a8a52d63d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transform the plane by a matrix.  <br /></td></tr>
<tr class="separator:a23c3f6c2eaf6344447cb5e0a8a52d63d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4f910a7761fd54f014a193b4d53dfb6" id="r_ac4f910a7761fd54f014a193b4d53dfb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac4f910a7761fd54f014a193b4d53dfb6">Scaled</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale) const</td></tr>
<tr class="memdesc:ac4f910a7761fd54f014a193b4d53dfb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale the plane, can handle non-uniform and negative scaling.  <br /></td></tr>
<tr class="separator:ac4f910a7761fd54f014a193b4d53dfb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96f5ba7b329fcccd22eaa63a7e282605" id="r_a96f5ba7b329fcccd22eaa63a7e282605"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a96f5ba7b329fcccd22eaa63a7e282605">SignedDistance</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPoint) const</td></tr>
<tr class="memdesc:a96f5ba7b329fcccd22eaa63a7e282605"><td class="mdescLeft">&#160;</td><td class="mdescRight">Distance point to plane.  <br /></td></tr>
<tr class="separator:a96f5ba7b329fcccd22eaa63a7e282605"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af35d1f676dc5be67464deaed71c883f0" id="r_af35d1f676dc5be67464deaed71c883f0"><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="#af35d1f676dc5be67464deaed71c883f0">ProjectPointOnPlane</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPoint) const</td></tr>
<tr class="memdesc:af35d1f676dc5be67464deaed71c883f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Project inPoint onto the plane.  <br /></td></tr>
<tr class="separator:af35d1f676dc5be67464deaed71c883f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab650685703d992f746e1934ffd20850d" id="r_ab650685703d992f746e1934ffd20850d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab650685703d992f746e1934ffd20850d">sFromPointAndNormal</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPoint, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal)</td></tr>
<tr class="memdesc:ab650685703d992f746e1934ffd20850d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create from point and normal.  <br /></td></tr>
<tr class="separator:ab650685703d992f746e1934ffd20850d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65ed67db9667cdc78040f503b1bce933" id="r_a65ed67db9667cdc78040f503b1bce933"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65ed67db9667cdc78040f503b1bce933">sFromPointAndNormal</a> (<a class="el" href="_math_types_8h.html#a943465464cdfbc4fedad29af409c31ff">DVec3Arg</a> inPoint, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal)</td></tr>
<tr class="memdesc:a65ed67db9667cdc78040f503b1bce933"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create from point and normal, double precision version that more accurately calculates the plane constant.  <br /></td></tr>
<tr class="separator:a65ed67db9667cdc78040f503b1bce933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf01f90a7839a26f8d1e0129b661c32d" id="r_acf01f90a7839a26f8d1e0129b661c32d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf01f90a7839a26f8d1e0129b661c32d">sFromPointsCCW</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)</td></tr>
<tr class="memdesc:acf01f90a7839a26f8d1e0129b661c32d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create from 3 counter clockwise points.  <br /></td></tr>
<tr class="separator:acf01f90a7839a26f8d1e0129b661c32d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abffae87f2329df22fc511aaf4a40fb6e" id="r_abffae87f2329df22fc511aaf4a40fb6e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abffae87f2329df22fc511aaf4a40fb6e">sIntersectPlanes</a> (const <a class="el" href="class_plane.html">Plane</a> &amp;inP1, const <a class="el" href="class_plane.html">Plane</a> &amp;inP2, const <a class="el" href="class_plane.html">Plane</a> &amp;inP3, <a class="el" href="class_vec3.html">Vec3</a> &amp;outPoint)</td></tr>
<tr class="memdesc:abffae87f2329df22fc511aaf4a40fb6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns intersection point between 3 planes.  <br /></td></tr>
<tr class="separator:abffae87f2329df22fc511aaf4a40fb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a20fe6b1c13e76385b9ea63d022cc1c89" id="r_a20fe6b1c13e76385b9ea63d022cc1c89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a20fe6b1c13e76385b9ea63d022cc1c89">CreateRTTIPlane</a> (class <a class="el" href="class_r_t_t_i.html">RTTI</a> &amp;)</td></tr>
<tr class="separator:a20fe6b1c13e76385b9ea63d022cc1c89"><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>An infinite plane described by the formula X . Normal + Constant = 0. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac7a2eaef6e334fba41a0ac6ab7a97a6e" name="ac7a2eaef6e334fba41a0ac6ab7a97a6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7a2eaef6e334fba41a0ac6ab7a97a6e">&#9670;&#160;</a></span>Plane() <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> Plane::Plane </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>Constructor. </p>

</div>
</div>
<a id="a71ec3665a225eda8f201e30fa2ee5544" name="a71ec3665a225eda8f201e30fa2ee5544"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71ec3665a225eda8f201e30fa2ee5544">&#9670;&#160;</a></span>Plane() <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">Plane::Plane </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a2f6a6bbc069039fb4bc5813de8e77aa1">Vec4Arg</a></td>          <td class="paramname"><span class="paramname"><em>inNormalAndConstant</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a06bce37f1586abd31ea5c2863f5ff2a3" name="a06bce37f1586abd31ea5c2863f5ff2a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06bce37f1586abd31ea5c2863f5ff2a3">&#9670;&#160;</a></span>Plane() <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">Plane::Plane </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inNormal</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inConstant</em></span>&#160;)</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 Function Documentation</h2>
<a id="a3510818ed64a5d821041da28102fc4d1" name="a3510818ed64a5d821041da28102fc4d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3510818ed64a5d821041da28102fc4d1">&#9670;&#160;</a></span>GetConstant()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float Plane::GetConstant </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></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="a70e66a46d4eb8b334c929ad71c48ba42" name="a70e66a46d4eb8b334c929ad71c48ba42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70e66a46d4eb8b334c929ad71c48ba42">&#9670;&#160;</a></span>GetNormal()</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_vec3.html">Vec3</a> Plane::GetNormal </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></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="a23c3f6c2eaf6344447cb5e0a8a52d63d" name="a23c3f6c2eaf6344447cb5e0a8a52d63d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23c3f6c2eaf6344447cb5e0a8a52d63d">&#9670;&#160;</a></span>GetTransformed()</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_plane.html">Plane</a> Plane::GetTransformed </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a></td>          <td class="paramname"><span class="paramname"><em>inTransform</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">

<p>Transform the plane by a matrix. </p>

</div>
</div>
<a id="adce0e2bf9f6e85a2788ede7adfbe031d" name="adce0e2bf9f6e85a2788ede7adfbe031d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adce0e2bf9f6e85a2788ede7adfbe031d">&#9670;&#160;</a></span>Offset()</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_plane.html">Plane</a> Plane::Offset </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inDistance</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">

<p>Offset the plane (positive value means move it in the direction of the plane normal) </p>

</div>
</div>
<a id="af35d1f676dc5be67464deaed71c883f0" name="af35d1f676dc5be67464deaed71c883f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af35d1f676dc5be67464deaed71c883f0">&#9670;&#160;</a></span>ProjectPointOnPlane()</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_vec3.html">Vec3</a> Plane::ProjectPointOnPlane </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inPoint</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">

<p>Project inPoint onto the plane. </p>

</div>
</div>
<a id="ac4f910a7761fd54f014a193b4d53dfb6" name="ac4f910a7761fd54f014a193b4d53dfb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f910a7761fd54f014a193b4d53dfb6">&#9670;&#160;</a></span>Scaled()</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_plane.html">Plane</a> Plane::Scaled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inScale</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">

<p>Scale the plane, can handle non-uniform and negative scaling. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void Plane::SetConstant </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inConstant</em></span></td><td>)</td>
          <td></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="aa792e95ef15c14271bdf9c1d43c85d90" name="aa792e95ef15c14271bdf9c1d43c85d90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa792e95ef15c14271bdf9c1d43c85d90">&#9670;&#160;</a></span>SetNormal()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void Plane::SetNormal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inNormal</em></span></td><td>)</td>
          <td></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="a65ed67db9667cdc78040f503b1bce933" name="a65ed67db9667cdc78040f503b1bce933"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65ed67db9667cdc78040f503b1bce933">&#9670;&#160;</a></span>sFromPointAndNormal() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_plane.html">Plane</a> Plane::sFromPointAndNormal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a943465464cdfbc4fedad29af409c31ff">DVec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inPoint</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inNormal</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create from point and normal, double precision version that more accurately calculates the plane constant. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_plane.html">Plane</a> Plane::sFromPointAndNormal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inPoint</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inNormal</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create from point and normal. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_plane.html">Plane</a> Plane::sFromPointsCCW </td>
          <td>(</td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create from 3 counter clockwise points. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float Plane::SignedDistance </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inPoint</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">

<p>Distance point to plane. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool Plane::sIntersectPlanes </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_plane.html">Plane</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inP1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_plane.html">Plane</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inP2</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_plane.html">Plane</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inP3</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outPoint</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns intersection point between 3 planes. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void Plane::StoreFloat4 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_float4.html">Float4</a> *</td>          <td class="paramname"><span class="paramname"><em>outV</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">

<p>Store as 4 floats. </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a20fe6b1c13e76385b9ea63d022cc1c89" name="a20fe6b1c13e76385b9ea63d022cc1c89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20fe6b1c13e76385b9ea63d022cc1c89">&#9670;&#160;</a></span>CreateRTTIPlane</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CreateRTTIPlane </td>
          <td>(</td>
          <td class="paramtype">class <a class="el" href="class_r_t_t_i.html">RTTI</a> &amp;</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">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Geometry/<a class="el" href="_plane_8h_source.html">Plane.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_plane.html">Plane</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>