CGNICO/Metahuman_DNA_Calibration
2
0
Fork 0
Code Issues 19 Pull Requests 1 Actions Packages Projects Releases 7 Wiki Activity
52e4336393
Metahuman_DNA_Calibration/docs/_modules/dna_viewer/builder/character.html

209 lines
15 KiB
HTML
Raw Normal View History

generated documentation
2022-11-28 19:21:26 +08:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dna_viewer.builder.character &mdash; 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" />
</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>
generated new documentation
2022-12-02 21:35:01 +08:00
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html">MetaHuman DNA Calibration</a></li>
generated documentation
2022-11-28 19:21:26 +08:00
<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>
</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>
</ul>
<p class="caption" role="heading"><span class="caption-text">Technical documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../dnacalib.html">dnacalib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">dna_viewer</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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>dna_viewer.builder.character</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for dna_viewer.builder.character</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">maya.api.OpenMaya</span> <span class="kn">import</span> <span class="n">MObject</span>
<span class="kn">from</span> <span class="nn">..config.character</span> <span class="kn">import</span> <span class="n">Character</span> <span class="k">as</span> <span class="n">CharacterConfig</span>
<span class="kn">from</span> <span class="nn">..model.dna</span> <span class="kn">import</span> <span class="n">DNA</span>
<span class="kn">from</span> <span class="nn">..util.character_creator</span> <span class="kn">import</span> <span class="n">CharacterCreator</span>
<span class="kn">from</span> <span class="nn">..util.error</span> <span class="kn">import</span> <span class="n">DNAViewerError</span>
<div class="viewcode-block" id="CharacterBuildResult"><a class="viewcode-back" href="../../../dna_viewer.builder.html#dna_viewer.builder.character.CharacterBuildResult">[docs]</a><span class="k">class</span> <span class="nc">CharacterBuildResult</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A class used for returning data after finishing the character build process</span>
<span class="sd"> Attributes</span>
<span class="sd"> ----------</span>
<span class="sd"> @type nodes: Dict[int, List[MObject]]</span>
<span class="sd"> @param nodes: The PyNode objects created in the build process by LOD number</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">nodes</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">MObject</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{}</span>
<div class="viewcode-block" id="CharacterBuildResult.create"><a class="viewcode-back" href="../../../dna_viewer.builder.html#dna_viewer.builder.character.CharacterBuildResult.create">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="n">nodes</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">MObject</span><span class="p">]])</span> <span class="o">-&gt;</span> <span class="s2">&quot;CharacterBuildResult&quot;</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Character creator method returning a character build result object</span>
<span class="sd"> @type nodes: Dict[int, List[MObject]]</span>
<span class="sd"> @param nodes: The PyNode objects created in the build process by LOD number</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">CharacterBuildResult</span><span class="p">()</span>
<span class="n">result</span><span class="o">.</span><span class="n">nodes</span> <span class="o">=</span> <span class="n">nodes</span>
<span class="k">return</span> <span class="n">result</span></div></div>
<div class="viewcode-block" id="Character"><a class="viewcode-back" href="../../../dna_viewer.builder.html#dna_viewer.builder.character.Character">[docs]</a><span class="k">class</span> <span class="nc">Character</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A builder class used for building the character</span>
<span class="sd"> Attributes</span>
<span class="sd"> ----------</span>
<span class="sd"> @type config: CharacterConfig</span>
<span class="sd"> @param config: The character configuration options used for building the character</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dna</span><span class="p">:</span> <span class="n">DNA</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">CharacterConfig</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dna</span> <span class="o">=</span> <span class="n">dna</span>
<span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">CharacterConfig</span><span class="p">()</span>
<div class="viewcode-block" id="Character.build"><a class="viewcode-back" href="../../../dna_viewer.builder.html#dna_viewer.builder.character.Character.build">[docs]</a> <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">CharacterBuildResult</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Builds the character&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">dna</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DNAViewerError</span><span class="p">(</span><span class="s2">&quot;must provide DNA path&quot;</span><span class="p">)</span>
<span class="n">creator</span> <span class="o">=</span> <span class="n">CharacterCreator</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">dna</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dna</span><span class="p">)</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;******************************&quot;</span><span class="p">)</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">creator</span><span class="o">.</span><span class="n">character_name</span><span class="p">)</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;******************************&quot;</span><span class="p">)</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_character_node</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">add_joints_to_character</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_ctrl_attributes_on_joint</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_animated_map_attributes</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">add_key_frames</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_geometry_node</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_rig_node</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">create_character_meshes</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">add_gui</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">add_analog_gui</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">add_rig_logic_node</span><span class="p">()</span>
<span class="n">creator</span><span class="o">.</span><span class="n">run_additional_assembly_script</span><span class="p">()</span>
<span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">creator</span><span class="o">.</span><span class="n">character_name</span><span class="si">}</span><span class="s2"> built successfully!&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">CharacterBuildResult</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">nodes</span><span class="o">=</span><span class="n">creator</span><span class="o">.</span><span class="n">meshes</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, 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>
Reference in New Issue Copy Permalink