1146 lines
117 KiB
HTML
1146 lines
117 KiB
HTML
<!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>DNAViewer.builder package — DNA Calibration documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/graphviz.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" />
|
|
<link rel="next" title="DNAViewer.builder.maya package" href="dna_viewer.builder.maya.html" />
|
|
<link rel="prev" title="DNAViewer package" href="dna_viewer.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"> DNA Calibration
|
|
</a>
|
|
<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">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html">MetaHuman DNA Calibration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html#overview">Overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html#examples">Examples</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html#notes">Notes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html#license">License</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index_.html#indices-and-tables">Indices and tables</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Repository Organization</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="repository_organization_md.html">Repository Organization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="repository_organization_md.html#folder-structure">Folder structure</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">DNACalib</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="dnacalib_md.html">DNACalib</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dnacalib_api_md.html">API overview</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">DNAViewer</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_md.html">DNAViewer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_maya_md.html">Usage in Maya</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">DNAViewer API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_md.html">Environment Setup</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_md.html#dna">DNA</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_build_meshes_md.html">Mesh Utilities</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_build_rig_md.html">Build rig (<code class="docutils literal notranslate"><span class="pre">build_rig</span></code>)</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Technical documentation</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna.html">DNA</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dnacalib.html">DNACalib</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_modules.html">DNAViewer</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">FAQ</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="faq_md.html">Frequently Asked Questions (FAQ)</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">DNA Calibration</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> »</li>
|
|
<li><a href="dna_viewer_modules.html">DNAViewer</a> »</li>
|
|
<li><a href="dna_viewer.html">DNAViewer package</a> »</li>
|
|
<li>DNAViewer.builder package</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/dna_viewer.builder.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="dnaviewer-builder-package">
|
|
<h1>DNAViewer.builder package<a class="headerlink" href="#dnaviewer-builder-package" title="Permalink to this headline"></a></h1>
|
|
<section id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
|
</section>
|
|
<section id="module-dna_viewer.builder.builder">
|
|
<span id="dna-viewer-builder-builder-module"></span><h2>dna_viewer.builder.builder module<a class="headerlink" href="#module-dna_viewer.builder.builder" title="Permalink to this headline"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.BuildResult">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.builder.</span></span><span class="sig-name descname"><span class="pre">BuildResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meshes_per_lod:</span> <span class="pre">typing.Dict[int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typing.List[str]]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#BuildResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.BuildResult" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>A class used for returning data after finishing the build process</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">meshes_per_lod</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>Dict[int, List[str]]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">meshes_per_lod</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The list of mesh names created group by LOD number</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.BuildResult.get_all_meshes">
|
|
<span class="sig-name descname"><span class="pre">get_all_meshes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#BuildResult.get_all_meshes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.BuildResult.get_all_meshes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Flatten meshes to single list.</p>
|
|
<p>@rtype: List[str]
|
|
@returns: The list of all mesh names.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.BuildResult.meshes_per_lod">
|
|
<span class="sig-name descname"><span class="pre">meshes_per_lod</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><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">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#dna_viewer.builder.builder.BuildResult.meshes_per_lod" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.builder.</span></span><span class="sig-name descname"><span class="pre">Builder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dna</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA" title="dna_viewer.dnalib.dnalib.DNA"><span class="pre">dna_viewer.dnalib.dnalib.DNA</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#dna_viewer.builder.config.Config" title="dna_viewer.builder.config.Config"><span class="pre">dna_viewer.builder.config.Config</span></a><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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>A builder class used for building the character</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">config</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p><a class="reference internal" href="#dna_viewer.builder.config.Config" title="dna_viewer.builder.config.Config">Config</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">config</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The configuration options used for building the character</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">dna</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p><a class="reference internal" href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA" title="dna_viewer.dnalib.dnalib.DNA">DNA</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">dna</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The DNA object read from the DNA file</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">meshes</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>Dict[int, List[str]]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">meshes</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>A list of meshes created grouped by lod</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_animated_map_attributes_on_root_joint">
|
|
<span class="sig-name descname"><span class="pre">add_animated_map_attributes_on_root_joint</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_animated_map_attributes_on_root_joint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_animated_map_attributes_on_root_joint" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds and sets the animated map attributes on root joint.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_attribute">
|
|
<span class="sig-name descname"><span class="pre">add_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">control_name</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">long_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_attribute" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds attributes wrapper for internal usage.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_ctrl_attributes_on_root_joint">
|
|
<span class="sig-name descname"><span class="pre">add_ctrl_attributes_on_root_joint</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_ctrl_attributes_on_root_joint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_ctrl_attributes_on_root_joint" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds and sets the raw gui control attributes on root joint.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_joints">
|
|
<span class="sig-name descname"><span class="pre">add_joints</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_joints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_joints" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Starts adding the joints the character, if the character configuration options have add_joints set to False,
|
|
this step will be skipped.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_key_frames">
|
|
<span class="sig-name descname"><span class="pre">add_key_frames</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_key_frames"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_key_frames" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds a starting key frame to the facial root joint if joints are added and the add_key_frames option is set
|
|
to True.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.add_mesh_to_display_layer">
|
|
<span class="sig-name descname"><span class="pre">add_mesh_to_display_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh_name</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">lod</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.add_mesh_to_display_layer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.add_mesh_to_display_layer" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Add the mesh with the given name to an already created display layer.</p>
|
|
<p>@type mesh_name: str
|
|
@param mesh_name: The name of the mesh that should be added to a display layer.</p>
|
|
<p>@type lod: int
|
|
@param lod: The lod value, this is needed for determining the name of the display layer that the mesh should be added to.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.attach_mesh_to_lod">
|
|
<span class="sig-name descname"><span class="pre">attach_mesh_to_lod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh_name</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">lod</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.attach_mesh_to_lod"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.attach_mesh_to_lod" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Attaches the mesh called mesh_name to a given lod.</p>
|
|
<p>@type mesh_name: str
|
|
@param mesh_name: The mesh that needs to be attached to a lod holder object.</p>
|
|
<p>@type lod: str
|
|
@param lod: The name of the mesh that should be added to a display layer.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.build">
|
|
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#dna_viewer.builder.builder.BuildResult" title="dna_viewer.builder.builder.BuildResult"><span class="pre">dna_viewer.builder.builder.BuildResult</span></a></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.build" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Builds the character</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.build_meshes">
|
|
<span class="sig-name descname"><span class="pre">build_meshes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.build_meshes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.build_meshes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Builds the meshes. If specified in the config they get parented to a created
|
|
character node transform, otherwise the meshes get put to the root level of the scene.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.build_meshes_by_lod">
|
|
<span class="sig-name descname"><span class="pre">build_meshes_by_lod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lod</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meshes_per_lod</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.build_meshes_by_lod"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.build_meshes_by_lod" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Builds the meshes from the provided mesh ids and then attaches them to a given lod if specified in the
|
|
character configuration.</p>
|
|
<p>@type lod: int
|
|
@param lod: The lod number representing the display layer the meshes to the display layer.</p>
|
|
<p>@type meshes_per_lod: List[int]
|
|
@param meshes_per_lod: List of mesh indices that are being built.</p>
|
|
<p>@rtype: List[MObject]
|
|
@returns: The list of maya objects that represent the meshes added to the scene.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.create_groups">
|
|
<span class="sig-name descname"><span class="pre">create_groups</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.create_groups"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.create_groups" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Creates a Maya transform which will hold the character, if the character configuration options have
|
|
create_character_node set to False, this step will be skipped.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.default_lambert_shader">
|
|
<span class="sig-name descname"><span class="pre">default_lambert_shader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.default_lambert_shader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.default_lambert_shader" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_angle_unit">
|
|
<span class="sig-name descname"><span class="pre">get_angle_unit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#dna_viewer.builder.config.AngleUnit" title="dna_viewer.builder.config.AngleUnit"><span class="pre">dna_viewer.builder.config.AngleUnit</span></a></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_angle_unit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_angle_unit" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_angle_unit_from_int">
|
|
<span class="sig-name descname"><span class="pre">get_angle_unit_from_int</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#dna_viewer.builder.config.AngleUnit" title="dna_viewer.builder.config.AngleUnit"><span class="pre">dna_viewer.builder.config.AngleUnit</span></a></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_angle_unit_from_int"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_angle_unit_from_int" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Returns an enum from an int value.
|
|
0 -> degree
|
|
1 -> radian</p>
|
|
<p>@type value: int
|
|
@param value: The value that the enum is mapped to.</p>
|
|
<p>@rtype: AngleUnit
|
|
@returns: AngleUnit.degree or AngleUnit.radian</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_display_layers">
|
|
<span class="sig-name descname"><span class="pre">get_display_layers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_display_layers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_display_layers" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Gets a lod id list that need to be created for the meshes from @config</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_filtered_meshes">
|
|
<span class="sig-name descname"><span class="pre">get_filtered_meshes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_filtered_meshes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_filtered_meshes" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_linear_unit">
|
|
<span class="sig-name descname"><span class="pre">get_linear_unit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#dna_viewer.builder.config.LinearUnit" title="dna_viewer.builder.config.LinearUnit"><span class="pre">dna_viewer.builder.config.LinearUnit</span></a></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_linear_unit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_linear_unit" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_linear_unit_from_int">
|
|
<span class="sig-name descname"><span class="pre">get_linear_unit_from_int</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#dna_viewer.builder.config.LinearUnit" title="dna_viewer.builder.config.LinearUnit"><span class="pre">dna_viewer.builder.config.LinearUnit</span></a></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_linear_unit_from_int"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_linear_unit_from_int" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Returns an enum from an int value.
|
|
0 -> cm
|
|
1 -> m</p>
|
|
<p>@type value: int
|
|
@param value: The value that the enum is mapped to.</p>
|
|
<p>@rtype: LinearUnit
|
|
@returns: LinearUnit.cm or LinearUnit.m</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_mesh_indices_filter">
|
|
<span class="sig-name descname"><span class="pre">get_mesh_indices_filter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_mesh_indices_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_mesh_indices_filter" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.get_mesh_node_fullpath_on_root">
|
|
<span class="sig-name descname"><span class="pre">get_mesh_node_fullpath_on_root</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mesh_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.get_mesh_node_fullpath_on_root"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.get_mesh_node_fullpath_on_root" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Gets the full path in the scene of a mesh.</p>
|
|
<p>@type mesh_name: str
|
|
@param mesh_name: The mesh thats path is needed.</p>
|
|
<p>@rtype: str
|
|
@returns: The full path of the mesh object in the scene</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.new_scene">
|
|
<span class="sig-name descname"><span class="pre">new_scene</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.new_scene"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.new_scene" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.set_filtered_meshes">
|
|
<span class="sig-name descname"><span class="pre">set_filtered_meshes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.set_filtered_meshes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.set_filtered_meshes" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.builder.Builder.set_units">
|
|
<span class="sig-name descname"><span class="pre">set_units</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/builder.html#Builder.set_units"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.builder.Builder.set_units" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Sets the translation and rotation units of the scene from @config</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-dna_viewer.builder.config">
|
|
<span id="dna-viewer-builder-config-module"></span><h2>dna_viewer.builder.config module<a class="headerlink" href="#module-dna_viewer.builder.config" title="Permalink to this headline"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.AngleUnit">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.config.</span></span><span class="sig-name descname"><span class="pre">AngleUnit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#AngleUnit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.AngleUnit" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
|
<p>An enum used to represent the unit used for angle representation.</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@degree</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>using degree as unit</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@radian</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>using radian as unit</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.AngleUnit.degree">
|
|
<span class="sig-name descname"><span class="pre">degree</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#dna_viewer.builder.config.AngleUnit.degree" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.AngleUnit.radian">
|
|
<span class="sig-name descname"><span class="pre">radian</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#dna_viewer.builder.config.AngleUnit.radian" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.config.</span></span><span class="sig-name descname"><span class="pre">Config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meshes:</span> <span class="pre">typing.List[int]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mesh_filter:</span> <span class="pre">typing.List[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lod_filter:</span> <span class="pre">typing.List[int]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_by_lod:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">top_level_group:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'head'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geometry_group:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'geometry'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">facial_root_joint_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'FACIAL_C_FacialRoot'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blend_shape_group_prefix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'BlendshapeGroup_'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blend_shape_name_postfix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'_blendShapes'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skin_cluster_suffix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'skinCluster'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_display_layers:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_joints:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_blend_shapes:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_skin_cluster:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_ctrl_attributes_on_root_joint:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_animated_map_attributes_on_root_joint:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_key_frames:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_mesh_name_to_blend_shape_channel_name:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#Config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.Config" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>A class used to represent the config for @Builder</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">mesh_filter</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>List[str]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">mesh_filter</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>List of mesh names that should be filtered. Mash names can be just substrings. [“head”] will find all meshes that contins string “head” in its mash name.</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<p>@type lod_filter: List[int]
|
|
@param lod_filter: List of lods that should be filtered.</p>
|
|
<p>@type group_by_lod: bool
|
|
@param group_by_lod: A flag representing whether the character should be parented to a character transform node in the scene hierarchy</p>
|
|
<p>@type group_by_lod: bool
|
|
@param group_by_lod: A flag representing whether the character should be parented to a character transform node in rig hierarchy</p>
|
|
<p>@type top_level_group: str
|
|
@param top_level_group: Value that is going to be used when creating root group</p>
|
|
<p>@type geometry_group: str
|
|
@param geometry_group: Value that is going to be used when creating group that contains geometry</p>
|
|
<p>@type facial_root_joint_name: str
|
|
@param facial_root_joint_name: The name of the facial root joint</p>
|
|
<p>@type blend_shape_group_prefix: str
|
|
@param blend_shape_group_prefix: prefix string for blend shape group</p>
|
|
<p>@type blend_shape_name_postfix: str
|
|
@param blend_shape_name_postfix: postfix string for blend shape name</p>
|
|
<p>@type skin_cluster_suffix: str
|
|
@param skin_cluster_suffix: postfix string for skin cluster name</p>
|
|
<p>@type animated_map_attribute_multipliers_name: str
|
|
@param animated_map_attribute_multipliers_name: string for frame animated map attribute name</p>
|
|
<p>@type create_display_layers: bool
|
|
@param create_display_layers: A flag representing whether the created meshes should be assigned to a display layer</p>
|
|
<p>@type add_joints: bool
|
|
@param add_joints: A flag representing whether joints should be added</p>
|
|
<p>@type add_blend_shapes: bool
|
|
@param add_blend_shapes: A flag representing whether blend shapes should be added</p>
|
|
<p>@type add_skin_cluster: bool
|
|
@param add_skin_cluster: A flag representing whether skin should be added</p>
|
|
<p>@type add_ctrl_attributes_on_root_joint: bool
|
|
@param add_ctrl_attributes_on_root_joint: A flag representing whether control attributes should be added to the root joint</p>
|
|
<p>@type add_animated_map_attributes_on_root_joint: bool
|
|
@param add_animated_map_attributes_on_root_joint: A flag representing whether animated map attributes should be added to the root joint</p>
|
|
<p>@type add_key_frames: bool
|
|
@param add_key_frames: A flag representing whether key frames should be added</p>
|
|
<p>@type add_mesh_name_to_blend_shape_channel_name: bool
|
|
@param add_mesh_name_to_blend_shape_channel_name: A flag representing whether mesh name of blend shape channel is added to name when creating it</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_animated_map_attributes_on_root_joint">
|
|
<span class="sig-name descname"><span class="pre">add_animated_map_attributes_on_root_joint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_animated_map_attributes_on_root_joint" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_blend_shapes">
|
|
<span class="sig-name descname"><span class="pre">add_blend_shapes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_blend_shapes" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_ctrl_attributes_on_root_joint">
|
|
<span class="sig-name descname"><span class="pre">add_ctrl_attributes_on_root_joint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_ctrl_attributes_on_root_joint" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_joints">
|
|
<span class="sig-name descname"><span class="pre">add_joints</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_joints" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_key_frames">
|
|
<span class="sig-name descname"><span class="pre">add_key_frames</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_key_frames" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_mesh_name_to_blend_shape_channel_name">
|
|
<span class="sig-name descname"><span class="pre">add_mesh_name_to_blend_shape_channel_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_mesh_name_to_blend_shape_channel_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.add_skin_cluster">
|
|
<span class="sig-name descname"><span class="pre">add_skin_cluster</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.add_skin_cluster" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.animated_map_attribute_multipliers_name">
|
|
<span class="sig-name descname"><span class="pre">animated_map_attribute_multipliers_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FRM_WMmultipliers'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.animated_map_attribute_multipliers_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.blend_shape_group_prefix">
|
|
<span class="sig-name descname"><span class="pre">blend_shape_group_prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BlendshapeGroup_'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.blend_shape_group_prefix" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.blend_shape_name_postfix">
|
|
<span class="sig-name descname"><span class="pre">blend_shape_name_postfix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'_blendShapes'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.blend_shape_name_postfix" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.create_display_layers">
|
|
<span class="sig-name descname"><span class="pre">create_display_layers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.create_display_layers" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.facial_root_joint_name">
|
|
<span class="sig-name descname"><span class="pre">facial_root_joint_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FACIAL_C_FacialRoot'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.facial_root_joint_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.geometry_group">
|
|
<span class="sig-name descname"><span class="pre">geometry_group</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'geometry'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.geometry_group" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.get_geometry_group">
|
|
<span class="sig-name descname"><span class="pre">get_geometry_group</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#Config.get_geometry_group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.Config.get_geometry_group" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.get_rig_group">
|
|
<span class="sig-name descname"><span class="pre">get_rig_group</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#Config.get_rig_group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.Config.get_rig_group" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.get_top_level_group">
|
|
<span class="sig-name descname"><span class="pre">get_top_level_group</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#Config.get_top_level_group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.Config.get_top_level_group" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.group_by_lod">
|
|
<span class="sig-name descname"><span class="pre">group_by_lod</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.group_by_lod" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.lod_filter">
|
|
<span class="sig-name descname"><span class="pre">lod_filter</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">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.lod_filter" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.mesh_filter">
|
|
<span class="sig-name descname"><span class="pre">mesh_filter</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">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.mesh_filter" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.meshes">
|
|
<span class="sig-name descname"><span class="pre">meshes</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">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.meshes" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.skin_cluster_suffix">
|
|
<span class="sig-name descname"><span class="pre">skin_cluster_suffix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'skinCluster'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.skin_cluster_suffix" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.Config.top_level_group">
|
|
<span class="sig-name descname"><span class="pre">top_level_group</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'head'</span></em><a class="headerlink" href="#dna_viewer.builder.config.Config.top_level_group" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.LinearUnit">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.config.</span></span><span class="sig-name descname"><span class="pre">LinearUnit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#LinearUnit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.LinearUnit" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
|
<p>An enum used to represent the unit used for linear representation.</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@cm</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>using cm as unit</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@m</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>using m as unit</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.LinearUnit.cm">
|
|
<span class="sig-name descname"><span class="pre">cm</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#dna_viewer.builder.config.LinearUnit.cm" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.LinearUnit.m">
|
|
<span class="sig-name descname"><span class="pre">m</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#dna_viewer.builder.config.LinearUnit.m" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.config.</span></span><span class="sig-name descname"><span class="pre">RigConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meshes:</span> <span class="pre">typing.List[int]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mesh_filter:</span> <span class="pre">typing.List[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lod_filter:</span> <span class="pre">typing.List[int]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_by_lod:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">top_level_group:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'head'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geometry_group:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'geometry'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">facial_root_joint_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'FACIAL_C_FacialRoot'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blend_shape_group_prefix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'BlendshapeGroup_'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blend_shape_name_postfix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'_blendShapes'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skin_cluster_suffix:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'skinCluster'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_display_layers:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_joints:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_blend_shapes:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_skin_cluster:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_ctrl_attributes_on_root_joint:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_animated_map_attributes_on_root_joint:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_key_frames:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_mesh_name_to_blend_shape_channel_name:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_rig_logic:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rig_logic_command:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'createEmbeddedNodeRL4'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rig_logic_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">control_naming:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'<objName>.<attrName>'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">joint_naming:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'<objName>.<attrName>'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blend_shape_naming:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animated_map_naming:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gui_path:</span> <span class="pre">typing.Optional[str]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eye_gui_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'CTRL_C_eye'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gui_translate_x:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">analog_gui_path:</span> <span class="pre">typing.Optional[str]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">left_eye_joint_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'FACIAL_L_Eye'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right_eye_joint_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'FACIAL_R_Eye'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_driver_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'LOC_C_eyeDriver'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">left_eye_driver_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'LOC_L_eyeDriver'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right_eye_driver_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'LOC_R_eyeDriver'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">left_eye_aim_up_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'LOC_L_eyeAimUp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right_eye_aim_up_name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'LOC_R_eyeAimUp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_aim:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'GRP_C_eyesAim'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">le_aim:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'GRP_L_eyeAim'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">re_aim:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'GRP_R_eyeAim'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aas_path:</span> <span class="pre">typing.Optional[str]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aas_method:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'run_after_assemble'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aas_parameter:</span> <span class="pre">typing.Dict[typing.Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typing.Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/config.html#RigConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.config.RigConfig" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#dna_viewer.builder.config.Config" title="dna_viewer.builder.config.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">dna_viewer.builder.config.Config</span></code></a></p>
|
|
<p>A class used to represent the config for @RigBuilder</p>
|
|
<p>@type add_rig_logic: bool
|
|
@param add_rig_logic: A flag representing whether normals should be added</p>
|
|
<p>@type rig_logic_command: str
|
|
@param rig_logic_command: The command used to start creating the rig logic using the plugin</p>
|
|
<p>@type rig_logic_name: str
|
|
@param rig_logic_name: The name of the rig logic node</p>
|
|
<p>@type control_naming: str
|
|
@param control_naming: The naming pattern of controls</p>
|
|
<p>@type joint_naming: str
|
|
@param joint_naming: The naming pattern of joints</p>
|
|
<p>@type blend_shape_naming: str
|
|
@param blend_shape_naming: The naming pattern of blend shapes</p>
|
|
<p>@type animated_map_naming: str
|
|
@param animated_map_naming: The naming pattern of animated maps</p>
|
|
<p>@type gui_path: str
|
|
@param gui_path: The location of the gui file</p>
|
|
<p>@type left_eye_joint_name: str
|
|
@param left_eye_joint_name: The name of the left eye joint</p>
|
|
<p>@type eye_gui_name: str
|
|
@param eye_gui_name: The name of the control in the gui</p>
|
|
<p>@type gui_translate_x: float
|
|
@param gui_translate_x: Represents the value that the gui should be additionally translated on the X axis</p>
|
|
<p>@type analog_gui_path: str
|
|
@param analog_gui_path: The location of the analog gui file</p>
|
|
<p>@type left_eye_joint_name: str
|
|
@param left_eye_joint_name: The name of the left eye joint</p>
|
|
<p>@type right_eye_joint_name: str
|
|
@param right_eye_joint_name: The name of the right eye joint</p>
|
|
<p>@type central_driver_name: str
|
|
@param central_driver_name: The name of the central driver</p>
|
|
<p>@type left_eye_driver_name: str
|
|
@param left_eye_driver_name: The name of the left eye driver</p>
|
|
<p>@type right_eye_driver_name: str
|
|
@param right_eye_driver_name: The name of the right eye driver</p>
|
|
<p>@type central_aim: str
|
|
@param central_aim: The name of the central aim</p>
|
|
<p>@type le_aim: str
|
|
@param le_aim: The name of the left eye aim</p>
|
|
<p>@type re_aim: str
|
|
@param re_aim: The name of the right eye aim</p>
|
|
<p>@type aas_path: Optional[str]
|
|
@param aas_path: The location of the script file</p>
|
|
<p>@type aas_method: str
|
|
@param aas_method: The method that should be called</p>
|
|
<p>@type aas_parameter: Dict[Any, Any]
|
|
@param aas_parameter: The parameters that will be passed as the method arguments</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.aas_method">
|
|
<span class="sig-name descname"><span class="pre">aas_method</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'run_after_assemble'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.aas_method" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.aas_parameter">
|
|
<span class="sig-name descname"><span class="pre">aas_parameter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.aas_parameter" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.aas_path">
|
|
<span class="sig-name descname"><span class="pre">aas_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><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="#dna_viewer.builder.config.RigConfig.aas_path" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.add_rig_logic">
|
|
<span class="sig-name descname"><span class="pre">add_rig_logic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.add_rig_logic" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.analog_gui_path">
|
|
<span class="sig-name descname"><span class="pre">analog_gui_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><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="#dna_viewer.builder.config.RigConfig.analog_gui_path" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.animated_map_naming">
|
|
<span class="sig-name descname"><span class="pre">animated_map_naming</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.animated_map_naming" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.blend_shape_naming">
|
|
<span class="sig-name descname"><span class="pre">blend_shape_naming</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.blend_shape_naming" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.central_aim">
|
|
<span class="sig-name descname"><span class="pre">central_aim</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GRP_C_eyesAim'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.central_aim" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.central_driver_name">
|
|
<span class="sig-name descname"><span class="pre">central_driver_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOC_C_eyeDriver'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.central_driver_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.control_naming">
|
|
<span class="sig-name descname"><span class="pre">control_naming</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<objName>.<attrName>'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.control_naming" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.eye_gui_name">
|
|
<span class="sig-name descname"><span class="pre">eye_gui_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CTRL_C_eye'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.eye_gui_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.gui_path">
|
|
<span class="sig-name descname"><span class="pre">gui_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><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="#dna_viewer.builder.config.RigConfig.gui_path" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.gui_translate_x">
|
|
<span class="sig-name descname"><span class="pre">gui_translate_x</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.gui_translate_x" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.joint_naming">
|
|
<span class="sig-name descname"><span class="pre">joint_naming</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<objName>.<attrName>'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.joint_naming" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.le_aim">
|
|
<span class="sig-name descname"><span class="pre">le_aim</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GRP_L_eyeAim'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.le_aim" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.left_eye_aim_up_name">
|
|
<span class="sig-name descname"><span class="pre">left_eye_aim_up_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOC_L_eyeAimUp'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.left_eye_aim_up_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.left_eye_driver_name">
|
|
<span class="sig-name descname"><span class="pre">left_eye_driver_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOC_L_eyeDriver'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.left_eye_driver_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.left_eye_joint_name">
|
|
<span class="sig-name descname"><span class="pre">left_eye_joint_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FACIAL_L_Eye'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.left_eye_joint_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.re_aim">
|
|
<span class="sig-name descname"><span class="pre">re_aim</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GRP_R_eyeAim'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.re_aim" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.rig_logic_command">
|
|
<span class="sig-name descname"><span class="pre">rig_logic_command</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'createEmbeddedNodeRL4'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.rig_logic_command" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.rig_logic_name">
|
|
<span class="sig-name descname"><span class="pre">rig_logic_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.rig_logic_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.right_eye_aim_up_name">
|
|
<span class="sig-name descname"><span class="pre">right_eye_aim_up_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOC_R_eyeAimUp'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.right_eye_aim_up_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.right_eye_driver_name">
|
|
<span class="sig-name descname"><span class="pre">right_eye_driver_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOC_R_eyeDriver'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.right_eye_driver_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.config.RigConfig.right_eye_joint_name">
|
|
<span class="sig-name descname"><span class="pre">right_eye_joint_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FACIAL_R_Eye'</span></em><a class="headerlink" href="#dna_viewer.builder.config.RigConfig.right_eye_joint_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="dna-viewer-builder-joint-module">
|
|
<h2>dna_viewer.builder.joint module<a class="headerlink" href="#dna-viewer-builder-joint-module" title="Permalink to this headline"></a></h2>
|
|
<span class="target" id="module-dna_viewer.builder.joint"></span><dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.joint.Joint">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.joint.</span></span><span class="sig-name descname"><span class="pre">Joint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">joints</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dna_viewer.model.Joint</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/joint.html#Joint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.joint.Joint" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>A builder class used for adding joints to the scene</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">joints</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>List[JointModel]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">joints</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>data representing the joints</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">joint_flags</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>Dict[str, bool]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">joint_flags</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>A mapping used for setting flags that are used to avoid adding the same joint multiple times</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.joint.Joint.add_joint_to_scene">
|
|
<span class="sig-name descname"><span class="pre">add_joint_to_scene</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">joint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dna_viewer.model.Joint</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/joint.html#Joint.add_joint_to_scene"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.joint.Joint.add_joint_to_scene" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds the given joint to the scene</p>
|
|
<p>@type joint: JointModel
|
|
@param joint: The joint to be added to the scene</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.joint.Joint.process">
|
|
<span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/joint.html#Joint.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.joint.Joint.process" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Starts adding all the provided joints to the scene</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-dna_viewer.builder.mesh">
|
|
<span id="dna-viewer-builder-mesh-module"></span><h2>dna_viewer.builder.mesh module<a class="headerlink" href="#module-dna_viewer.builder.mesh" title="Permalink to this headline"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.mesh.</span></span><span class="sig-name descname"><span class="pre">Mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#dna_viewer.builder.config.Config" title="dna_viewer.builder.config.Config"><span class="pre">dna_viewer.builder.config.Config</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dna</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA" title="dna_viewer.dnalib.dnalib.DNA"><span class="pre">dna_viewer.dnalib.dnalib.DNA</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mesh_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>A builder class used for adding joints to the scene</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">dna</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p><a class="reference internal" href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA" title="dna_viewer.dnalib.dnalib.DNA">DNA</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">dna</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The location of the DNA file</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">mesh_index</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">mesh_index</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The mesh index we are working with</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">joint_ids</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>List[int]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">joint_ids</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The joint indices used for adding skin</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">joint_names</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>List[str]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">joint_names</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The joint names used for adding skin</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@type</span> <span class="pre">config</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p><a class="reference internal" href="#dna_viewer.builder.config.Config" title="dna_viewer.builder.config.Config">Config</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py">
|
|
<span class="sig-name descname"><span class="pre">@param</span> <span class="pre">config</span></span></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Type</dt>
|
|
<dd class="field-odd"><p>The build options that will be applied when creating the mesh</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<p>@type mesh: MayaMesh
|
|
@param mesh: The builder class object for creating the meshes</p>
|
|
<p>@type dna: DNA
|
|
@param dna: The DNA object that was loaded in</p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.add_blend_shapes">
|
|
<span class="sig-name descname"><span class="pre">add_blend_shapes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.add_blend_shapes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.add_blend_shapes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Reads in the blend shapes, then adds them to the mesh if it is set in the build options</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.add_skin_cluster">
|
|
<span class="sig-name descname"><span class="pre">add_skin_cluster</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.add_skin_cluster"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.add_skin_cluster" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds skin cluster to the mesh if it is set in the build options</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.build">
|
|
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.build" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Starts the build process, creates the neutral mesh, then adds normals, blends shapes and skin if needed</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.create_neutral_mesh">
|
|
<span class="sig-name descname"><span class="pre">create_neutral_mesh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.create_neutral_mesh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.create_neutral_mesh" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Creates the neutral mesh</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.prepare_joint_ids">
|
|
<span class="sig-name descname"><span class="pre">prepare_joint_ids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.prepare_joint_ids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.prepare_joint_ids" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.mesh.Mesh.prepare_joints">
|
|
<span class="sig-name descname"><span class="pre">prepare_joints</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/mesh.html#Mesh.prepare_joints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.mesh.Mesh.prepare_joints" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Gets the joint indices and names needed for the given mesh.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="dna-viewer-builder-rig-builder-module">
|
|
<h2>dna_viewer.builder.rig_builder module<a class="headerlink" href="#dna-viewer-builder-rig-builder-module" title="Permalink to this headline"></a></h2>
|
|
<span class="target" id="module-dna_viewer.builder.rig_builder"></span><dl class="py class">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dna_viewer.builder.rig_builder.</span></span><span class="sig-name descname"><span class="pre">RigBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dna</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA" title="dna_viewer.dnalib.dnalib.DNA"><span class="pre">dna_viewer.dnalib.dnalib.DNA</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#dna_viewer.builder.config.RigConfig" title="dna_viewer.builder.config.RigConfig"><span class="pre">dna_viewer.builder.config.RigConfig</span></a><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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#dna_viewer.builder.builder.Builder" title="dna_viewer.builder.builder.Builder"><code class="xref py py-class docutils literal notranslate"><span class="pre">dna_viewer.builder.builder.Builder</span></code></a></p>
|
|
<p>A builder class used for building meshes</p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_analog_gui">
|
|
<span class="sig-name descname"><span class="pre">add_analog_gui</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_analog_gui"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_analog_gui" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds an analog gui according to the specified analog gui options. If none is specified no analog gui will be
|
|
added.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_animated_map_attributes">
|
|
<span class="sig-name descname"><span class="pre">add_animated_map_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_animated_map_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_animated_map_attributes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds and sets the animated map attributes.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_ctrl_attributes">
|
|
<span class="sig-name descname"><span class="pre">add_ctrl_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_ctrl_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_ctrl_attributes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds and sets the raw gui control attributes.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_eye_locators">
|
|
<span class="sig-name descname"><span class="pre">add_eye_locators</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_eye_locators"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_eye_locators" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Add eye locators to the analog gui</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_eyes">
|
|
<span class="sig-name descname"><span class="pre">add_eyes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_eyes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_eyes" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Add eyes to the analog gui</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_gui">
|
|
<span class="sig-name descname"><span class="pre">add_gui</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_gui"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_gui" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Adds a gui according to the specified gui options. If none is specified no gui will be added.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.add_rig_logic">
|
|
<span class="sig-name descname"><span class="pre">add_rig_logic</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_rig_logic"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.add_rig_logic" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Creates and adds a rig logic node specified in the character configuration.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.import_gui">
|
|
<span class="sig-name descname"><span class="pre">import_gui</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gui_path</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">group_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.import_gui"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.import_gui" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Imports a gui using the provided parameters.</p>
|
|
<p>@type gui_path: str
|
|
@param gui_path: The path of the gui file that needs to be imported.</p>
|
|
<p>@type group_name: str
|
|
@param group_name: The name of the transform that holds the imported asset.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.position_gui">
|
|
<span class="sig-name descname"><span class="pre">position_gui</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.position_gui"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.position_gui" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Sets the gui position to align with the character eyes</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.run_additional_assemble_script">
|
|
<span class="sig-name descname"><span class="pre">run_additional_assemble_script</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.run_additional_assemble_script"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.run_additional_assemble_script" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Runs an additional assemble script if specified in the character configuration.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="dna_viewer.builder.rig_builder.RigBuilder.source_py_file">
|
|
<span class="sig-name descname"><span class="pre">source_py_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">module</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.source_py_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dna_viewer.builder.rig_builder.RigBuilder.source_py_file" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Used for loading a python file, used for additional assemble script.</p>
|
|
<p>@type name: str
|
|
@param name: The name of the module.</p>
|
|
<p>@type path: str
|
|
@param path: The path of the python file.</p>
|
|
<p>@rtype: Optional[ModuleType]
|
|
@returns: The loaded module.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="dna_viewer.html" class="btn btn-neutral float-left" title="DNAViewer package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="dna_viewer.builder.maya.html" class="btn btn-neutral float-right" title="DNAViewer.builder.maya package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2023, Epic Games.</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> |