a00846.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.7"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Zibra Effects: ZibraLiquidForceField Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js.txt"></script>
  11. <script type="text/javascript" src="dynsections.js.txt"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js.txt"></script>
  14. <script type="text/javascript" src="search/search.js.txt"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr id="projectrow">
  23. <td id="projectalign">
  24. <div id="projectname">Zibra Effects
  25. </div>
  26. <div id="projectbrief">Real-time Simulated Visual Effects</div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.7 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js.txt"></script>
  40. <script type="text/javascript" src="menu.js.txt"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. <div id="nav-path" class="navpath">
  70. <ul>
  71. <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="a00341.html">liquid</a></li><li class="navelem"><a class="el" href="a00358.html">Manipulators</a></li><li class="navelem"><a class="el" href="a00846.html">ZibraLiquidForceField</a></li> </ul>
  72. </div>
  73. </div><!-- top -->
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#pub-types">Public Types</a> &#124;
  77. <a href="#pub-methods">Public Member Functions</a> &#124;
  78. <a href="#pub-attribs">Public Attributes</a> &#124;
  79. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  80. <a href="#events">Events</a> &#124;
  81. <a href="a00843.html">List of all members</a> </div>
  82. <div class="headertitle"><div class="title">ZibraLiquidForceField Class Reference</div></div>
  83. </div><!--header-->
  84. <div class="contents">
  85. <p>Manipulator used for applying force to liquid particles.
  86. <a href="a00846.html#details">More...</a></p>
  87. <table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  89. Public Types</h2></td></tr>
  90. <tr class="memitem:a32fbf9de7fc7c5f290a83839cfafb32a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a32fbf9de7fc7c5f290a83839cfafb32a">ForceFieldType</a> { <b>Radial</b>
  91. , <b>Directional</b>
  92. , <b>Swirl</b>
  93. }</td></tr>
  94. <tr class="memdesc:a32fbf9de7fc7c5f290a83839cfafb32a"><td class="mdescLeft">&#160;</td><td class="mdescRight">See Type. <a href="a00846.html#a32fbf9de7fc7c5f290a83839cfafb32a">More...</a><br /></td></tr>
  95. <tr class="separator:a32fbf9de7fc7c5f290a83839cfafb32a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:acf8e584d95cf66831f54e2d9c933b2ff"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#acf8e584d95cf66831f54e2d9c933b2ff">InteractionMode</a> { <b>AllParticleSpecies</b>
  97. , <b>OnlySelectedParticleSpecies</b>
  98. , <b>ExceptSelectedParticleSpecies</b>
  99. }</td></tr>
  100. <tr class="memdesc:acf8e584d95cf66831f54e2d9c933b2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">See CurrentInteractionMode. <a href="a00818.html#acf8e584d95cf66831f54e2d9c933b2ff">More...</a><br /></td></tr>
  101. <tr class="separator:acf8e584d95cf66831f54e2d9c933b2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a57c404a5c07698ea543d2d900d60c282"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a> { <br />
  103. &#160;&#160;<b>Emitter</b>
  104. , <b>Void</b>
  105. , <b>ForceField</b>
  106. , <b>AnalyticCollider</b>
  107. , <br />
  108. &#160;&#160;<b>NeuralCollider</b>
  109. , <b>GroupCollider</b>
  110. , <b>Detector</b>
  111. , <b>SpeciesModifier</b>
  112. , <br />
  113. &#160;&#160;<b>HeightmapCollider</b>
  114. , <b>TypeNum</b>
  115. <br />
  116. }</td></tr>
  117. <tr class="memdesc:a57c404a5c07698ea543d2d900d60c282"><td class="mdescLeft">&#160;</td><td class="mdescRight">Manipulator types. <a href="a00818.html#a57c404a5c07698ea543d2d900d60c282">More...</a><br /></td></tr>
  118. <tr class="separator:a57c404a5c07698ea543d2d900d60c282"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table><table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  121. Public Member Functions</h2></td></tr>
  122. <tr class="memitem:a0cc6337a69e8c76553e48455bf51b6d2"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="a00818.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a0cc6337a69e8c76553e48455bf51b6d2">GetManipulatorType</a> ()</td></tr>
  123. <tr class="memdesc:a0cc6337a69e8c76553e48455bf51b6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns manipulator type. <br /></td></tr>
  124. <tr class="separator:a0cc6337a69e8c76553e48455bf51b6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a3d39c8704dab2e95325799dba1a1b5d2"><td class="memItemLeft" align="right" valign="top">override Color&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a3d39c8704dab2e95325799dba1a1b5d2">GetGizmosColor</a> ()</td></tr>
  126. <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>
  127. <tr class="separator:a3d39c8704dab2e95325799dba1a1b5d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a0af557e93137dbb3358b82ad34849b49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#a0af557e93137dbb3358b82ad34849b49">NotifyChange</a> ()</td></tr>
  129. <tr class="memdesc:a0af557e93137dbb3358b82ad34849b49"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Editor only) Triggers custom editor update. <br /></td></tr>
  130. <tr class="separator:a0af557e93137dbb3358b82ad34849b49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table><table class="memberdecls">
  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  133. Public Attributes</h2></td></tr>
  134. <tr class="memitem:ae5f7ff99bf32ead3084e1e6dac3b430d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00846.html#a32fbf9de7fc7c5f290a83839cfafb32a">ForceFieldType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#ae5f7ff99bf32ead3084e1e6dac3b430d">Type</a> = ForceFieldType.Radial</td></tr>
  135. <tr class="memdesc:ae5f7ff99bf32ead3084e1e6dac3b430d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of force field, which defines how force will be applied. <br /></td></tr>
  136. <tr class="separator:ae5f7ff99bf32ead3084e1e6dac3b430d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a7e0af77c63d277b389e7bb0caace453c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a7e0af77c63d277b389e7bb0caace453c">Strength</a> = 1.0f</td></tr>
  138. <tr class="memdesc:a7e0af77c63d277b389e7bb0caace453c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strength multiplier for force applied to liquid. <br /></td></tr>
  139. <tr class="separator:a7e0af77c63d277b389e7bb0caace453c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ab0800ac4069fa2c586dcc4381f0f3302"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#ab0800ac4069fa2c586dcc4381f0f3302">DistanceDecay</a> = 1.0f</td></tr>
  141. <tr class="memdesc:ab0800ac4069fa2c586dcc4381f0f3302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rate of force decreasing with distance. <br /></td></tr>
  142. <tr class="separator:ab0800ac4069fa2c586dcc4381f0f3302"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a08833227d2ee28f27ed94a845213b818"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a08833227d2ee28f27ed94a845213b818">DistanceOffset</a> = 0.0f</td></tr>
  144. <tr class="memdesc:a08833227d2ee28f27ed94a845213b818"><td class="mdescLeft">&#160;</td><td class="mdescRight">Distance offset for calculations of DistanceDecay and DisableForceInside. <br /></td></tr>
  145. <tr class="separator:a08833227d2ee28f27ed94a845213b818"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a443a720f6566e49fa3b8b2418b8300a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a443a720f6566e49fa3b8b2418b8300a5">DisableForceInside</a> = true</td></tr>
  147. <tr class="memdesc:a443a720f6566e49fa3b8b2418b8300a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables applying force to particle if it's inside force field shape. <br /></td></tr>
  148. <tr class="separator:a443a720f6566e49fa3b8b2418b8300a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a924c88f570a7d97dfeb2ebd2e1728cc8"><td class="memItemLeft" align="right" valign="top">Vector3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00846.html#a924c88f570a7d97dfeb2ebd2e1728cc8">ForceDirection</a> = Vector3.up</td></tr>
  150. <tr class="memdesc:a924c88f570a7d97dfeb2ebd2e1728cc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direction for the force. Behaviour depends on Type. <br /></td></tr>
  151. <tr class="separator:a924c88f570a7d97dfeb2ebd2e1728cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:acdda3b9dead9602c5536cebaacc37f9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00818.html#acf8e584d95cf66831f54e2d9c933b2ff">InteractionMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#acdda3b9dead9602c5536cebaacc37f9f">CurrentInteractionMode</a> = InteractionMode.AllParticleSpecies</td></tr>
  153. <tr class="memdesc:acdda3b9dead9602c5536cebaacc37f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines which particle species will interact with manipulator. <br /></td></tr>
  154. <tr class="separator:acdda3b9dead9602c5536cebaacc37f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a2a65a398720fc91dbb008f7ec17bd026"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#a2a65a398720fc91dbb008f7ec17bd026">ParticleSpecies</a> = 0</td></tr>
  156. <tr class="memdesc:a2a65a398720fc91dbb008f7ec17bd026"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects particle species for CurrentInteractionMode. <br /></td></tr>
  157. <tr class="separator:a2a65a398720fc91dbb008f7ec17bd026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  160. Static Public Attributes</h2></td></tr>
  161. <tr class="memitem:a9757aa7d1641b03848849a141bbeb7a0"><td class="memItemLeft" align="right" valign="top">static readonly List&lt; <a class="el" href="a00818.html">Manipulator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#a9757aa7d1641b03848849a141bbeb7a0">AllManipulators</a> = new List&lt;<a class="el" href="a00818.html">Manipulator</a>&gt;()</td></tr>
  162. <tr class="memdesc:a9757aa7d1641b03848849a141bbeb7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of all enabled manipulators. <br /></td></tr>
  163. <tr class="separator:a9757aa7d1641b03848849a141bbeb7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table><table class="memberdecls">
  165. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="events" name="events"></a>
  166. Events</h2></td></tr>
  167. <tr class="memitem:a08c0566c1c813868227dbde1574e2437"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00818.html#a08c0566c1c813868227dbde1574e2437">OnChanged</a></td></tr>
  168. <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>
  169. <tr class="separator:a08c0566c1c813868227dbde1574e2437"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. </table>
  171. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  172. <div class="textblock"><p>Manipulator used for applying force to liquid particles. </p>
  173. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  174. <a id="a32fbf9de7fc7c5f290a83839cfafb32a" name="a32fbf9de7fc7c5f290a83839cfafb32a"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#a32fbf9de7fc7c5f290a83839cfafb32a">&#9670;&#160;</a></span>ForceFieldType</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">enum <a class="el" href="a00846.html#a32fbf9de7fc7c5f290a83839cfafb32a">ForceFieldType</a></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>See Type. </p>
  185. </div>
  186. </div>
  187. <a id="acf8e584d95cf66831f54e2d9c933b2ff" name="acf8e584d95cf66831f54e2d9c933b2ff"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#acf8e584d95cf66831f54e2d9c933b2ff">&#9670;&#160;</a></span>InteractionMode</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="mlabels">
  192. <tr>
  193. <td class="mlabels-left">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">enum <a class="el" href="a00818.html#acf8e584d95cf66831f54e2d9c933b2ff">InteractionMode</a></td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>See CurrentInteractionMode. </p>
  206. </div>
  207. </div>
  208. <a id="a57c404a5c07698ea543d2d900d60c282" name="a57c404a5c07698ea543d2d900d60c282"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a57c404a5c07698ea543d2d900d60c282">&#9670;&#160;</a></span>ManipulatorType</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">enum <a class="el" href="a00818.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a></td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Manipulator types. </p>
  227. </div>
  228. </div>
  229. <h2 class="groupheader">Member Function Documentation</h2>
  230. <a id="a0cc6337a69e8c76553e48455bf51b6d2" name="a0cc6337a69e8c76553e48455bf51b6d2"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a0cc6337a69e8c76553e48455bf51b6d2">&#9670;&#160;</a></span>GetManipulatorType()</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="mlabels">
  235. <tr>
  236. <td class="mlabels-left">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">override <a class="el" href="a00818.html#a57c404a5c07698ea543d2d900d60c282">ManipulatorType</a> GetManipulatorType </td>
  240. <td>(</td>
  241. <td class="paramname"></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </td>
  246. <td class="mlabels-right">
  247. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Returns manipulator type. </p>
  252. <p>Implements <a class="el" href="a00818.html#a7b67630a436d353dbe5e0f75471b0650">Manipulator</a>.</p>
  253. </div>
  254. </div>
  255. <a id="a3d39c8704dab2e95325799dba1a1b5d2" name="a3d39c8704dab2e95325799dba1a1b5d2"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#a3d39c8704dab2e95325799dba1a1b5d2">&#9670;&#160;</a></span>GetGizmosColor()</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="mlabels">
  260. <tr>
  261. <td class="mlabels-left">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">override Color GetGizmosColor </td>
  265. <td>(</td>
  266. <td class="paramname"></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </td>
  271. <td class="mlabels-right">
  272. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>(Editor only) Returns gizmo color that should be used with current manipulator. </p>
  277. <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>
  278. <p>Implements <a class="el" href="a00630.html#a05370caa7e5b4ff2854b37d4ce3dac98">Manipulator</a>.</p>
  279. </div>
  280. </div>
  281. <a id="a0af557e93137dbb3358b82ad34849b49" name="a0af557e93137dbb3358b82ad34849b49"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#a0af557e93137dbb3358b82ad34849b49">&#9670;&#160;</a></span>NotifyChange()</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">void NotifyChange </td>
  291. <td>(</td>
  292. <td class="paramname"></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>(Editor only) Triggers custom editor update. </p>
  303. <p>Just triggers OnChanged. </p>
  304. </div>
  305. </div>
  306. <h2 class="groupheader">Member Data Documentation</h2>
  307. <a id="ae5f7ff99bf32ead3084e1e6dac3b430d" name="ae5f7ff99bf32ead3084e1e6dac3b430d"></a>
  308. <h2 class="memtitle"><span class="permalink"><a href="#ae5f7ff99bf32ead3084e1e6dac3b430d">&#9670;&#160;</a></span>Type</h2>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname"><a class="el" href="a00846.html#a32fbf9de7fc7c5f290a83839cfafb32a">ForceFieldType</a> Type = ForceFieldType.Radial</td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Type of force field, which defines how force will be applied. </p>
  318. </div>
  319. </div>
  320. <a id="a7e0af77c63d277b389e7bb0caace453c" name="a7e0af77c63d277b389e7bb0caace453c"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a7e0af77c63d277b389e7bb0caace453c">&#9670;&#160;</a></span>Strength</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">float Strength = 1.0f</td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Strength multiplier for force applied to liquid. </p>
  331. </div>
  332. </div>
  333. <a id="ab0800ac4069fa2c586dcc4381f0f3302" name="ab0800ac4069fa2c586dcc4381f0f3302"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#ab0800ac4069fa2c586dcc4381f0f3302">&#9670;&#160;</a></span>DistanceDecay</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">float DistanceDecay = 1.0f</td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Rate of force decreasing with distance. </p>
  344. <p>To affect liquid independently of distance, set to lowest value. </p>
  345. </div>
  346. </div>
  347. <a id="a08833227d2ee28f27ed94a845213b818" name="a08833227d2ee28f27ed94a845213b818"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a08833227d2ee28f27ed94a845213b818">&#9670;&#160;</a></span>DistanceOffset</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">float DistanceOffset = 0.0f</td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Distance offset for calculations of DistanceDecay and DisableForceInside. </p>
  358. </div>
  359. </div>
  360. <a id="a443a720f6566e49fa3b8b2418b8300a5" name="a443a720f6566e49fa3b8b2418b8300a5"></a>
  361. <h2 class="memtitle"><span class="permalink"><a href="#a443a720f6566e49fa3b8b2418b8300a5">&#9670;&#160;</a></span>DisableForceInside</h2>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="memname">
  365. <tr>
  366. <td class="memname">bool DisableForceInside = true</td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Disables applying force to particle if it's inside force field shape. </p>
  371. <p>This may help when trying to make force liquid into specific shape. </p>
  372. <p>Force disabling doesn't have hard cutoff, but rather it gradually decreases force to 0 near edge of the shape. </p>
  373. </div>
  374. </div>
  375. <a id="a924c88f570a7d97dfeb2ebd2e1728cc8" name="a924c88f570a7d97dfeb2ebd2e1728cc8"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a924c88f570a7d97dfeb2ebd2e1728cc8">&#9670;&#160;</a></span>ForceDirection</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">Vector3 ForceDirection = Vector3.up</td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Direction for the force. Behaviour depends on Type. </p>
  386. <p>Direction is used as follows, depending on Type:</p><ul>
  387. <li>Radial - Unused</li>
  388. <li>Directional - Liquid is pushed into specified direction</li>
  389. <li>Swirl - Liquid is rotated along specified axis. To reverse rotation, invert direction </li>
  390. </ul>
  391. </div>
  392. </div>
  393. <a id="a9757aa7d1641b03848849a141bbeb7a0" name="a9757aa7d1641b03848849a141bbeb7a0"></a>
  394. <h2 class="memtitle"><span class="permalink"><a href="#a9757aa7d1641b03848849a141bbeb7a0">&#9670;&#160;</a></span>AllManipulators</h2>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="mlabels">
  398. <tr>
  399. <td class="mlabels-left">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname">readonly List&lt;<a class="el" href="a00818.html">Manipulator</a>&gt; AllManipulators = new List&lt;<a class="el" href="a00818.html">Manipulator</a>&gt;()</td>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>List of all enabled manipulators. </p>
  412. </div>
  413. </div>
  414. <a id="acdda3b9dead9602c5536cebaacc37f9f" name="acdda3b9dead9602c5536cebaacc37f9f"></a>
  415. <h2 class="memtitle"><span class="permalink"><a href="#acdda3b9dead9602c5536cebaacc37f9f">&#9670;&#160;</a></span>CurrentInteractionMode</h2>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="mlabels">
  419. <tr>
  420. <td class="mlabels-left">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname"><a class="el" href="a00818.html#acf8e584d95cf66831f54e2d9c933b2ff">InteractionMode</a> CurrentInteractionMode = InteractionMode.AllParticleSpecies</td>
  424. </tr>
  425. </table>
  426. </td>
  427. <td class="mlabels-right">
  428. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Defines which particle species will interact with manipulator. </p>
  433. </div>
  434. </div>
  435. <a id="a2a65a398720fc91dbb008f7ec17bd026" name="a2a65a398720fc91dbb008f7ec17bd026"></a>
  436. <h2 class="memtitle"><span class="permalink"><a href="#a2a65a398720fc91dbb008f7ec17bd026">&#9670;&#160;</a></span>ParticleSpecies</h2>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="mlabels">
  440. <tr>
  441. <td class="mlabels-left">
  442. <table class="memname">
  443. <tr>
  444. <td class="memname">int ParticleSpecies = 0</td>
  445. </tr>
  446. </table>
  447. </td>
  448. <td class="mlabels-right">
  449. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Selects particle species for CurrentInteractionMode. </p>
  454. <p>Has no effect when CurrentInteractionMode is set to AllParticleSpecies. </p>
  455. </div>
  456. </div>
  457. <h2 class="groupheader">Event Documentation</h2>
  458. <a id="a08c0566c1c813868227dbde1574e2437" name="a08c0566c1c813868227dbde1574e2437"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#a08c0566c1c813868227dbde1574e2437">&#9670;&#160;</a></span>OnChanged</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="mlabels">
  463. <tr>
  464. <td class="mlabels-left">
  465. <table class="memname">
  466. <tr>
  467. <td class="memname">Action OnChanged</td>
  468. </tr>
  469. </table>
  470. </td>
  471. <td class="mlabels-right">
  472. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. <p>(Editor only) Event that is triggered when state of manipulator changes to trigger update of custom editor. </p>
  477. <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>
  478. </div>
  479. </div>
  480. <hr/>The documentation for this class was generated from the following file:<ul>
  481. <li>Assets/Plugins/Zibra/Liquid/Scripts/Solver/Manipulators/ZibraLiquidForceField.cs</li>
  482. </ul>
  483. </div><!-- contents -->
  484. <!-- start footer part -->
  485. <hr class="footer"/><address class="footer"><small>
  486. 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
  487. </small></address>
  488. </body>
  489. </html>