Mluti-Agent_simulation/3DModule/Assets/Plugins/Zibra/Common/Documentation/APIReference/a01034.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: ZibraSmokeAndFireVoid 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="a00360.html">smoke_and_fire</a></li><li class="navelem"><a class="el" href="a00362.html">Manipulators</a></li><li class="navelem"><a class="el" href="a01034.html">ZibraSmokeAndFireVoid</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="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#events">Events</a> &#124;
<a href="a01031.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ZibraSmokeAndFireVoid Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Manipulator that used to remove Smoke and/or Fuel.  
 <a href="a01034.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:a57c404a5c07698ea543d2d900d60c282"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a> { <br />
&#160;&#160;<b>None</b>
, <b>Emitter</b>
, <b>Void</b>
, <b>ForceField</b>
, <br />
&#160;&#160;<b>AnalyticCollider</b>
, <b>NeuralCollider</b>
, <b>GroupCollider</b>
, <b>Detector</b>
, <br />
&#160;&#160;<b>SpeciesModifier</b>
, <b>EffectParticleEmitter</b>
, <b>TextureEmitter</b>
, <b>TypeNum</b>
<br />
 }</td></tr>
<tr class="memdesc:a57c404a5c07698ea543d2d900d60c282"><td class="mdescLeft">&#160;</td><td class="mdescRight">Manipulator types.  <a href="a01006.html#a57c404a5c07698ea543d2d900d60c282">More...</a><br /></td></tr>
<tr class="separator:a57c404a5c07698ea543d2d900d60c282"><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:a3d39c8704dab2e95325799dba1a1b5d2"><td class="memItemLeft" align="right" valign="top">override Color&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01034.html#a3d39c8704dab2e95325799dba1a1b5d2">GetGizmosColor</a> ()</td></tr>
<tr class="memdesc:a3d39c8704dab2e95325799dba1a1b5d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Editor only) Returns gizmo color that should be used with current manipulator.  <br /></td></tr>
<tr class="separator:a3d39c8704dab2e95325799dba1a1b5d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cc6337a69e8c76553e48455bf51b6d2"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="a01006.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01034.html#a0cc6337a69e8c76553e48455bf51b6d2">GetManipulatorType</a> ()</td></tr>
<tr class="memdesc:a0cc6337a69e8c76553e48455bf51b6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the manipulator type.  <br /></td></tr>
<tr class="separator:a0cc6337a69e8c76553e48455bf51b6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af557e93137dbb3358b82ad34849b49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a0af557e93137dbb3358b82ad34849b49">NotifyChange</a> ()</td></tr>
<tr class="memdesc:a0af557e93137dbb3358b82ad34849b49"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Editor only) Triggers custom editor update.  <br /></td></tr>
<tr class="separator:a0af557e93137dbb3358b82ad34849b49"><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:a33457d6a2e6224e33862265cae43d7e8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01034.html#a33457d6a2e6224e33862265cae43d7e8">ColorDecay</a> = 0.95f</td></tr>
<tr class="memdesc:a33457d6a2e6224e33862265cae43d7e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls how quickly the amount of smoke or fuel is decreasing.  <br /></td></tr>
<tr class="separator:a33457d6a2e6224e33862265cae43d7e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001716b948208be6c6cd1e871c7cc1fa"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01034.html#a001716b948208be6c6cd1e871c7cc1fa">VelocityDecay</a> = 0.95f</td></tr>
<tr class="memdesc:a001716b948208be6c6cd1e871c7cc1fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls how quickly the velocity of the smoke or fire is decreasing each frame.  <br /></td></tr>
<tr class="separator:a001716b948208be6c6cd1e871c7cc1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7ee7d8488b345824cfbc49d2803a54c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01034.html#aa7ee7d8488b345824cfbc49d2803a54c">Pressure</a> = -0.05f</td></tr>
<tr class="memdesc:aa7ee7d8488b345824cfbc49d2803a54c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This parameter controls how much pressure to add to the given region.  <br /></td></tr>
<tr class="separator:aa7ee7d8488b345824cfbc49d2803a54c"><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-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a9757aa7d1641b03848849a141bbeb7a0"><td class="memItemLeft" align="right" valign="top">static readonly List&lt; <a class="el" href="a01006.html">Manipulator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a9757aa7d1641b03848849a141bbeb7a0">AllManipulators</a> = new List&lt;<a class="el" href="a01006.html">Manipulator</a>&gt;()</td></tr>
<tr class="memdesc:a9757aa7d1641b03848849a141bbeb7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of all enabled manipulators.  <br /></td></tr>
<tr class="separator:a9757aa7d1641b03848849a141bbeb7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="events" name="events"></a>
Events</h2></td></tr>
<tr class="memitem:a08c0566c1c813868227dbde1574e2437"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a08c0566c1c813868227dbde1574e2437">OnChanged</a></td></tr>
<tr class="memdesc:a08c0566c1c813868227dbde1574e2437"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Editor only) Event that is triggered when state of manipulator changes to trigger update of custom editor.  <br /></td></tr>
<tr class="separator:a08c0566c1c813868227dbde1574e2437"><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>Manipulator that used to remove Smoke and/or Fuel. </p>
<p>You don’t necessarily need to remove them manually, and just set up smoke/fuel to dissipate. </p>
<p>Voids can create negative pressure, pulling smoke/fuel inside. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a57c404a5c07698ea543d2d900d60c282" name="a57c404a5c07698ea543d2d900d60c282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57c404a5c07698ea543d2d900d60c282">&#9670;&#160;</a></span>ManipulatorType</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="a01006.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</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>Manipulator types. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override Color GetGizmosColor </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>(Editor only) Returns gizmo color that should be used with current manipulator. </p>
<p>This is needed since SDFs can be used with any manipulators, but we don't want SDFs to draw gizmos in same color for different types of manipulators. </p>

