Skip to content

Commit dad60a2

Browse files
KforKelvinKforKelvin
committed
Update SC_PythonAPI_documentation with latest changes
1 parent 2dcc1c1 commit dad60a2

File tree

1 file changed

+106
-1
lines changed

1 file changed

+106
-1
lines changed

‎spaceteams/SC_Compute_Server.html‎

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,21 @@ <h2 class="section-title" id="header-functions">Functions</h2>
205205
<div class="desc"><p>OnScreenAlert(message: str, topic: str, severity: spaceteams.SC_Compute_Server.Severity) -&gt; None</p>
206206
<p>Send alert that is shown on all app screens, is deduplicated by topic name, and is erased after a few seconds.</p></div>
207207
</dd>
208+
<dt id="spaceteams.SC_Compute_Server.CaptureImage"><code class="name flex">
209+
<span>def <span class="ident">CaptureImage</span></span>(<span>...)</span>
210+
</code></dt>
211+
<dd>
212+
<div class="desc"><p>CaptureImage(camera_en: spaceteams.SC_Compute_Server.Entity, properties: spaceteams.SC_Compute_Server.CaptureImageProperties) -&gt; int</p>
213+
<p>Capture an image from the given camera entity with the given properties.
214+
Use OnImageReceived() with the returned capture_id to react to the image.</p></div>
215+
</dd>
216+
<dt id="spaceteams.SC_Compute_Server.OnImageReceived"><code class="name flex">
217+
<span>def <span class="ident">OnImageReceived</span></span>(<span>...)</span>
218+
</code></dt>
219+
<dd>
220+
<div class="desc"><p>OnImageReceived(capture_id: int, reaction: Callable[[spaceteams.SC_Compute_Server.CapturedImage], None]) -&gt; None</p>
221+
<p>React to an image received with the given capture_id. Reaction must be a function that takes a CapturedImage.</p></div>
222+
</dd>
208223
<dt id="spaceteams.SC_Compute_Server.SimGlobals_DeleteEntity"><code class="name flex">
209224
<span>def <span class="ident">SimGlobals_DeleteEntity</span></span>(<span>...)</span>
210225
</code></dt>
@@ -1654,7 +1669,7 @@ <h3>Methods</h3>
16541669
</code></dt>
16551670
<dd>
16561671
<div class="desc"><p>getName(self: spaceteams.SC_Compute_Server.Entity) -&gt; str</p>
1657-
<p>Returns the name of the Entity</p></div>
1672+
<p>returns the name of the Entity</p></div>
16581673
</dd>
16591674
<dt id="spaceteams.SC_Compute_Server.Entity.getId_str"><code class="name flex">
16601675
<span>def <span class="ident">getId_str</span></span>(<span>...)</span>
@@ -1940,6 +1955,74 @@ <h3>Inherited members</h3>
19401955
</li>
19411956
</ul>
19421957
</dd>
1958+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties"><code class="flex name class">
1959+
<span>class <span class="ident">CaptureImageProperties</span></span>
1960+
<span>(</span><span>...)</span>
1961+
</code></dt>
1962+
<dd>
1963+
<div class="desc"><p><strong>init</strong>(self: spaceteams.SC_Compute_Server.CaptureImageProperties) -&gt; None</p></div>
1964+
<h3>Ancestors</h3>
1965+
<ul class="hlist">
1966+
<li>pybind11_builtins.pybind11_object</li>
1967+
</ul>
1968+
<h3>Instance variables</h3>
1969+
<dl>
1970+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties.CaptureID"><code class="name">prop <span class="ident">CaptureID</span></code></dt>
1971+
<dd>
1972+
<div class="desc"></div>
1973+
</dd>
1974+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties.FOV"><code class="name">prop <span class="ident">FOV</span></code></dt>
1975+
<dd>
1976+
<div class="desc"></div>
1977+
</dd>
1978+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties.EV"><code class="name">prop <span class="ident">EV</span></code></dt>
1979+
<dd>
1980+
<div class="desc"></div>
1981+
</dd>
1982+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionX"><code class="name">prop <span class="ident">ResolutionX</span></code></dt>
1983+
<dd>
1984+
<div class="desc"></div>
1985+
</dd>
1986+
<dt id="spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionY"><code class="name">prop <span class="ident">ResolutionY</span></code></dt>
1987+
<dd>
1988+
<div class="desc"></div>
1989+
</dd>
1990+
</dl>
1991+
</dd>
1992+
<dt id="spaceteams.SC_Compute_Server.CapturedImage"><code class="flex name class">
1993+
<span>class <span class="ident">CapturedImage</span></span>
1994+
<span>(</span><span>...)</span>
1995+
</code></dt>
1996+
<dd>
1997+
<div class="desc"><p><strong>init</strong>(self: spaceteams.SC_Compute_Server.CapturedImage) -&gt; None</p></div>
1998+
<h3>Ancestors</h3>
1999+
<ul class="hlist">
2000+
<li>pybind11_builtins.pybind11_object</li>
2001+
</ul>
2002+
<h3>Instance variables</h3>
2003+
<dl>
2004+
<dt id="spaceteams.SC_Compute_Server.CapturedImage.properties"><code class="name">prop <span class="ident">properties</span></code></dt>
2005+
<dd>
2006+
<div class="desc"></div>
2007+
</dd>
2008+
<dt id="spaceteams.SC_Compute_Server.CapturedImage.timestamp"><code class="name">prop <span class="ident">timestamp</span></code></dt>
2009+
<dd>
2010+
<div class="desc"></div>
2011+
</dd>
2012+
<dt id="spaceteams.SC_Compute_Server.CapturedImage.PixelsR"><code class="name">prop <span class="ident">PixelsR</span></code></dt>
2013+
<dd>
2014+
<div class="desc"></div>
2015+
</dd>
2016+
<dt id="spaceteams.SC_Compute_Server.CapturedImage.PixelsG"><code class="name">prop <span class="ident">PixelsG</span></code></dt>
2017+
<dd>
2018+
<div class="desc"></div>
2019+
</dd>
2020+
<dt id="spaceteams.SC_Compute_Server.CapturedImage.PixelsB"><code class="name">prop <span class="ident">PixelsB</span></code></dt>
2021+
<dd>
2022+
<div class="desc"></div>
2023+
</dd>
2024+
</dl>
2025+
</dd>
19432026
</dl>
19442027
</section>
19452028
</article>
@@ -1979,6 +2062,8 @@ <h3>Inherited members</h3>
19792062
<li><code><a title="spaceteams.SC_Compute_Server.GetSimEntity" href="#spaceteams.SC_Compute_Server.GetSimEntity">GetSimEntity</a></code></li>
19802063
<li><code><a title="spaceteams.SC_Compute_Server.OnScreenLogMessage" href="#spaceteams.SC_Compute_Server.OnScreenLogMessage">OnScreenLogMessage</a></code></li>
19812064
<li><code><a title="spaceteams.SC_Compute_Server.OnScreenAlert" href="#spaceteams.SC_Compute_Server.OnScreenAlert">OnScreenAlert</a></code></li>
2065+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImage" href="#spaceteams.SC_Compute_Server.CaptureImage">CaptureImage</a></code></li>
2066+
<li><code><a title="spaceteams.SC_Compute_Server.OnImageReceived" href="#spaceteams.SC_Compute_Server.OnImageReceived">OnImageReceived</a></code></li>
19822067
<li><code><a title="spaceteams.SC_Compute_Server.SimGlobals_DeleteEntity" href="#spaceteams.SC_Compute_Server.SimGlobals_DeleteEntity">SimGlobals_DeleteEntity</a></code></li>
19832068
<li><code><a title="spaceteams.SC_Compute_Server.SimGlobals_AddEntity" href="#spaceteams.SC_Compute_Server.SimGlobals_AddEntity">SimGlobals_AddEntity</a></code></li>
19842069
<li><code><a title="spaceteams.SC_Compute_Server.SimGlobals_GetGlobalFrame" href="#spaceteams.SC_Compute_Server.SimGlobals_GetGlobalFrame">SimGlobals_GetGlobalFrame</a></code></li>
@@ -2295,6 +2380,26 @@ <h4><code><a title="spaceteams.SC_Compute_Server.Entity" href="#spaceteams.SC_Co
22952380
<li><code><a title="spaceteams.SC_Compute_Server.Entity.GetPropagationType" href="#spaceteams.SC_Compute_Server.Entity.GetPropagationType">GetPropagationType</a></code></li>
22962381
</ul>
22972382
</li>
2383+
<li>
2384+
<h4><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties" href="#spaceteams.SC_Compute_Server.CaptureImageProperties">CaptureImageProperties</a></code></h4>
2385+
<ul class="">
2386+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties.CaptureID" href="#spaceteams.SC_Compute_Server.CaptureImageProperties.CaptureID">CaptureID</a></code></li>
2387+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties.FOV" href="#spaceteams.SC_Compute_Server.CaptureImageProperties.FOV">FOV</a></code></li>
2388+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties.EV" href="#spaceteams.SC_Compute_Server.CaptureImageProperties.EV">EV</a></code></li>
2389+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionX" href="#spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionX">ResolutionX</a></code></li>
2390+
<li><code><a title="spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionY" href="#spaceteams.SC_Compute_Server.CaptureImageProperties.ResolutionY">ResolutionY</a></code></li>
2391+
</ul>
2392+
</li>
2393+
<li>
2394+
<h4><code><a title="spaceteams.SC_Compute_Server.CapturedImage" href="#spaceteams.SC_Compute_Server.CapturedImage">CapturedImage</a></code></h4>
2395+
<ul class="">
2396+
<li><code><a title="spaceteams.SC_Compute_Server.CapturedImage.properties" href="#spaceteams.SC_Compute_Server.CapturedImage.properties">properties</a></code></li>
2397+
<li><code><a title="spaceteams.SC_Compute_Server.CapturedImage.timestamp" href="#spaceteams.SC_Compute_Server.CapturedImage.timestamp">timestamp</a></code></li>
2398+
<li><code><a title="spaceteams.SC_Compute_Server.CapturedImage.PixelsR" href="#spaceteams.SC_Compute_Server.CapturedImage.PixelsR">PixelsR</a></code></li>
2399+
<li><code><a title="spaceteams.SC_Compute_Server.CapturedImage.PixelsG" href="#spaceteams.SC_Compute_Server.CapturedImage.PixelsG">PixelsG</a></code></li>
2400+
<li><code><a title="spaceteams.SC_Compute_Server.CapturedImage.PixelsB" href="#spaceteams.SC_Compute_Server.CapturedImage.PixelsB">PixelsB</a></code></li>
2401+
</ul>
2402+
</li>
22982403
</ul>
22992404
</li>
23002405
</ul>

0 commit comments

Comments
 (0)