<!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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zibra Effects: Assets/Plugins/Zibra/Common/Scripts/Solver/Manipulators/SDF/TerrainSDF.cs Source File</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.5 -->
<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="dir_f5412708edd60def94041247c0b8603c.html">Assets</a></li><li class="navelem"><a class="el" href="dir_beed702047ef9680d64a7ee349fab51c.html">Plugins</a></li><li class="navelem"><a class="el" href="dir_4f506dc541fc7401bbbeb99f1cec82f2.html">Zibra</a></li><li class="navelem"><a class="el" href="dir_9def9d74e2cdd9c423376cfd3cb2e741.html">Common</a></li><li class="navelem"><a class="el" href="dir_30aa5f7d68d067f585300a6265066da9.html">Scripts</a></li><li class="navelem"><a class="el" href="dir_d3b8392298d65c5cb0d854ad352a8402.html">Solver</a></li><li class="navelem"><a class="el" href="dir_33a82664c1a0c704e3bb81401c412e23.html">Manipulators</a></li><li class="navelem"><a class="el" href="dir_68758e308b6434808f56efd5adf22a9c.html">SDF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">TerrainSDF.cs</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="keyword">using </span>UnityEngine;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="preprocessor">#if UNITY_EDITOR</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="keyword">using </span>UnityEditor;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="keyword">using </span>UnityEngine.Rendering;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="keyword">using </span>UnityEngine.Serialization;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacecom_1_1zibra_1_1common_1_1_s_d_f_objects.html">com.zibra.common.SDFObjects</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>    [AddComponentMenu(<span class="stringliteral">&quot;Zibra Effects - SDFs/Zibra Terrain SDF&quot;</span>)]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>    [DisallowMultipleComponent]</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html">   20</a></span>    <span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html">TerrainSDF</a> : <a class="code hl_class" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object.html">SDFObject</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>    {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#region Public Interface</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a40b116701e7f8745b940552b2bfdd632">   26</a></span>        <span class="keyword">public</span> Vector3 <a class="code hl_function" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a40b116701e7f8745b940552b2bfdd632">GetBBoxSize</a>()</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>            Terrain terrain = GetComponent&lt;Terrain&gt;();</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>            <span class="keywordflow">if</span> (terrain != <span class="keyword">null</span>)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>            {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>                <span class="keywordflow">return</span> terrain.terrainData.bounds.size;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>            }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>            <span class="keywordflow">else</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>            {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>                <span class="keywordflow">return</span> Vector3.zero;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>            }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>        }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a5959f8fe6a2ce7978d10f968597ee2a6">   39</a></span>        <span class="keyword">public</span> <span class="keyword">override</span> ulong <a class="code hl_function" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a5959f8fe6a2ce7978d10f968597ee2a6">GetVRAMFootprint</a>()</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>        {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>            Terrain terrain = GetComponent&lt;Terrain&gt;();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>            <span class="keywordflow">if</span> (terrain != <span class="keyword">null</span>)</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>            {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>                <span class="comment">// 2 is the number of bytes per texel in the heightmap texture (R16Float)</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>                <span class="keywordflow">return</span> (ulong)(Resolution * Resolution) * 2;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>            }</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>            <span class="keywordflow">else</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>            {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>                <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>            }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>        }</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a9e357f5fa0997ca299967291bb15ece8">   53</a></span>        <span class="keyword">public</span> <span class="keyword">override</span> <a class="code hl_enumeration" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a> <a class="code hl_function" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a9e357f5fa0997ca299967291bb15ece8">GetSDFType</a>()</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>        {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>            <span class="keywordflow">return</span> <a class="code hl_enumeration" href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object.html#a67db69423f8d4341e6bd4a4252154b67">SDFObjectType</a>.Heightmap;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>        }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#endregion</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#region Implementation details</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>        <span class="keyword">internal</span> <span class="keywordtype">int</span> Resolution = 256;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#endregion</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    }</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>}</div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object_html"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object.html">com.zibra.common.SDFObjects.SDFObject</a></div><div class="ttdoc">Base class for SDF classes.</div><div class="ttdef"><b>Definition:</b> <a href="_s_d_f_object_8cs_source.html#l00014">SDFObject.cs:15</a></div></div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object_html_a67db69423f8d4341e6bd4a4252154b67"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_s_d_f_object.html#a67db69423f8d4341e6bd4a4252154b67">com.zibra.common.SDFObjects.SDFObject.SDFObjectType</a></div><div class="ttdeci">SDFObjectType</div><div class="ttdoc">Types of SDF objects.</div><div class="ttdef"><b>Definition:</b> <a href="_s_d_f_object_8cs_source.html#l00020">SDFObject.cs:21</a></div></div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f_html"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html">com.zibra.common.SDFObjects.TerrainSDF</a></div><div class="ttdoc">Class containing terrain SDF.</div><div class="ttdef"><b>Definition:</b> <a href="_terrain_s_d_f_8cs_source.html#l00020">TerrainSDF.cs:21</a></div></div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f_html_a40b116701e7f8745b940552b2bfdd632"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a40b116701e7f8745b940552b2bfdd632">com.zibra.common.SDFObjects.TerrainSDF.GetBBoxSize</a></div><div class="ttdeci">Vector3 GetBBoxSize()</div><div class="ttdoc">Returns size of bounding box for current shape.</div><div class="ttdef"><b>Definition:</b> <a href="_terrain_s_d_f_8cs_source.html#l00026">TerrainSDF.cs:26</a></div></div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f_html_a5959f8fe6a2ce7978d10f968597ee2a6"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a5959f8fe6a2ce7978d10f968597ee2a6">com.zibra.common.SDFObjects.TerrainSDF.GetVRAMFootprint</a></div><div class="ttdeci">override ulong GetVRAMFootprint()</div><div class="ttdoc">Calculates approximate VRAM usage by SDF.</div><div class="ttdef"><b>Definition:</b> <a href="_terrain_s_d_f_8cs_source.html#l00039">TerrainSDF.cs:39</a></div></div>
<div class="ttc" id="aclasscom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f_html_a9e357f5fa0997ca299967291bb15ece8"><div class="ttname"><a href="classcom_1_1zibra_1_1common_1_1_s_d_f_objects_1_1_terrain_s_d_f.html#a9e357f5fa0997ca299967291bb15ece8">com.zibra.common.SDFObjects.TerrainSDF.GetSDFType</a></div><div class="ttdeci">override SDFObjectType GetSDFType()</div><div class="ttdoc">Type of SDF object.</div><div class="ttdef"><b>Definition:</b> <a href="_terrain_s_d_f_8cs_source.html#l00053">TerrainSDF.cs:53</a></div></div>
<div class="ttc" id="anamespacecom_1_1zibra_1_1common_1_1_s_d_f_objects_html"><div class="ttname"><a href="namespacecom_1_1zibra_1_1common_1_1_s_d_f_objects.html">com.zibra.common.SDFObjects</a></div><div class="ttdoc">Namespace that contains SDF classes.</div><div class="ttdef"><b>Definition:</b> <a href="_analytic_s_d_f_8cs_source.html#l00010">AnalyticSDF.cs:11</a></div></div>
</div><!-- fragment --></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.5
</small></address>
</body>
</html>
