Mluti-Agent_simulation/3DModule/Assets/Plugins/Zibra/Common/Documentation/APIReference/a00674.html

<!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.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zibra Effects: TerrainSDF Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js.txt"></script>
<script type="text/javascript" src="dynsections.js.txt"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js.txt"></script>
<script type="text/javascript" src="search/search.js.txt"></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="projectalign">
   <div id="projectname">Zibra Effects
   </div>
   <div id="projectbrief">Real-time Simulated Visual Effects</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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" src="menudata.js.txt"></script>
<script type="text/javascript" src="menu.js.txt"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="a00335.html">com</a></li><li class="navelem"><a class="el" href="a00336.html">zibra</a></li><li class="navelem"><a class="el" href="a00337.html">common</a></li><li class="navelem"><a class="el" href="a00354.html">SDFObjects</a></li><li class="navelem"><a class="el" href="a00674.html">TerrainSDF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="a00671.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">TerrainSDF Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Class containing terrain SDF.  
 <a href="a00674.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a67db69423f8d4341e6bd4a4252154b67"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00666.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a> { <b>Heightmap</b> = -3
, <b>Group</b>
, <b>Neural</b>
, <b>Analytic</b>
 }</td></tr>
<tr class="memdesc:a67db69423f8d4341e6bd4a4252154b67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Types of SDF objects.  <a href="a00666.html#a67db69423f8d4341e6bd4a4252154b67">More...</a><br /></td></tr>
<tr class="separator:a67db69423f8d4341e6bd4a4252154b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a40b116701e7f8745b940552b2bfdd632"><td class="memItemLeft" align="right" valign="top">Vector3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00674.html#a40b116701e7f8745b940552b2bfdd632">GetBBoxSize</a> ()</td></tr>
<tr class="memdesc:a40b116701e7f8745b940552b2bfdd632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns size of bounding box for current shape.  <br /></td></tr>
<tr class="separator:a40b116701e7f8745b940552b2bfdd632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5959f8fe6a2ce7978d10f968597ee2a6"><td class="memItemLeft" align="right" valign="top">override ulong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00674.html#a5959f8fe6a2ce7978d10f968597ee2a6">GetVRAMFootprint</a> ()</td></tr>
<tr class="memdesc:a5959f8fe6a2ce7978d10f968597ee2a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates approximate VRAM usage by SDF.  <br /></td></tr>
<tr class="separator:a5959f8fe6a2ce7978d10f968597ee2a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e357f5fa0997ca299967291bb15ece8"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="a00666.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00674.html#a9e357f5fa0997ca299967291bb15ece8">GetSDFType</a> ()</td></tr>
<tr class="memdesc:a9e357f5fa0997ca299967291bb15ece8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of SDF object.  <br /></td></tr>
<tr class="separator:a9e357f5fa0997ca299967291bb15ece8"><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:a0f996cffb79a29d8318f8c9948c1da35"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00666.html#a0f996cffb79a29d8318f8c9948c1da35">InvertSDF</a> = false</td></tr>
<tr class="memdesc:a0f996cffb79a29d8318f8c9948c1da35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether to invert collider to only allow volume inside.  <br /></td></tr>
<tr class="separator:a0f996cffb79a29d8318f8c9948c1da35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab16379ff5aa08cf2480ed29f86b3362d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00666.html#ab16379ff5aa08cf2480ed29f86b3362d">SurfaceDistance</a> = 0.0f</td></tr>
<tr class="memdesc:ab16379ff5aa08cf2480ed29f86b3362d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset for distance to SDF.  <br /></td></tr>
<tr class="separator:ab16379ff5aa08cf2480ed29f86b3362d"><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 containing terrain SDF. </p>
<p>Terrain SDF is an SDF approximation based on the terrain's heightmap. Since this is an approximation it might be worse in quality in some cases compared to other SDF types. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a67db69423f8d4341e6bd4a4252154b67" name="a67db69423f8d4341e6bd4a4252154b67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67db69423f8d4341e6bd4a4252154b67">&#9670;&#160;</a></span>SDFObjectType</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="a00666.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Types of SDF objects. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Vector3 GetBBoxSize </td>
          <td>(</td>
          <td class="paramname"></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">

<p>Returns size of bounding box for current shape. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override ulong GetVRAMFootprint </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Calculates approximate VRAM usage by SDF. </p>
<dl class="section return"><dt>Returns</dt><dd>Approximate VRAM usage in bytes. </dd></dl>

<p>Implements <a class="el" href="a00666.html#adce5c5fe3c21420cfa97e1c838f04a56">SDFObject</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override <a class="el" href="a00666.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a> GetSDFType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Type of SDF object. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns SDFObjectType of a subclass. </dd></dl>

<p>Implements <a class="el" href="a00666.html#ad3b128c19d35e05315cc51eedc8654a4">SDFObject</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool InvertSDF = false</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether to invert collider to only allow volume inside. </p>
<p>Unsupported on Skinned Mesh SDFs. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float SurfaceDistance = 0.0f</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Offset for distance to SDF. </p>
<p>Allows you to "shrink" or "expand" SDF. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Assets/Plugins/Zibra/Common/Scripts/Solver/Manipulators/SDF/TerrainSDF.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>