Mluti-Agent_simulation/3DModule/Assets/Plugins/Zibra/Common/Documentation/APIReference/a00650.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zibra Effects: GenerationQueue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js.txt"></script>
<script type="text/javascript" src="dynsections.js.txt"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js.txt"></script>
<script type="text/javascript" src="search/search.js.txt"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Zibra Effects
   </div>
   <div id="projectbrief">Real-time Simulated Visual Effects</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js.txt"></script>
<script type="text/javascript" src="menu.js.txt"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="a00335.html">com</a></li><li class="navelem"><a class="el" href="a00336.html">zibra</a></li><li class="navelem"><a class="el" href="a00337.html">common</a></li><li class="navelem"><a class="el" href="a00340.html">Editor</a></li><li class="navelem"><a class="el" href="a00352.html">SDFObjects</a></li><li class="navelem"><a class="el" href="a00650.html">GenerationQueue</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="a00647.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">GenerationQueue Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Static class, responsible for scheduling generation requests.  
 <a href="a00650.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:adafd7ccce9839604b7280c4f20b8bd70"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#adafd7ccce9839604b7280c4f20b8bd70">AddToQueue</a> (<a class="el" href="a00642.html">NeuralSDF</a> sdf)</td></tr>
<tr class="memdesc:adafd7ccce9839604b7280c4f20b8bd70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds <a class="el" href="">NeuralSDF</a> to the generation queue.  <br /></td></tr>
<tr class="separator:adafd7ccce9839604b7280c4f20b8bd70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd5d0edeb619cea7a094e18bbcb75686"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#acd5d0edeb619cea7a094e18bbcb75686">AddToQueue</a> (<a class="el" href="a00670.html">SkinnedMeshSDF</a> sdf)</td></tr>
<tr class="memdesc:acd5d0edeb619cea7a094e18bbcb75686"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds <a class="el" href="">SkinnedMeshSDF</a> to the generation queue.  <br /></td></tr>
<tr class="separator:acd5d0edeb619cea7a094e18bbcb75686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79d921e6c2f9e252ef3378d98d4636d2"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#a79d921e6c2f9e252ef3378d98d4636d2">Abort</a> ()</td></tr>
<tr class="memdesc:a79d921e6c2f9e252ef3378d98d4636d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears generation queue, canceling all generation requests.  <br /></td></tr>
<tr class="separator:a79d921e6c2f9e252ef3378d98d4636d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7855a853e83e845dc77305cf8d5a4ac9"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#a7855a853e83e845dc77305cf8d5a4ac9">GetQueueLength</a> ()</td></tr>
<tr class="memdesc:a7855a853e83e845dc77305cf8d5a4ac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns number of elements in the queue.  <br /></td></tr>
<tr class="separator:a7855a853e83e845dc77305cf8d5a4ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f41d85c995b1a6ec47f7b2d7e534e0"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#a09f41d85c995b1a6ec47f7b2d7e534e0">Contains</a> (<a class="el" href="a00642.html">NeuralSDF</a> sdf)</td></tr>
<tr class="memdesc:a09f41d85c995b1a6ec47f7b2d7e534e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if <a class="el" href="">NeuralSDF</a> is queued for generation.  <br /></td></tr>
<tr class="separator:a09f41d85c995b1a6ec47f7b2d7e534e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acffe8c04a70b152b53a8b1c603ba6e08"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00650.html#acffe8c04a70b152b53a8b1c603ba6e08">Contains</a> (<a class="el" href="a00670.html">SkinnedMeshSDF</a> sdf)</td></tr>
<tr class="memdesc:acffe8c04a70b152b53a8b1c603ba6e08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if <a class="el" href="">SkinnedMeshSDF</a> is queued for generation.  <br /></td></tr>
<tr class="separator:acffe8c04a70b152b53a8b1c603ba6e08"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Static class, responsible for scheduling generation requests. </p>
<p>This class is a queue of objects to generate. If it's not empty, we are generating exactly 1 object. As soon as generation of an object ends, either next one starts, or queue becomes empty and generation stops. </p>
<p>Note that generation uses ZibraAI's servers, and so:</p><ol type="1">
<li>It sends your mesh to that server</li>
<li>If generating too much you may get rate limited and generation may fail </li>
</ol>
<p>All requests processed in FIFO order: First In - First Out. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adafd7ccce9839604b7280c4f20b8bd70" name="adafd7ccce9839604b7280c4f20b8bd70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adafd7ccce9839604b7280c4f20b8bd70">&#9670;&#160;</a></span>AddToQueue() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void AddToQueue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00642.html">NeuralSDF</a>&#160;</td>
          <td class="paramname"><em>sdf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds <a class="el" href="">NeuralSDF</a> to the generation queue. </p>
<p>All objects in the generation queue will be generated automatically. </p>

</div>
</div>
<a id="acd5d0edeb619cea7a094e18bbcb75686" name="acd5d0edeb619cea7a094e18bbcb75686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd5d0edeb619cea7a094e18bbcb75686">&#9670;&#160;</a></span>AddToQueue() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void AddToQueue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00670.html">SkinnedMeshSDF</a>&#160;</td>
          <td class="paramname"><em>sdf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds <a class="el" href="">SkinnedMeshSDF</a> to the generation queue. </p>
<p>All objects in the generation queue will be generated automatically. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void Abort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Clears generation queue, canceling all generation requests. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int GetQueueLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns number of elements in the queue. </p>

</div>
</div>
<a id="a09f41d85c995b1a6ec47f7b2d7e534e0" name="a09f41d85c995b1a6ec47f7b2d7e534e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09f41d85c995b1a6ec47f7b2d7e534e0">&#9670;&#160;</a></span>Contains() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool Contains </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00642.html">NeuralSDF</a>&#160;</td>
          <td class="paramname"><em>sdf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Checks if <a class="el" href="">NeuralSDF</a> is queued for generation. </p>

</div>
</div>
<a id="acffe8c04a70b152b53a8b1c603ba6e08" name="acffe8c04a70b152b53a8b1c603ba6e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acffe8c04a70b152b53a8b1c603ba6e08">&#9670;&#160;</a></span>Contains() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool Contains </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00670.html">SkinnedMeshSDF</a>&#160;</td>
          <td class="paramname"><em>sdf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Checks if <a class="el" href="">SkinnedMeshSDF</a> is queued for generation. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Assets/Plugins/Zibra/Common/Scripts/Solver/Manipulators/SDF/NeuralSDFGenerator.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>