<p>Implements <a class="el" href="a00630.html#a05370caa7e5b4ff2854b37d4ce3dac98">Manipulator</a>.</p>

</div>
</div>
<a id="a0cc6337a69e8c76553e48455bf51b6d2" name="a0cc6337a69e8c76553e48455bf51b6d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cc6337a69e8c76553e48455bf51b6d2">&#9670;&#160;</a></span>GetManipulatorType()</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="a01006.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a> GetManipulatorType </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>Returns the manipulator type. </p>

<p>Reimplemented from <a class="el" href="a01006.html#a242f6a13f0eacf4047ae3e327f10e269">Manipulator</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void NotifyChange </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">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>(Editor only) Triggers custom editor update. </p>
<p>Just triggers OnChanged. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ColorDecay = 0.95f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Controls how quickly the amount of smoke or fuel is decreasing. </p>
<p>1.0 will have no decay, 0.5 will remove half of the total density each simulation iteration. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float VelocityDecay = 0.95f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Controls how quickly the velocity of the smoke or fire is decreasing each frame. </p>
<p>1.0 will have no decay, 0.5 will remove half of the velocity each simulation iteration. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Pressure = -0.05f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This parameter controls how much pressure to add to the given region. </p>
<p>Negative values will suck in the smoke, positive values will move the smoke away. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">readonly List&lt;<a class="el" href="a01006.html">Manipulator</a>&gt; AllManipulators = new List&lt;<a class="el" href="a01006.html">Manipulator</a>&gt;()</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>List of all enabled manipulators. </p>

</div>
</div>
<h2 class="groupheader">Event Documentation</h2>
<a id="a08c0566c1c813868227dbde1574e2437" name="a08c0566c1c813868227dbde1574e2437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08c0566c1c813868227dbde1574e2437">&#9670;&#160;</a></span>OnChanged</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Action OnChanged</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>(Editor only) Event that is triggered when state of manipulator changes to trigger update of custom editor. </p>
<p>This is only intended to update custom editors, You can trigger it when you change some state to update custom editor. But using it for anything else is a bad idea. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Assets/Plugins/Zibra/Smoke and Fire/Scripts/Solver/Manipulators/ZibraSmokeAndFireVoid.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>