deploy: 0ba85db

nerfstudio-project · Aug 28, 2024 · db5c08e · db5c08e
1 parent 01b01e5
commit db5c08e
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 19 deletions.
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/events.doctree b/latest/.doctrees/events.doctree
diff --git a/latest/.doctrees/scene_api.doctree b/latest/.doctrees/scene_api.doctree
diff --git a/latest/_modules/viser/_scene_api/index.html b/latest/_modules/viser/_scene_api/index.html
@@ -840,8 +840,8 @@ <h1>Source code for viser._scene_api</h1><div class="highlight"><pre>
 
 <span class="sd">        For cases where we want to visualize many coordinate frames, like</span>
 <span class="sd">        trajectories containing thousands or tens of thousands of frames,</span>
-<span class="sd">        batching and calling `add_batched_axes()` may be a better choice than calling</span>
-<span class="sd">        `add_frame()` in a loop.</span>
+<span class="sd">        batching and calling :meth:`add_batched_axes()` may be a better choice</span>
+<span class="sd">        than calling :meth:`add_frame()` in a loop.</span>
 
 <span class="sd">        Args:</span>
 <span class="sd">            name: A scene tree name. Names in the format of /parent/child can be used to</span>
@@ -886,10 +886,11 @@ <h1>Source code for viser._scene_api</h1><div class="highlight"><pre>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BatchedAxesHandle</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Visualize batched sets of coordinate frame axes.</span>
 
-<span class="sd">        The functionality of `add_batched_axes()` overlaps significantly with</span>
-<span class="sd">        `add_frame()` when `show_axes=True`. The primary difference is that</span>
-<span class="sd">        `add_batched_axes()` supports multiple axes via the `wxyzs_batched`</span>
-<span class="sd">        (shape Nx4) and `positions_batched` (shape Nx3) arguments.</span>
+<span class="sd">        The functionality of :meth:`add_batched_axes()` overlaps significantly</span>
+<span class="sd">        with :meth:`add_frame()` when `show_axes=True`. The primary difference</span>
+<span class="sd">        is that :meth:`add_batched_axes()` supports multiple axes via the</span>
+<span class="sd">        `wxyzs_batched` (shape Nx4) and `positions_batched` (shape Nx3)</span>
+<span class="sd">        arguments.</span>
 
 <span class="sd">        Axes that are batched and rendered via a single call to</span>
 <span class="sd">        `add_batched_axes()` are instanced on the client; this will be much</span>
@@ -1722,6 +1723,8 @@ <h1>Source code for viser._scene_api</h1><div class="highlight"><pre>
                 <span class="n">target</span><span class="o">=</span><span class="n">handle</span><span class="p">,</span>
                 <span class="n">ray_origin</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">ray_origin</span><span class="p">,</span>
                 <span class="n">ray_direction</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">ray_direction</span><span class="p">,</span>
+                <span class="n">screen_pos</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">screen_pos</span><span class="p">,</span>
+                <span class="n">instance_index</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">instance_index</span><span class="p">,</span>
             <span class="p">)</span>
             <span class="n">cb</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 

diff --git a/latest/_modules/viser/_scene_handles/index.html b/latest/_modules/viser/_scene_handles/index.html
@@ -369,7 +369,7 @@ <h1>Source code for viser._scene_handles</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Origin of 3D ray corresponding to this click, in world coordinates.&quot;&quot;&quot;</span>
     <span class="n">ray_direction</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Direction of 3D ray corresponding to this click, in world coordinates.&quot;&quot;&quot;</span>
-    <span class="n">screen_pos</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]]</span>
+    <span class="n">screen_pos</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Screen position of the click on the screen (OpenCV image coordinates, 0 to 1).</span>
 <span class="sd">    (0, 0) is the upper-left corner, (1, 1) is the bottom-right corner.</span>
 <span class="sd">    For a box selection, this includes the min- and max- corners of the box.&quot;&quot;&quot;</span>
@@ -506,7 +506,12 @@ <h1>Source code for viser._scene_handles</h1><div class="highlight"><pre>
     <span class="n">ray_origin</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Origin of 3D ray corresponding to this click, in world coordinates.&quot;&quot;&quot;</span>
     <span class="n">ray_direction</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Direction of 3D ray corresponding to this click, in world coordinates.&quot;&quot;&quot;</span></div>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Direction of 3D ray corresponding to this click, in world coordinates.&quot;&quot;&quot;</span>
+    <span class="n">screen_pos</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Screen position of the click on the screen (OpenCV image coordinates, 0 to 1).</span>
+<span class="sd">    (0, 0) is the upper-left corner, (1, 1) is the bottom-right corner.&quot;&quot;&quot;</span>
+    <span class="n">instance_index</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Instance ID of the clicked object, if applicable. Currently this is `None` for all objects except for the output of :meth:`SceneApi.add_batched_axes()`.&quot;&quot;&quot;</span></div>
 
 
 

diff --git a/latest/events/index.html b/latest/events/index.html
@@ -376,7 +376,7 @@ <h1>Events<a class="headerlink" href="#events" title="Link to this heading">#</a
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="viser.ScenePointerEvent.screen_pos">
-<span class="sig-name descname"><span class="pre">screen_pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#viser.ScenePointerEvent.screen_pos" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">screen_pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#viser.ScenePointerEvent.screen_pos" title="Link to this definition">#</a></dt>
 <dd><p>Screen position of the click on the screen (OpenCV image coordinates, 0 to 1).
 (0, 0) is the upper-left corner, (1, 1) is the bottom-right corner.
 For a box selection, this includes the min- and max- corners of the box.</p>
