Auto-updated documentation based on tag v2.1.0

shotgunsoftware · Nov 15, 2024 · 6a82bc9 · 6a82bc9
1 parent 159f808
commit 6a82bc9
Show file tree

Hide file tree

Showing 80 changed files with 41,449 additions and 10 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0d351e8de45ab7fb14c715e2dfdfe08d
+config: f986c9b3c5b7fcba3a4fa9e3d3cefc37
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/alias_python_api.doctree b/.doctrees/alias_python_api.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_static/alias_api/2025.1/.buildinfo b/_static/alias_api/2025.1/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: bfa0799697f886ff36fae673a550e249
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_static/alias_api/2025.1/.doctrees/_autosummary/alias_api.TraverseDagInputData.doctree b/_static/alias_api/2025.1/.doctrees/_autosummary/alias_api.TraverseDagInputData.doctree
diff --git a/_static/alias_api/2025.1/.doctrees/_autosummary/alias_api.doctree b/_static/alias_api/2025.1/.doctrees/_autosummary/alias_api.doctree
diff --git a/...lias_api/2025.1/.doctrees/_autosummary/alias_api.search_node_has_non_origin_pivot.doctree b/...lias_api/2025.1/.doctrees/_autosummary/alias_api.search_node_has_non_origin_pivot.doctree
diff --git a/....1/.doctrees/_autosummary/alias_api.search_node_layer_does_not_match_parent_layer.doctree b/....1/.doctrees/_autosummary/alias_api.search_node_layer_does_not_match_parent_layer.doctree
diff --git a/..._api/2025.1/.doctrees/_autosummary/alias_api.search_node_unused_curves_on_surface.doctree b/..._api/2025.1/.doctrees/_autosummary/alias_api.search_node_unused_curves_on_surface.doctree
diff --git a/_static/alias_api/2025.1/.doctrees/changes.doctree b/_static/alias_api/2025.1/.doctrees/changes.doctree
diff --git a/_static/alias_api/2025.1/.doctrees/environment.pickle b/_static/alias_api/2025.1/.doctrees/environment.pickle
diff --git a/_static/alias_api/2025.1/.doctrees/index.doctree b/_static/alias_api/2025.1/.doctrees/index.doctree
diff --git a/_static/alias_api/2025.1/.doctrees/module_summary.doctree b/_static/alias_api/2025.1/.doctrees/module_summary.doctree
diff --git a/_static/alias_api/2025.1/.doctrees/reference.doctree b/_static/alias_api/2025.1/.doctrees/reference.doctree
diff --git a/_static/alias_api/2025.1/_autosummary/alias_api.TraverseDagInputData.html b/_static/alias_api/2025.1/_autosummary/alias_api.TraverseDagInputData.html
@@ -0,0 +1,182 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>alias_api.TraverseDagInputData &mdash; Alias Python API  documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="../index.html" class="icon icon-home"> Alias Python API
+          </a>
+              <div class="version">
+                5.0.0
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../module_summary.html">Module Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../changes.html">What’s Changed</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">Alias Python API</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
+      <li>alias_api.TraverseDagInputData</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/_autosummary/alias_api.TraverseDagInputData.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="alias-api-traversedaginputdata">
+<h1>alias_api.TraverseDagInputData<a class="headerlink" href="#alias-api-traversedaginputdata" title="Permalink to this headline"></a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="alias_api.TraverseDagInputData">
+<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">alias_api.</span></span><span class="sig-name descname"><span class="pre">TraverseDagInputData</span></span><a class="headerlink" href="#alias_api.TraverseDagInputData" title="Permalink to this definition"></a></dt>
+<dd><p>Input data for traversing the dag.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="alias_api.TraverseDagInputData.__init__">
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#alias_api.TraverseDagInputData.__init__" title="Permalink to this definition"></a></dt>
+<dd><p>Overloaded function.</p>
+<ol class="arabic simple">
+<li><p>__init__(self: alias_api.TraverseDagInputData, node_names: Set[str] = set(), node_names_inclusive: bool = True, node_types: Set[alias_api.AlObjectType] = set(), node_types_inclusive: bool = True, layers: List[alias_api.AlLayer] = [], layers_inclusive: bool = True, shaders: List[alias_api.AlShader] = [], shaders_inclusive: bool = True) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with the given filters.</p>
+<ol class="arabic simple" start="2">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: Set[alias_api.AlObjectType], arg1: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with a node types filter.</p>
+<ol class="arabic simple" start="3">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: alias_api.AlLayer, arg1: bool, arg2: Set[alias_api.AlObjectType], arg3: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with layer and node types filters.</p>
+<ol class="arabic simple" start="4">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: alias_api.AlShader, arg1: bool, arg2: Set[alias_api.AlObjectType], arg3: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with shader and node types filters.</p>
+<ol class="arabic simple" start="5">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: alias_api.AlLayer, arg1: alias_api.AlShader, arg2: bool, arg3: bool, arg4: Set[alias_api.AlObjectType], arg5: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with layer, shader and node types filters.</p>
+<ol class="arabic simple" start="6">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: List[alias_api.AlLayer], arg1: bool, arg2: Set[alias_api.AlObjectType], arg3: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with layers and node types filters.</p>
+<ol class="arabic simple" start="7">
+<li><p>__init__(self: alias_api.TraverseDagInputData, arg0: List[alias_api.AlShader], arg1: bool, arg2: Set[alias_api.AlObjectType], arg3: bool) -&gt; None</p></li>
+</ol>
+<p>Createa new TraverseDagInputData object with shaders and node types filters.</p>
+</dd></dl>
+
+<p class="rubric">Methods</p>
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="#alias_api.TraverseDagInputData.__init__" title="alias_api.TraverseDagInputData.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(*args, **kwargs)</p></td>
+<td><p>Overloaded function.</p></td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Attributes</p>
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.layers" title="alias_api.TraverseDagInputData.layers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">layers</span></code></a></p></td>
+<td><p>Get or set the list of layers to filter the search results.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.layersInclusive" title="alias_api.TraverseDagInputData.layersInclusive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">layersInclusive</span></code></a></p></td>
+<td><p>Get or set the flag to indicate if the <cite>layers</cite> filter is inclusive.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.nodeTypesInclusive" title="alias_api.TraverseDagInputData.nodeTypesInclusive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nodeTypesInclusive</span></code></a></p></td>
+<td><p>Get or set the flag to indicate if the <cite>nodeTypes</cite> filter is inclusive.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.node_types" title="alias_api.TraverseDagInputData.node_types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">node_types</span></code></a></p></td>
+<td><p>Get or set the list of node types to filter the search results.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.shaders" title="alias_api.TraverseDagInputData.shaders"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shaders</span></code></a></p></td>
+<td><p>Get or set the list of shaders to filter the search results.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../reference.html#alias_api.TraverseDagInputData.shadersInclusive" title="alias_api.TraverseDagInputData.shadersInclusive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shadersInclusive</span></code></a></p></td>
+<td><p>Get or set the flag to indicate if the <cite>shaders</cite> filter is inclusive.</p></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2021, Autodesk, Inc.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>