index.html 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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: Zibra Effects API 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. </div><!-- top -->
  51. <!-- window showing the filter options -->
  52. <div id="MSearchSelectWindow"
  53. onmouseover="return searchBox.OnSearchSelectShow()"
  54. onmouseout="return searchBox.OnSearchSelectHide()"
  55. onkeydown="return searchBox.OnSearchSelectKey(event)">
  56. </div>
  57. <!-- iframe showing the search results (closed by default) -->
  58. <div id="MSearchResultsWindow">
  59. <div id="MSearchResults">
  60. <div class="SRPage">
  61. <div id="SRIndex">
  62. <div id="SRResults"></div>
  63. <div class="SRStatus" id="Loading">Loading...</div>
  64. <div class="SRStatus" id="Searching">Searching...</div>
  65. <div class="SRStatus" id="NoMatches">No Matches</div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. <div><div class="header">
  71. <div class="headertitle"><div class="title">Zibra Effects API Reference </div></div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <div class="textblock"><p><a class="anchor" id="md__e_1_2_work_2_zibra_effects_2_doxygen_2_main_page"></a> API Reference provides details of C# interface for Zibra Effects. <br />
  75. To efficiently use API, you should familiarize yourself with basic concepts of Zibra Effects, so if you haven't already, please check out User Guide.</p>
  76. <p>To start browsing API Reference, go to Classes list to find one you are interested in. <br />
  77. If you aren't sure where to start from:</p><ul>
  78. <li>For Liquid, go to <code>com.zibra.liquid.Solver.ZibraLiquid</code>, which is simulation volume component, responsible for running liquid simulation</li>
  79. <li>For Smoke &amp; Fire, go to <code>com.zibra.smoke_and_fire.Solver.ZibraSmokeAndFire</code> which is simulation volume component, responsible for running smoke &amp; fire simulation</li>
  80. </ul>
  81. <p>Points of interest for Liquid would be:</p><ul>
  82. <li><code>com.zibra.liquid.Manipulators</code> - Namespace with all manipulator types.</li>
  83. <li><code>com.zibra.liquid.SDFObjects</code> - Namespace with all SDF types.</li>
  84. <li><code>com.zibra.liquid.DataStructures</code> - Namespace with classes that serve as parameter containers for liquid.</li>
  85. </ul>
  86. <p>Points of interest for Smoke &amp; Fire would be:</p><ul>
  87. <li><code>com.zibra.smoke_and_fire.Manipulators</code> - Namespace with all manipulator types.</li>
  88. <li><code>com.zibra.smoke_and_fire.SDFObjects</code> - Namespace with all SDF types.</li>
  89. <li><code>com.zibra.smoke_and_fire.DataStructures</code> - Namespace with classes that serve as parameter containers for liquid. </li>
  90. </ul>
  91. </div></div><!-- PageDoc -->
  92. </div><!-- contents -->
  93. <!-- start footer part -->
  94. <hr class="footer"/><address class="footer"><small>
  95. 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
  96. </small></address>
  97. </body>
  98. </html>