| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123 |
- <!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: ZibraSmokeAndFire 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&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&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="a00363.html">Solver</a></li><li class="navelem"><a class="el" href="a01082.html">ZibraSmokeAndFire</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="#pub-static-attribs">Static Public Attributes</a> |
- <a href="#properties">Properties</a> |
- <a href="#events">Events</a> |
- <a href="a01079.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ZibraSmokeAndFire Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p>Main Smoke & Fire solver component.
- <a href="a01082.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:a2c385f642822975febcc3c48fb9605bd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a> { <b>Smoke</b>
- , <b>ColoredSmoke</b>
- , <b>Fire</b>
- }</td></tr>
- <tr class="memdesc:a2c385f642822975febcc3c48fb9605bd"><td class="mdescLeft"> </td><td class="mdescRight">See CurrentSimulationMode. <a href="a01082.html#a2c385f642822975febcc3c48fb9605bd">More...</a><br /></td></tr>
- <tr class="separator:a2c385f642822975febcc3c48fb9605bd"><td class="memSeparator" colspan="2"> </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:a24538a98739b1dabfa25721d5a02b158"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a24538a98739b1dabfa25721d5a02b158">IsLoaded</a> ()</td></tr>
- <tr class="memdesc:a24538a98739b1dabfa25721d5a02b158"><td class="mdescLeft"> </td><td class="mdescRight">Simulation needs to do some loading before simulation can start. Loading starts during initialization of engine. If it takes too long and you start simulation too early it can stall engine until loading finishes. You can use this method to show loading screen to wait for loading to end and prevent stalling. <br /></td></tr>
- <tr class="separator:a24538a98739b1dabfa25721d5a02b158"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad17e4331232fd54c8c9e970a02edfed3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#ad17e4331232fd54c8c9e970a02edfed3">WaitLoad</a> ()</td></tr>
- <tr class="memdesc:ad17e4331232fd54c8c9e970a02edfed3"><td class="mdescLeft"> </td><td class="mdescRight">Stalls engine until all loading is finished See IsLoaded <br /></td></tr>
- <tr class="separator:ad17e4331232fd54c8c9e970a02edfed3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a70437966da5eaae13ca8b167bedea7eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a70437966da5eaae13ca8b167bedea7eb">ReleaseSimulation</a> ()</td></tr>
- <tr class="memdesc:a70437966da5eaae13ca8b167bedea7eb"><td class="mdescLeft"> </td><td class="mdescRight">Releases simulation resources. <br /></td></tr>
- <tr class="separator:a70437966da5eaae13ca8b167bedea7eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a7e7d8a5040cee41196e023a9c05060"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a7a7e7d8a5040cee41196e023a9c05060">RemoveManipulator</a> (<a class="el" href="a01006.html">Manipulator</a> manipulator)</td></tr>
- <tr class="memdesc:a7a7e7d8a5040cee41196e023a9c05060"><td class="mdescLeft"> </td><td class="mdescRight">Removes manipulator from the simulation. <br /></td></tr>
- <tr class="separator:a7a7e7d8a5040cee41196e023a9c05060"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa58f899ad5137c8dd72d88a57a699227"><td class="memItemLeft" align="right" valign="top">ReadOnlyCollection< <a class="el" href="a01006.html">Manipulator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#aa58f899ad5137c8dd72d88a57a699227">GetManipulatorList</a> ()</td></tr>
- <tr class="memdesc:aa58f899ad5137c8dd72d88a57a699227"><td class="mdescLeft"> </td><td class="mdescRight">Returns read-only list of manipulators. <br /></td></tr>
- <tr class="separator:aa58f899ad5137c8dd72d88a57a699227"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aac0ad2411b42670e36cc79a9865e6a95"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#aac0ad2411b42670e36cc79a9865e6a95">HasManipulator</a> (<a class="el" href="a01006.html">Manipulator</a> manipulator)</td></tr>
- <tr class="memdesc:aac0ad2411b42670e36cc79a9865e6a95"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether manipulator list has specified manipulator. <br /></td></tr>
- <tr class="separator:aac0ad2411b42670e36cc79a9865e6a95"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6727531d04632327e5aa53292d37b73b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a6727531d04632327e5aa53292d37b73b">AddManipulator</a> (<a class="el" href="a01006.html">Manipulator</a> manipulator)</td></tr>
- <tr class="memdesc:a6727531d04632327e5aa53292d37b73b"><td class="mdescLeft"> </td><td class="mdescRight">Adds manipulator to the simulation. <br /></td></tr>
- <tr class="separator:a6727531d04632327e5aa53292d37b73b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4746d9bc10cb2d1892167d68570f20d3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a4746d9bc10cb2d1892167d68570f20d3">HasEmitter</a> ()</td></tr>
- <tr class="memdesc:a4746d9bc10cb2d1892167d68570f20d3"><td class="mdescLeft"> </td><td class="mdescRight">Checks if simulation has at least one emitter manipulator. <br /></td></tr>
- <tr class="separator:a4746d9bc10cb2d1892167d68570f20d3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5dc665c2e65c71491cb7a92a3db572be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a5dc665c2e65c71491cb7a92a3db572be">UpdateGridSize</a> ()</td></tr>
- <tr class="memdesc:a5dc665c2e65c71491cb7a92a3db572be"><td class="mdescLeft"> </td><td class="mdescRight">Updates values of some constants based on ContainerSize and GridResolution. <br /></td></tr>
- <tr class="separator:a5dc665c2e65c71491cb7a92a3db572be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4cc0b8f5b4aa1722c55211319a83de67"><td class="memItemLeft" align="right" valign="top">List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a4cc0b8f5b4aa1722c55211319a83de67">GetStats</a> ()</td></tr>
- <tr class="memdesc:a4cc0b8f5b4aa1722c55211319a83de67"><td class="mdescLeft"> </td><td class="mdescRight">Return various stats of an object. <br /></td></tr>
- <tr class="separator:a4cc0b8f5b4aa1722c55211319a83de67"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0af557e93137dbb3358b82ad34849b49"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a0af557e93137dbb3358b82ad34849b49">NotifyChange</a> ()</td></tr>
- <tr class="memdesc:a0af557e93137dbb3358b82ad34849b49"><td class="mdescLeft"> </td><td class="mdescRight">(Editor only) Triggers custom editor update. <br /></td></tr>
- <tr class="separator:a0af557e93137dbb3358b82ad34849b49"><td class="memSeparator" colspan="2"> </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:ac4792d27f7e5e4a3fc2337191231011a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#ac4792d27f7e5e4a3fc2337191231011a">CurrentSimulationMode</a> = SimulationMode.Fire</td></tr>
- <tr class="memdesc:ac4792d27f7e5e4a3fc2337191231011a"><td class="mdescLeft"> </td><td class="mdescRight">Setting that determines the type of simulation being performed, with options including Smoke, Colored Smoke, and Fire. <br /></td></tr>
- <tr class="separator:ac4792d27f7e5e4a3fc2337191231011a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a513906c0545ef4c34563175adb79277f"><td class="memItemLeft" align="right" valign="top">Light </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a513906c0545ef4c34563175adb79277f">MainLight</a></td></tr>
- <tr class="memdesc:a513906c0545ef4c34563175adb79277f"><td class="mdescLeft"> </td><td class="mdescRight">Directional light that will be used for Smoke & Fire lighting. <br /></td></tr>
- <tr class="separator:a513906c0545ef4c34563175adb79277f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8fd6b7f69ecca3dc73e75ccb30100de4"><td class="memItemLeft" align="right" valign="top">List< Light > </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a8fd6b7f69ecca3dc73e75ccb30100de4">Lights</a></td></tr>
- <tr class="memdesc:a8fd6b7f69ecca3dc73e75ccb30100de4"><td class="mdescLeft"> </td><td class="mdescRight">List of point lights that contribute to Smoke & Fire lighting. <br /></td></tr>
- <tr class="separator:a8fd6b7f69ecca3dc73e75ccb30100de4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a57b3ef4623ad89b62fe4f32ef9de669f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a57b3ef4623ad89b62fe4f32ef9de669f">Timestep</a> = 1.00f</td></tr>
- <tr class="memdesc:a57b3ef4623ad89b62fe4f32ef9de669f"><td class="mdescLeft"> </td><td class="mdescRight">Timestep used in each simulation iteration. <br /></td></tr>
- <tr class="separator:a57b3ef4623ad89b62fe4f32ef9de669f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3388dde8463171695ffbfbf8902384c6"><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a3388dde8463171695ffbfbf8902384c6">MaxFramesInFlight</a> = 3</td></tr>
- <tr class="memdesc:a3388dde8463171695ffbfbf8902384c6"><td class="mdescLeft"> </td><td class="mdescRight">Maximum allowed number of frames queued to render. <br /></td></tr>
- <tr class="separator:a3388dde8463171695ffbfbf8902384c6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af20b00f33a5e5c39d46a5c26fd4c92f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#af20b00f33a5e5c39d46a5c26fd4c92f9">SimulationIterations</a> = 3</td></tr>
- <tr class="memdesc:af20b00f33a5e5c39d46a5c26fd4c92f9"><td class="mdescLeft"> </td><td class="mdescRight">Number of simulation iterations per simulation frame. <br /></td></tr>
- <tr class="separator:af20b00f33a5e5c39d46a5c26fd4c92f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5471ff6648f72a9e172b87554fd6c1b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a5471ff6648f72a9e172b87554fd6c1b3">GridResolution</a> = 128</td></tr>
- <tr class="memdesc:a5471ff6648f72a9e172b87554fd6c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Size of the simulation grid. <br /></td></tr>
- <tr class="separator:a5471ff6648f72a9e172b87554fd6c1b3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adbe358a3fdd13a7e7cea1a30b81cbe57"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#adbe358a3fdd13a7e7cea1a30b81cbe57">RunSimulation</a> = true</td></tr>
- <tr class="memdesc:adbe358a3fdd13a7e7cea1a30b81cbe57"><td class="mdescLeft"> </td><td class="mdescRight">Freezes simulation when disabled. <br /></td></tr>
- <tr class="separator:adbe358a3fdd13a7e7cea1a30b81cbe57"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7aa989f02edf945bd79a0fd1feab791"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#af7aa989f02edf945bd79a0fd1feab791">RunRendering</a> = true</td></tr>
- <tr class="memdesc:af7aa989f02edf945bd79a0fd1feab791"><td class="mdescLeft"> </td><td class="mdescRight">Enables rendering of the smoke/fire. <br /></td></tr>
- <tr class="separator:af7aa989f02edf945bd79a0fd1feab791"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af1d6faf266c7e9c47ff8d56c50994d7e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#af1d6faf266c7e9c47ff8d56c50994d7e">FixVolumeWorldPosition</a> = true</td></tr>
- <tr class="memdesc:af1d6faf266c7e9c47ff8d56c50994d7e"><td class="mdescLeft"> </td><td class="mdescRight">When enabled, moving simulation volume will not disturb simulation. When disabled, smoke/fire will try to stay in place in world space. <br /></td></tr>
- <tr class="separator:af1d6faf266c7e9c47ff8d56c50994d7e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a946e85fa04a56c9a658c62641f8df3c7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a946e85fa04a56c9a658c62641f8df3c7">EnableDownscale</a> = false</td></tr>
- <tr class="memdesc:a946e85fa04a56c9a658c62641f8df3c7"><td class="mdescLeft"> </td><td class="mdescRight">Allows you to render Smoke & Fire in lower resolution. <br /></td></tr>
- <tr class="separator:a946e85fa04a56c9a658c62641f8df3c7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6183f87b169d9690a53e7312507c2a42"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a6183f87b169d9690a53e7312507c2a42">DownscaleFactor</a> = 0.5f</td></tr>
- <tr class="memdesc:a6183f87b169d9690a53e7312507c2a42"><td class="mdescLeft"> </td><td class="mdescRight">Scale width/height of smoke & fire render. <br /></td></tr>
- <tr class="separator:a6183f87b169d9690a53e7312507c2a42"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e3da4c5b2449adcbf9348c54e50812d"><td class="memItemLeft" align="right" valign="top">Vector3 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a0e3da4c5b2449adcbf9348c54e50812d">ContainerSize</a> = new Vector3(5, 5, 5)</td></tr>
- <tr class="memdesc:a0e3da4c5b2449adcbf9348c54e50812d"><td class="mdescLeft"> </td><td class="mdescRight">Size of the simulation volume. <br /></td></tr>
- <tr class="separator:a0e3da4c5b2449adcbf9348c54e50812d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a60f1ebf5864cafb3a02fb0441724bb71"><td class="memItemLeft" align="right" valign="top">Vector3 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a60f1ebf5864cafb3a02fb0441724bb71">SimulationContainerPosition</a></td></tr>
- <tr class="memdesc:a60f1ebf5864cafb3a02fb0441724bb71"><td class="mdescLeft"> </td><td class="mdescRight">Last simulated container position. <br /></td></tr>
- <tr class="separator:a60f1ebf5864cafb3a02fb0441724bb71"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a96a6f56e74c3c80dbbc8676e313bdd94"><td class="memItemLeft" align="right" valign="top">CameraEvent </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a96a6f56e74c3c80dbbc8676e313bdd94">CurrentInjectionPoint</a> = CameraEvent.BeforeForwardAlpha</td></tr>
- <tr class="memdesc:a96a6f56e74c3c80dbbc8676e313bdd94"><td class="mdescLeft"> </td><td class="mdescRight">Injection point used for BRP render. <br /></td></tr>
- <tr class="separator:a96a6f56e74c3c80dbbc8676e313bdd94"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afcac8381e4e2985d8950aa58684e852a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#afcac8381e4e2985d8950aa58684e852a">LimitFramerate</a> = true</td></tr>
- <tr class="memdesc:afcac8381e4e2985d8950aa58684e852a"><td class="mdescLeft"> </td><td class="mdescRight">Whether to limit maximum number of smoke simulation iterations per second. <br /></td></tr>
- <tr class="separator:afcac8381e4e2985d8950aa58684e852a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2ec1cd6873831fe75a9de4b2f6416cd"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#ad2ec1cd6873831fe75a9de4b2f6416cd">MaximumFramerate</a> = 60.0f</td></tr>
- <tr class="memdesc:ad2ec1cd6873831fe75a9de4b2f6416cd"><td class="mdescLeft"> </td><td class="mdescRight">Maximum simulation iterations per second. <br /></td></tr>
- <tr class="separator:ad2ec1cd6873831fe75a9de4b2f6416cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a448c1b79bc5cf8c39accde429a5055bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00994.html">ZibraSmokeAndFireSolverParameters</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a448c1b79bc5cf8c39accde429a5055bd">solverParameters</a></td></tr>
- <tr class="memdesc:a448c1b79bc5cf8c39accde429a5055bd"><td class="mdescLeft"> </td><td class="mdescRight">Main parameters of the simulation. <br /></td></tr>
- <tr class="separator:a448c1b79bc5cf8c39accde429a5055bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adf37d6d706a8e2bea1c3627c23a81da8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00990.html">ZibraSmokeAndFireMaterialParameters</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#adf37d6d706a8e2bea1c3627c23a81da8">materialParameters</a></td></tr>
- <tr class="memdesc:adf37d6d706a8e2bea1c3627c23a81da8"><td class="mdescLeft"> </td><td class="mdescRight">Main rendering parameters. <br /></td></tr>
- <tr class="separator:adf37d6d706a8e2bea1c3627c23a81da8"><td class="memSeparator" colspan="2"> </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:ae6f6139d03c6cb1987d13cac50d24523"><td class="memItemLeft" align="right" valign="top">static List< <a class="el" href="a01082.html">ZibraSmokeAndFire</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#ae6f6139d03c6cb1987d13cac50d24523">AllInstances</a> = new List<<a class="el" href="a01082.html">ZibraSmokeAndFire</a>>()</td></tr>
- <tr class="memdesc:ae6f6139d03c6cb1987d13cac50d24523"><td class="mdescLeft"> </td><td class="mdescRight">A list of all instances of the Smoke & Fire solver. <br /></td></tr>
- <tr class="separator:ae6f6139d03c6cb1987d13cac50d24523"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
- Properties</h2></td></tr>
- <tr class="memitem:a6d4293288031a149d20f7884389e1505"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a6d4293288031a149d20f7884389e1505">ActiveSimulationMode</a><code> [get]</code></td></tr>
- <tr class="memdesc:a6d4293288031a149d20f7884389e1505"><td class="mdescLeft"> </td><td class="mdescRight">Simulation mode currently used by the simulation. Will not be changed if CurrentSimulationMode is changed after simulation has started. <br /></td></tr>
- <tr class="separator:a6d4293288031a149d20f7884389e1505"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abe78de671d42526358a0d4fa561437bc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#abe78de671d42526358a0d4fa561437bc">LastTimestep</a> = 0.0f<code> [get]</code></td></tr>
- <tr class="memdesc:abe78de671d42526358a0d4fa561437bc"><td class="mdescLeft"> </td><td class="mdescRight">Last used timestep. <br /></td></tr>
- <tr class="separator:abe78de671d42526358a0d4fa561437bc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7f55e56e8e512bd64f9f5aa3ed880ccb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a7f55e56e8e512bd64f9f5aa3ed880ccb">SimulationInternalTime</a> = 0.0f<code> [get]</code></td></tr>
- <tr class="memdesc:a7f55e56e8e512bd64f9f5aa3ed880ccb"><td class="mdescLeft"> </td><td class="mdescRight">Simulation time passed (in simulation time units) <br /></td></tr>
- <tr class="separator:a7f55e56e8e512bd64f9f5aa3ed880ccb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab372eb0691785420d7d9f5f9a6fad33b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#ab372eb0691785420d7d9f5f9a6fad33b">SimulationInternalFrame</a> = 0<code> [get]</code></td></tr>
- <tr class="memdesc:ab372eb0691785420d7d9f5f9a6fad33b"><td class="mdescLeft"> </td><td class="mdescRight">Number of simulation iterations done so far. <br /></td></tr>
- <tr class="separator:ab372eb0691785420d7d9f5f9a6fad33b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9fb3b7b8440479d4a0788152380101cf"><td class="memItemLeft" align="right" valign="top">Vector3Int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a9fb3b7b8440479d4a0788152380101cf">GridSize</a><code> [get]</code></td></tr>
- <tr class="memdesc:a9fb3b7b8440479d4a0788152380101cf"><td class="mdescLeft"> </td><td class="mdescRight">The grid size of the simulation. <br /></td></tr>
- <tr class="separator:a9fb3b7b8440479d4a0788152380101cf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0a35bae3070e845517bfcfb64688f2ca"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a0a35bae3070e845517bfcfb64688f2ca">CellSize</a><code> [get]</code></td></tr>
- <tr class="memdesc:a0a35bae3070e845517bfcfb64688f2ca"><td class="mdescLeft"> </td><td class="mdescRight">Size of single simulation node. <br /></td></tr>
- <tr class="separator:a0a35bae3070e845517bfcfb64688f2ca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af294bdac784bb625eaf8704ff2e88685"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#af294bdac784bb625eaf8704ff2e88685">Initialized</a> = false<code> [get]</code></td></tr>
- <tr class="memdesc:af294bdac784bb625eaf8704ff2e88685"><td class="mdescLeft"> </td><td class="mdescRight">Is simulation initialized. <br /></td></tr>
- <tr class="separator:af294bdac784bb625eaf8704ff2e88685"><td class="memSeparator" colspan="2"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01082.html#a08c0566c1c813868227dbde1574e2437">OnChanged</a></td></tr>
- <tr class="memdesc:a08c0566c1c813868227dbde1574e2437"><td class="mdescLeft"> </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"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Main Smoke & Fire solver component. </p>
- <p>Each Smoke & Fire component corresponds to one instance of simulation. Different instances of simulation can't interact with each other. </p>
- <p>Some parameters can't be after simulation has started and we created GPU buffers. Normally, simulation starts in playmode in OnEnable and stops in OnDisable. To change those parameters in runtime you want to have this component disabled, and after setting them, enable this component. </p>
- <p>OnEnable will allocate GPU buffers, which may cause stuttering. Consider enabling simulation volume on level load, but with simulation/render paused, to not pay the cost of fluid initialization during gameplay. </p>
- <p>Disabling simulation volume will free GPU buffers. This means that Smoke&Fire state will be lost. </p>
- <p>Various parameters of the simulation volume are spread throught multiple components. This is done so you can use Unity's Preset system to only change part of parameters. </p>
- </div><h2 class="groupheader">Member Enumeration Documentation</h2>
- <a id="a2c385f642822975febcc3c48fb9605bd" name="a2c385f642822975febcc3c48fb9605bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2c385f642822975febcc3c48fb9605bd">◆ </a></span>SimulationMode</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>See CurrentSimulationMode. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a24538a98739b1dabfa25721d5a02b158" name="a24538a98739b1dabfa25721d5a02b158"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a24538a98739b1dabfa25721d5a02b158">◆ </a></span>IsLoaded()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool IsLoaded </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>Simulation needs to do some loading before simulation can start. Loading starts during initialization of engine. If it takes too long and you start simulation too early it can stall engine until loading finishes. You can use this method to show loading screen to wait for loading to end and prevent stalling. </p>
- <dl class="section return"><dt>Returns</dt><dd>true - if starting simulation won't trigger stall false - if starting simulation will trigger stall </dd></dl>
- </div>
- </div>
- <a id="ad17e4331232fd54c8c9e970a02edfed3" name="ad17e4331232fd54c8c9e970a02edfed3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad17e4331232fd54c8c9e970a02edfed3">◆ </a></span>WaitLoad()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void WaitLoad </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>Stalls engine until all loading is finished See IsLoaded </p>
- </div>
- </div>
- <a id="a70437966da5eaae13ca8b167bedea7eb" name="a70437966da5eaae13ca8b167bedea7eb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a70437966da5eaae13ca8b167bedea7eb">◆ </a></span>ReleaseSimulation()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ReleaseSimulation </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>Releases simulation resources. </p>
- <p>This is automatically called in <code>OnDisable()</code>. When running simulation in edit mode, you may want to call it manually. </p>
- <p>Sets Initialize to false. </p>
- <p>Releases GPU resources and so frees up VRAM. </p>
- <p>Has no effect if simulation is not initialized. </p>
- </div>
- </div>
- <a id="a7a7e7d8a5040cee41196e023a9c05060" name="a7a7e7d8a5040cee41196e023a9c05060"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7a7e7d8a5040cee41196e023a9c05060">◆ </a></span>RemoveManipulator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void RemoveManipulator </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a01006.html">Manipulator</a> </td>
- <td class="paramname"><em>manipulator</em></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>Removes manipulator from the simulation. </p>
- <p>Can only be used if simulation is not initialized yet, e.g. when component is disabled. </p>
- </div>
- </div>
- <a id="aa58f899ad5137c8dd72d88a57a699227" name="aa58f899ad5137c8dd72d88a57a699227"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa58f899ad5137c8dd72d88a57a699227">◆ </a></span>GetManipulatorList()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">ReadOnlyCollection< <a class="el" href="a01006.html">Manipulator</a> > GetManipulatorList </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 read-only list of manipulators. </p>
- </div>
- </div>
- <a id="aac0ad2411b42670e36cc79a9865e6a95" name="aac0ad2411b42670e36cc79a9865e6a95"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aac0ad2411b42670e36cc79a9865e6a95">◆ </a></span>HasManipulator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool HasManipulator </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a01006.html">Manipulator</a> </td>
- <td class="paramname"><em>manipulator</em></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>Checks whether manipulator list has specified manipulator. </p>
- </div>
- </div>
- <a id="a6727531d04632327e5aa53292d37b73b" name="a6727531d04632327e5aa53292d37b73b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6727531d04632327e5aa53292d37b73b">◆ </a></span>AddManipulator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void AddManipulator </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a01006.html">Manipulator</a> </td>
- <td class="paramname"><em>manipulator</em></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>Adds manipulator to the simulation. </p>
- <p>Can only be used if simulation is not initialized yet, e.g. when component is disabled. </p>
- </div>
- </div>
- <a id="a4746d9bc10cb2d1892167d68570f20d3" name="a4746d9bc10cb2d1892167d68570f20d3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4746d9bc10cb2d1892167d68570f20d3">◆ </a></span>HasEmitter()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool HasEmitter </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>Checks if simulation has at least one emitter manipulator. </p>
- <p>Smoke & Fire simulation must have at least one emitter, otherwise it won't be able to generate any non empty state. </p>
- </div>
- </div>
- <a id="a5dc665c2e65c71491cb7a92a3db572be" name="a5dc665c2e65c71491cb7a92a3db572be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5dc665c2e65c71491cb7a92a3db572be">◆ </a></span>UpdateGridSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void UpdateGridSize </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>Updates values of some constants based on ContainerSize and GridResolution. </p>
- <p>Update values of CellSize and GridSize. </p>
- <p>Has no effect when simulation is initialized, since you can't modify aforementioned parameters in this case. </p>
- </div>
- </div>
- <a id="a4cc0b8f5b4aa1722c55211319a83de67" name="a4cc0b8f5b4aa1722c55211319a83de67"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4cc0b8f5b4aa1722c55211319a83de67">◆ </a></span>GetStats()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">List< string > GetStats </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>Return various stats of an object. </p>
- <p>This is implemented by simulation volumes and return values specific to that type of simulation. </p>
- <p>Implements <a class="el" href="a00678.html#a4cc0b8f5b4aa1722c55211319a83de67">StatReporter</a>.</p>
- </div>
- </div>
- <a id="a0af557e93137dbb3358b82ad34849b49" name="a0af557e93137dbb3358b82ad34849b49"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0af557e93137dbb3358b82ad34849b49">◆ </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> </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="ae6f6139d03c6cb1987d13cac50d24523" name="ae6f6139d03c6cb1987d13cac50d24523"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae6f6139d03c6cb1987d13cac50d24523">◆ </a></span>AllInstances</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">List<<a class="el" href="a01082.html">ZibraSmokeAndFire</a>> AllInstances = new List<<a class="el" href="a01082.html">ZibraSmokeAndFire</a>>()</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A list of all instances of the Smoke & Fire solver. </p>
- </div>
- </div>
- <a id="ac4792d27f7e5e4a3fc2337191231011a" name="ac4792d27f7e5e4a3fc2337191231011a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac4792d27f7e5e4a3fc2337191231011a">◆ </a></span>CurrentSimulationMode</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a> CurrentSimulationMode = SimulationMode.Fire</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Setting that determines the type of simulation being performed, with options including Smoke, Colored Smoke, and Fire. </p>
- <p>Smoke mode simulates a single colored smoke/fog/etc. </p>
- <p>Colored Smoke mode allows emitting smoke of a given color. </p>
- <p>Fire mode simulates smoke, fuel, and temperature components, allowing control of burning fuel to produce fire. </p>
- <p>Depending on this parameter, simulation will use different parameters defined in various other classes. </p>
- <p>Changing this parameter during simulation has no effect. See ActiveSimulationMode. </p>
- </div>
- </div>
- <a id="a513906c0545ef4c34563175adb79277f" name="a513906c0545ef4c34563175adb79277f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a513906c0545ef4c34563175adb79277f">◆ </a></span>MainLight</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Light MainLight</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Directional light that will be used for Smoke & Fire lighting. </p>
- <p>Must be set, otherwise simulation will not start. </p>
- <p>Can be freely modified at runtime. </p>
- </div>
- </div>
- <a id="a8fd6b7f69ecca3dc73e75ccb30100de4" name="a8fd6b7f69ecca3dc73e75ccb30100de4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8fd6b7f69ecca3dc73e75ccb30100de4">◆ </a></span>Lights</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">List<Light> Lights</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>List of point lights that contribute to Smoke & Fire lighting. </p>
- <p>You can add up to 16 lights to that list. </p>
- <p>Can be freely modified at runtime. </p>
- </div>
- </div>
- <a id="a57b3ef4623ad89b62fe4f32ef9de669f" name="a57b3ef4623ad89b62fe4f32ef9de669f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a57b3ef4623ad89b62fe4f32ef9de669f">◆ </a></span>Timestep</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Timestep = 1.00f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Timestep used in each simulation iteration. </p>
- </div>
- </div>
- <a id="a3388dde8463171695ffbfbf8902384c6" name="a3388dde8463171695ffbfbf8902384c6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3388dde8463171695ffbfbf8902384c6">◆ </a></span>MaxFramesInFlight</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UInt32 MaxFramesInFlight = 3</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum allowed number of frames queued to render. </p>
- <p>Only used when <code>QualitySettings.maxQueuedFrames</code> is not available or invalid. </p>
- <p>Defines number of frames we'll wait between submitting simulation workload and reading back simulation information back to the CPU. Higher values correspond to more delay for simulation info readback, while lower values can potentially decreasing framerate. </p>
- </div>
- </div>
- <a id="af20b00f33a5e5c39d46a5c26fd4c92f9" name="af20b00f33a5e5c39d46a5c26fd4c92f9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af20b00f33a5e5c39d46a5c26fd4c92f9">◆ </a></span>SimulationIterations</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int SimulationIterations = 3</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Number of simulation iterations per simulation frame. </p>
- <p>The simulation does 1/3 of the smoke simulation per iteration, and extrapolates the smoke movement in time for higher performance while keeping smooth movement. To do a full simulation per frame you can set it to 3 iterations, which may be beneficial in cases where the simulation interacts with quickly moving objects. </p>
- </div>
- </div>
- <a id="a5471ff6648f72a9e172b87554fd6c1b3" name="a5471ff6648f72a9e172b87554fd6c1b3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5471ff6648f72a9e172b87554fd6c1b3">◆ </a></span>GridResolution</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int GridResolution = 128</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Size of the simulation grid. </p>
- <p>This is the most important parameter for performance adjustment. </p>
- <p>Higher size of the grid corresponds to a higher quality simulation, but results in higher VRAM usage and a higher performance cost. </p>
- </div>
- </div>
- <a id="adbe358a3fdd13a7e7cea1a30b81cbe57" name="adbe358a3fdd13a7e7cea1a30b81cbe57"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adbe358a3fdd13a7e7cea1a30b81cbe57">◆ </a></span>RunSimulation</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool RunSimulation = true</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Freezes simulation when disabled. </p>
- <p>Also decreases performance cost when disabled, since simulation won�t run. </p>
- <p>Disabling this option does not prevent simulation from rendering. </p>
- </div>
- </div>
- <a id="af7aa989f02edf945bd79a0fd1feab791" name="af7aa989f02edf945bd79a0fd1feab791"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af7aa989f02edf945bd79a0fd1feab791">◆ </a></span>RunRendering</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool RunRendering = true</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enables rendering of the smoke/fire. </p>
- <p>Disabling rendering decreases performance cost. </p>
- <p>Disabling this option does not prevent simulation from running. </p>
- </div>
- </div>
- <a id="af1d6faf266c7e9c47ff8d56c50994d7e" name="af1d6faf266c7e9c47ff8d56c50994d7e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af1d6faf266c7e9c47ff8d56c50994d7e">◆ </a></span>FixVolumeWorldPosition</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool FixVolumeWorldPosition = true</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>When enabled, moving simulation volume will not disturb simulation. When disabled, smoke/fire will try to stay in place in world space. </p>
- <p>If you want to move the simulation around the scene, you want to disable this option. </p>
- </div>
- </div>
- <a id="a946e85fa04a56c9a658c62641f8df3c7" name="a946e85fa04a56c9a658c62641f8df3c7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a946e85fa04a56c9a658c62641f8df3c7">◆ </a></span>EnableDownscale</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool EnableDownscale = false</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allows you to render Smoke & Fire in lower resolution. </p>
- </div>
- </div>
- <a id="a6183f87b169d9690a53e7312507c2a42" name="a6183f87b169d9690a53e7312507c2a42"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6183f87b169d9690a53e7312507c2a42">◆ </a></span>DownscaleFactor</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float DownscaleFactor = 0.5f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Scale width/height of smoke & fire render. </p>
- <p>Pixel count is decreased by factor of DownscaleFactor * DownscaleFactor. </p>
- <p>Doesn't have any effect unless EnableDownscale is set to true. </p>
- </div>
- </div>
- <a id="a0e3da4c5b2449adcbf9348c54e50812d" name="a0e3da4c5b2449adcbf9348c54e50812d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e3da4c5b2449adcbf9348c54e50812d">◆ </a></span>ContainerSize</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Vector3 ContainerSize = new Vector3(5, 5, 5)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Size of the simulation volume. </p>
- </div>
- </div>
- <a id="a60f1ebf5864cafb3a02fb0441724bb71" name="a60f1ebf5864cafb3a02fb0441724bb71"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a60f1ebf5864cafb3a02fb0441724bb71">◆ </a></span>SimulationContainerPosition</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Vector3 SimulationContainerPosition</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Last simulated container position. </p>
- </div>
- </div>
- <a id="a96a6f56e74c3c80dbbc8676e313bdd94" name="a96a6f56e74c3c80dbbc8676e313bdd94"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a96a6f56e74c3c80dbbc8676e313bdd94">◆ </a></span>CurrentInjectionPoint</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">CameraEvent CurrentInjectionPoint = CameraEvent.BeforeForwardAlpha</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Injection point used for BRP render. </p>
- </div>
- </div>
- <a id="afcac8381e4e2985d8950aa58684e852a" name="afcac8381e4e2985d8950aa58684e852a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afcac8381e4e2985d8950aa58684e852a">◆ </a></span>LimitFramerate</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool LimitFramerate = true</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Whether to limit maximum number of smoke simulation iterations per second. </p>
- </div>
- </div>
- <a id="ad2ec1cd6873831fe75a9de4b2f6416cd" name="ad2ec1cd6873831fe75a9de4b2f6416cd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2ec1cd6873831fe75a9de4b2f6416cd">◆ </a></span>MaximumFramerate</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MaximumFramerate = 60.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum simulation iterations per second. </p>
- <p>Has no effect if LimitFramerate is set to false. </p>
- </div>
- </div>
- <a id="a448c1b79bc5cf8c39accde429a5055bd" name="a448c1b79bc5cf8c39accde429a5055bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a448c1b79bc5cf8c39accde429a5055bd">◆ </a></span>solverParameters</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="a00994.html">ZibraSmokeAndFireSolverParameters</a> solverParameters</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Main parameters of the simulation. </p>
- </div>
- </div>
- <a id="adf37d6d706a8e2bea1c3627c23a81da8" name="adf37d6d706a8e2bea1c3627c23a81da8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adf37d6d706a8e2bea1c3627c23a81da8">◆ </a></span>materialParameters</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="a00990.html">ZibraSmokeAndFireMaterialParameters</a> materialParameters</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Main rendering parameters. </p>
- </div>
- </div>
- <h2 class="groupheader">Property Documentation</h2>
- <a id="a6d4293288031a149d20f7884389e1505" name="a6d4293288031a149d20f7884389e1505"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6d4293288031a149d20f7884389e1505">◆ </a></span>ActiveSimulationMode</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="a01082.html#a2c385f642822975febcc3c48fb9605bd">SimulationMode</a> ActiveSimulationMode</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Simulation mode currently used by the simulation. Will not be changed if CurrentSimulationMode is changed after simulation has started. </p>
- <p>Only valid when simulation is initialized. </p>
- <p>CurrentSimulationMode is copied to this member on simulation initialization, and it can't change until simulation deinitialization. </p>
- </div>
- </div>
- <a id="abe78de671d42526358a0d4fa561437bc" name="abe78de671d42526358a0d4fa561437bc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abe78de671d42526358a0d4fa561437bc">◆ </a></span>LastTimestep</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float LastTimestep = 0.0f</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Last used timestep. </p>
- </div>
- </div>
- <a id="a7f55e56e8e512bd64f9f5aa3ed880ccb" name="a7f55e56e8e512bd64f9f5aa3ed880ccb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7f55e56e8e512bd64f9f5aa3ed880ccb">◆ </a></span>SimulationInternalTime</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float SimulationInternalTime = 0.0f</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Simulation time passed (in simulation time units) </p>
- </div>
- </div>
- <a id="ab372eb0691785420d7d9f5f9a6fad33b" name="ab372eb0691785420d7d9f5f9a6fad33b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab372eb0691785420d7d9f5f9a6fad33b">◆ </a></span>SimulationInternalFrame</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int SimulationInternalFrame = 0</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Number of simulation iterations done so far. </p>
- </div>
- </div>
- <a id="a9fb3b7b8440479d4a0788152380101cf" name="a9fb3b7b8440479d4a0788152380101cf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9fb3b7b8440479d4a0788152380101cf">◆ </a></span>GridSize</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Vector3Int GridSize</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The grid size of the simulation. </p>
- </div>
- </div>
- <a id="a0a35bae3070e845517bfcfb64688f2ca" name="a0a35bae3070e845517bfcfb64688f2ca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0a35bae3070e845517bfcfb64688f2ca">◆ </a></span>CellSize</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float CellSize</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Size of single simulation node. </p>
- </div>
- </div>
- <a id="af294bdac784bb625eaf8704ff2e88685" name="af294bdac784bb625eaf8704ff2e88685"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af294bdac784bb625eaf8704ff2e88685">◆ </a></span>Initialized</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Initialized = false</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Is simulation initialized. </p>
- </div>
- </div>
- <h2 class="groupheader">Event Documentation</h2>
- <a id="a08c0566c1c813868227dbde1574e2437" name="a08c0566c1c813868227dbde1574e2437"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a08c0566c1c813868227dbde1574e2437">◆ </a></span>OnChanged</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Action OnChanged</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/ZibraSmokeAndFire.cs</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <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>
|