doc for connections viewer

thegrill · Mar 2, 2024 · 8013e59 · 8013e59
1 parent c509bff
commit 8013e59
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 0 deletions.
diff --git a/docs/source/connections_viewer.rst b/docs/source/connections_viewer.rst
@@ -0,0 +1,22 @@
+Connections Viewer
+------------------
+
+From a given `prim`_, recursively traverse its connections through `UsdShade.ConnectableAPI`_.
+Every node represents a `prim`_, with its name at the top, followed by each of its inputs and outputs.
+Outputs are marked as red. Inputs are blue (light for non connected inputs, dark for ones with incoming connections).
+
+.. tab:: USDView
+
+    .. image:: images/connections_viewer_usdview.gif
+
+.. tab:: Houdini
+
+    .. image:: images/connections_viewer_hou.jpg
+
+.. tab:: Maya
+
+    .. image:: images/connections_viewer_maya.jpg
+
+.. _UsdShade.ConnectableAPI: https://openusd.org/release/api/class_usd_shade_connectable_a_p_i.html
+.. _prim: https://graphics.pixar.com/usd/docs/USD-Glossary.html#USDGlossary-Prim
+
diff --git a/docs/source/images/connections_viewer_hou.jpg b/docs/source/images/connections_viewer_hou.jpg
diff --git a/docs/source/images/connections_viewer_maya.jpg b/docs/source/images/connections_viewer_maya.jpg
diff --git a/docs/source/images/connections_viewer_usdview.gif b/docs/source/images/connections_viewer_usdview.gif
diff --git a/docs/source/views.rst b/docs/source/views.rst
@@ -11,6 +11,8 @@ Views (Inspecting / Authoring)
 
 .. include:: spreadsheet_editor.rst
 
+.. include:: connections_viewer.rst
+
 .. include:: prim_composition.rst
 
 .. include:: layerstack_composition.rst