deploy: 382ce3c

nerfstudio-project · Feb 3, 2025 · 9a94ad6 · 9a94ad6
1 parent f323547
commit 9a94ad6
Show file tree

Hide file tree

Showing 11 changed files with 134 additions and 6 deletions.
diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle
diff --git a/main/.doctrees/gui_api.doctree b/main/.doctrees/gui_api.doctree
diff --git a/main/.doctrees/gui_handles.doctree b/main/.doctrees/gui_handles.doctree
diff --git a/main/_modules/viser/_gui_api/index.html b/main/_modules/viser/_gui_api/index.html
@@ -428,6 +428,7 @@ <h1>Source code for viser._gui_api</h1><div class="highlight"><pre>
     <span class="n">GuiDropdownHandle</span><span class="p">,</span>
     <span class="n">GuiEvent</span><span class="p">,</span>
     <span class="n">GuiFolderHandle</span><span class="p">,</span>
+    <span class="n">GuiHtmlHandle</span><span class="p">,</span>
     <span class="n">GuiImageHandle</span><span class="p">,</span>
     <span class="n">GuiMarkdownHandle</span><span class="p">,</span>
     <span class="n">GuiModalHandle</span><span class="p">,</span>
@@ -1041,6 +1042,47 @@ <h1>Source code for viser._gui_api</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="n">handle</span></div>
 
 
+<div class="viewcode-block" id="GuiApi.add_html">
+<a class="viewcode-back" href="../../../gui_api/#viser.GuiApi.add_html">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_html</span><span class="p">(</span>
+        <span class="bp">self</span><span class="p">,</span>
+        <span class="n">content</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+        <span class="n">order</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="n">visible</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">GuiHtmlHandle</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Add HTML to the GUI.</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            content: HTML content to display.</span>
+<span class="sd">            order: Optional ordering, smallest values will be displayed first.</span>
+<span class="sd">            visible: Whether the component is visible.</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            A handle that can be used to interact with the GUI element.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">message</span> <span class="o">=</span> <span class="n">_messages</span><span class="o">.</span><span class="n">GuiHtmlMessage</span><span class="p">(</span>
+            <span class="n">uuid</span><span class="o">=</span><span class="n">_make_uuid</span><span class="p">(),</span>
+            <span class="n">container_uuid</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_container_uuid</span><span class="p">(),</span>
+            <span class="n">props</span><span class="o">=</span><span class="n">_messages</span><span class="o">.</span><span class="n">GuiHtmlProps</span><span class="p">(</span>
+                <span class="n">order</span><span class="o">=</span><span class="n">_apply_default_order</span><span class="p">(</span><span class="n">order</span><span class="p">),</span>
+                <span class="n">content</span><span class="o">=</span><span class="n">content</span><span class="p">,</span>
+                <span class="n">visible</span><span class="o">=</span><span class="n">visible</span><span class="p">,</span>
+            <span class="p">),</span>
+        <span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_websock_interface</span><span class="o">.</span><span class="n">queue_message</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
+
+        <span class="n">handle</span> <span class="o">=</span> <span class="n">GuiHtmlHandle</span><span class="p">(</span>
+            <span class="n">_GuiHandleState</span><span class="p">(</span>
+                <span class="n">message</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span>
+                <span class="bp">self</span><span class="p">,</span>
+                <span class="kc">None</span><span class="p">,</span>
+                <span class="n">props</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">props</span><span class="p">,</span>
+                <span class="n">parent_container_id</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">container_uuid</span><span class="p">,</span>
+            <span class="p">),</span>
+        <span class="p">)</span>
+        <span class="k">return</span> <span class="n">handle</span></div>
+
+
 <div class="viewcode-block" id="GuiApi.add_image">
 <a class="viewcode-back" href="../../../gui_api/#viser.GuiApi.add_image">[docs]</a>
     <span class="k">def</span><span class="w"> </span><span class="nf">add_image</span><span class="p">(</span>

diff --git a/main/_modules/viser/_gui_handles/index.html b/main/_modules/viser/_gui_handles/index.html
@@ -425,6 +425,7 @@ <h1>Source code for viser._gui_handles</h1><div class="highlight"><pre>
     <span class="n">GuiCloseModalMessage</span><span class="p">,</span>
     <span class="n">GuiDropdownProps</span><span class="p">,</span>
     <span class="n">GuiFolderProps</span><span class="p">,</span>
+    <span class="n">GuiHtmlProps</span><span class="p">,</span>
     <span class="n">GuiImageProps</span><span class="p">,</span>
     <span class="n">GuiMarkdownProps</span><span class="p">,</span>
     <span class="n">GuiMultiSliderProps</span><span class="p">,</span>
@@ -1271,6 +1272,13 @@ <h1>Source code for viser._gui_handles</h1><div class="highlight"><pre>
 
 
 
+<div class="viewcode-block" id="GuiHtmlHandle">
+<a class="viewcode-back" href="../../../gui_handles/#viser.GuiHtmlHandle">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">GuiHtmlHandle</span><span class="p">(</span><span class="n">_GuiHandle</span><span class="p">[</span><span class="kc">None</span><span class="p">],</span> <span class="n">GuiHtmlProps</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Handling for updating and removing HTML elements.&quot;&quot;&quot;</span></div>
+
+
+
 <div class="viewcode-block" id="GuiPlotlyHandle">
 <a class="viewcode-back" href="../../../gui_handles/#viser.GuiPlotlyHandle">[docs]</a>
 <span class="k">class</span><span class="w"> </span><span class="nc">GuiPlotlyHandle</span><span class="p">(</span><span class="n">_GuiHandle</span><span class="p">[</span><span class="kc">None</span><span class="p">],</span> <span class="n">GuiPlotlyProps</span><span class="p">):</span>

diff --git a/main/_sources/gui_handles.md.txt b/main/_sources/gui_handles.md.txt
@@ -14,6 +14,8 @@
 
 .. autoclass:: viser.GuiMarkdownHandle()
 
+.. autoclass:: viser.GuiHtmlHandle()
+
 .. autoclass:: viser.GuiPlotlyHandle()
 
 .. autoclass:: viser.GuiTabGroupHandle()

diff --git a/main/genindex/index.html b/main/genindex/index.html
@@ -497,6 +497,8 @@ <h2>A</h2>
         <li><a href="../scene_api/#viser.SceneApi.add_glb">add_glb() (viser.SceneApi method)</a>
 </li>
         <li><a href="../scene_api/#viser.SceneApi.add_grid">add_grid() (viser.SceneApi method)</a>
+</li>
+        <li><a href="../gui_api/#viser.GuiApi.add_html">add_html() (viser.GuiApi method)</a>
 </li>
         <li><a href="../scene_api/#viser.SceneApi.add_icosphere">add_icosphere() (viser.SceneApi method)</a>
 </li>
@@ -885,11 +887,11 @@ <h2>A</h2>
         <li><a href="../icons/#viser.Icon.ARROW_AUTOFIT_RIGHT">ARROW_AUTOFIT_RIGHT (viser.Icon attribute)</a>
 </li>
         <li><a href="../icons/#viser.Icon.ARROW_AUTOFIT_UP">ARROW_AUTOFIT_UP (viser.Icon attribute)</a>
-</li>
-        <li><a href="../icons/#viser.Icon.ARROW_AUTOFIT_WIDTH">ARROW_AUTOFIT_WIDTH (viser.Icon attribute)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="../icons/#viser.Icon.ARROW_AUTOFIT_WIDTH">ARROW_AUTOFIT_WIDTH (viser.Icon attribute)</a>
+</li>
         <li><a href="../icons/#viser.Icon.ARROW_BACK">ARROW_BACK (viser.Icon attribute)</a>
 </li>
         <li><a href="../icons/#viser.Icon.ARROW_BACK_UP">ARROW_BACK_UP (viser.Icon attribute)</a>
@@ -3658,9 +3660,11 @@ <h2>C</h2>
 </li>
         <li><a href="../scene_handles/#viser.Gui3dContainerHandle.container_uuid">container_uuid (viser.Gui3dContainerHandle attribute)</a>
 </li>
-        <li><a href="../gui_handles/#viser.GuiMarkdownHandle.content">content (viser.GuiMarkdownHandle property)</a>
+        <li><a href="../gui_handles/#viser.GuiHtmlHandle.content">content (viser.GuiHtmlHandle attribute)</a>
 
         <ul>
+          <li><a href="../gui_handles/#viser.GuiMarkdownHandle.content">(viser.GuiMarkdownHandle property)</a>
+</li>
           <li><a href="../gui_handles/#viser.UploadedFile.content">(viser.UploadedFile attribute)</a>
 </li>
         </ul></li>
@@ -5545,6 +5549,8 @@ <h2>G</h2>
         <li><a href="../events/#viser.GuiEvent">GuiEvent (class in viser)</a>
 </li>
         <li><a href="../gui_handles/#viser.GuiFolderHandle">GuiFolderHandle (class in viser)</a>
+</li>
+        <li><a href="../gui_handles/#viser.GuiHtmlHandle">GuiHtmlHandle (class in viser)</a>
 </li>
         <li><a href="../gui_handles/#viser.GuiInputHandle">GuiInputHandle (class in viser)</a>
 </li>
@@ -7657,6 +7663,8 @@ <h2>O</h2>
           <li><a href="../gui_handles/#viser.GuiDropdownHandle.order">(viser.GuiDropdownHandle attribute)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiFolderHandle.order">(viser.GuiFolderHandle attribute)</a>
+</li>
+          <li><a href="../gui_handles/#viser.GuiHtmlHandle.order">(viser.GuiHtmlHandle attribute)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiInputHandle.order">(viser.GuiInputHandle attribute)</a>
 </li>
@@ -8485,6 +8493,8 @@ <h2>R</h2>
           <li><a href="../gui_handles/#viser.GuiDropdownHandle.remove">(viser.GuiDropdownHandle method)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiFolderHandle.remove">(viser.GuiFolderHandle method)</a>
+</li>
+          <li><a href="../gui_handles/#viser.GuiHtmlHandle.remove">(viser.GuiHtmlHandle method)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiInputHandle.remove">(viser.GuiInputHandle method)</a>
 </li>
@@ -10521,10 +10531,10 @@ <h2>V</h2>
 </li>
         <li><a href="../icons/#viser.Icon.VIRUS_OFF">VIRUS_OFF (viser.Icon attribute)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="../icons/#viser.Icon.VIRUS_SEARCH">VIRUS_SEARCH (viser.Icon attribute)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li>
     viser.infra
 
@@ -10569,6 +10579,8 @@ <h2>V</h2>
           <li><a href="../gui_handles/#viser.GuiDropdownHandle.visible">(viser.GuiDropdownHandle attribute)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiFolderHandle.visible">(viser.GuiFolderHandle attribute)</a>
+</li>
+          <li><a href="../gui_handles/#viser.GuiHtmlHandle.visible">(viser.GuiHtmlHandle attribute)</a>
 </li>
           <li><a href="../gui_handles/#viser.GuiInputHandle.visible">(viser.GuiInputHandle attribute)</a>
 </li>

diff --git a/main/gui_api/index.html b/main/gui_api/index.html
@@ -534,6 +534,27 @@ <h1>GUI API<a class="headerlink" href="#gui-api" title="Link to this heading">¶
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="viser.GuiApi.add_html">
+<span class="sig-name descname"><span class="pre">add_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="../gui_handles/#viser.GuiHtmlHandle" title="viser._gui_handles.GuiHtmlHandle"><span class="pre">GuiHtmlHandle</span></a></span></span><a class="reference internal" href="../_modules/viser/_gui_api/#GuiApi.add_html"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viser.GuiApi.add_html" title="Link to this definition">¶</a></dt>
+<dd><p>Add HTML to the GUI.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>content</strong> (<em>str</em>) – HTML content to display.</p></li>
+<li><p><strong>order</strong> (<em>float</em><em> | </em><em>None</em>) – Optional ordering, smallest values will be displayed first.</p></li>
+<li><p><strong>visible</strong> (<em>bool</em>) – Whether the component is visible.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A handle that can be used to interact with the GUI element.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="../gui_handles/#viser.GuiHtmlHandle" title="viser._gui_handles.GuiHtmlHandle"><em>GuiHtmlHandle</em></a></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="viser.GuiApi.add_image">
 <span class="sig-name descname"><span class="pre">add_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">‘png’</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">‘jpeg’</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'jpeg'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">GuiImageHandle</span></span></span><a class="reference internal" href="../_modules/viser/_gui_api/#GuiApi.add_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viser.GuiApi.add_image" title="Link to this definition">¶</a></dt>
@@ -1031,6 +1052,7 @@ <h1>GUI API<a class="headerlink" href="#gui-api" title="Link to this heading">¶
 <li><a class="reference internal" href="#viser.GuiApi.add_modal"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_modal()</span></code></a></li>
 <li><a class="reference internal" href="#viser.GuiApi.add_tab_group"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_tab_group()</span></code></a></li>
 <li><a class="reference internal" href="#viser.GuiApi.add_markdown"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_markdown()</span></code></a></li>
+<li><a class="reference internal" href="#viser.GuiApi.add_html"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_html()</span></code></a></li>
 <li><a class="reference internal" href="#viser.GuiApi.add_image"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_image()</span></code></a></li>
 <li><a class="reference internal" href="#viser.GuiApi.add_plotly"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_plotly()</span></code></a></li>
 <li><a class="reference internal" href="#viser.GuiApi.add_button"><code class="docutils literal notranslate"><span class="pre">GuiApi.add_button()</span></code></a></li>