@@ -430,6 +430,19 @@ <h1>Events<a class="headerlink" href="#events" title="Link to this heading">#</a
 <dd><p>Direction of 3D ray corresponding to this click, in world coordinates.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="viser.SceneNodePointerEvent.screen_pos">
+<span class="sig-name descname"><span class="pre">screen_pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#viser.SceneNodePointerEvent.screen_pos" title="Link to this definition">#</a></dt>
+<dd><p>Screen position of the click on the screen (OpenCV image coordinates, 0 to 1).
+(0, 0) is the upper-left corner, (1, 1) is the bottom-right corner.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="viser.SceneNodePointerEvent.instance_index">
+<span class="sig-name descname"><span class="pre">instance_index</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><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></em><a class="headerlink" href="#viser.SceneNodePointerEvent.instance_index" title="Link to this definition">#</a></dt>
+<dd><p>Instance ID of the clicked object, if applicable. Currently this is <code class="docutils literal notranslate"><span class="pre">None</span></code> for all objects except for the output of <a class="reference internal" href="../scene_api/#viser.SceneApi.add_batched_axes" title="viser.SceneApi.add_batched_axes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">SceneApi.add_batched_axes()</span></code></a>.</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">
@@ -539,6 +552,8 @@ <h1>Events<a class="headerlink" href="#events" title="Link to this heading">#</a
 <li><a class="reference internal" href="#viser.SceneNodePointerEvent.target"><code class="docutils literal notranslate"><span class="pre">SceneNodePointerEvent.target</span></code></a></li>
 <li><a class="reference internal" href="#viser.SceneNodePointerEvent.ray_origin"><code class="docutils literal notranslate"><span class="pre">SceneNodePointerEvent.ray_origin</span></code></a></li>
 <li><a class="reference internal" href="#viser.SceneNodePointerEvent.ray_direction"><code class="docutils literal notranslate"><span class="pre">SceneNodePointerEvent.ray_direction</span></code></a></li>
+<li><a class="reference internal" href="#viser.SceneNodePointerEvent.screen_pos"><code class="docutils literal notranslate"><span class="pre">SceneNodePointerEvent.screen_pos</span></code></a></li>
+<li><a class="reference internal" href="#viser.SceneNodePointerEvent.instance_index"><code class="docutils literal notranslate"><span class="pre">SceneNodePointerEvent.instance_index</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#viser.GuiEvent"><code class="docutils literal notranslate"><span class="pre">GuiEvent</span></code></a><ul>

diff --git a/latest/genindex/index.html b/latest/genindex/index.html
@@ -5796,10 +5796,10 @@ <h2>I</h2>
 </li>
         <li><a href="../icons/#viser.Icon.INFO_OCTAGON_FILLED">INFO_OCTAGON_FILLED (viser.Icon attribute)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="../icons/#viser.Icon.INFO_SMALL">INFO_SMALL (viser.Icon attribute)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="../icons/#viser.Icon.INFO_SQUARE">INFO_SQUARE (viser.Icon attribute)</a>
 </li>
         <li><a href="../icons/#viser.Icon.INFO_SQUARE_FILLED">INFO_SQUARE_FILLED (viser.Icon attribute)</a>
@@ -5845,6 +5845,8 @@ <h2>I</h2>
         <li><a href="../icons/#viser.Icon.INNER_SHADOW_TOP_RIGHT_FILLED">INNER_SHADOW_TOP_RIGHT_FILLED (viser.Icon attribute)</a>
 </li>
         <li><a href="../icons/#viser.Icon.INPUT_SEARCH">INPUT_SEARCH (viser.Icon attribute)</a>
+</li>
+        <li><a href="../events/#viser.SceneNodePointerEvent.instance_index">instance_index (viser.SceneNodePointerEvent attribute)</a>
 </li>
         <li><a href="../transforms/#viser.transforms.MatrixLieGroup.inverse">inverse() (viser.transforms.MatrixLieGroup method)</a>
 
@@ -8215,8 +8217,12 @@ <h2>S</h2>
 </li>
         <li><a href="../icons/#viser.Icon.SCOREBOARD">SCOREBOARD (viser.Icon attribute)</a>
 </li>
-        <li><a href="../events/#viser.ScenePointerEvent.screen_pos">screen_pos (viser.ScenePointerEvent attribute)</a>
+        <li><a href="../events/#viser.SceneNodePointerEvent.screen_pos">screen_pos (viser.SceneNodePointerEvent attribute)</a>
+
+        <ul>
+          <li><a href="../events/#viser.ScenePointerEvent.screen_pos">(viser.ScenePointerEvent attribute)</a>
 </li>
+        </ul></li>
         <li><a href="../icons/#viser.Icon.SCREEN_SHARE">SCREEN_SHARE (viser.Icon attribute)</a>
 </li>
         <li><a href="../icons/#viser.Icon.SCREEN_SHARE_OFF">SCREEN_SHARE_OFF (viser.Icon attribute)</a>

diff --git a/latest/objects.inv b/latest/objects.inv