264 lines
22 KiB
HTML
264 lines
22 KiB
HTML
<!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.reader.dna — 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>
|
|
<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>
|
|
</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> »</li>
|
|
<li><a href="../../index.html">Module code</a> »</li>
|
|
<li>dna_viewer.reader.dna</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.reader.dna</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">Optional</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">..model.behavior</span> <span class="kn">import</span> <span class="n">Behavior</span> <span class="k">as</span> <span class="n">BehaviorModel</span>
|
|
<span class="kn">from</span> <span class="nn">..model.definition</span> <span class="kn">import</span> <span class="n">Definition</span> <span class="k">as</span> <span class="n">DefinitionModel</span>
|
|
<span class="kn">from</span> <span class="nn">..model.descriptor</span> <span class="kn">import</span> <span class="n">Descriptor</span> <span class="k">as</span> <span class="n">DescriptorModel</span>
|
|
<span class="kn">from</span> <span class="nn">..model.dna</span> <span class="kn">import</span> <span class="n">DNA</span> <span class="k">as</span> <span class="n">DNAModel</span>
|
|
<span class="kn">from</span> <span class="nn">..model.geometry</span> <span class="kn">import</span> <span class="n">Geometry</span> <span class="k">as</span> <span class="n">GeometryModel</span>
|
|
<span class="kn">from</span> <span class="nn">..model.geometry</span> <span class="kn">import</span> <span class="n">Mesh</span>
|
|
<span class="kn">from</span> <span class="nn">..reader.behavior</span> <span class="kn">import</span> <span class="n">Behavior</span> <span class="k">as</span> <span class="n">BehaviorReader</span>
|
|
<span class="kn">from</span> <span class="nn">..reader.definition</span> <span class="kn">import</span> <span class="n">Definition</span> <span class="k">as</span> <span class="n">DefinitionReader</span>
|
|
<span class="kn">from</span> <span class="nn">..reader.descriptor</span> <span class="kn">import</span> <span class="n">Descriptor</span> <span class="k">as</span> <span class="n">DescriptorReader</span>
|
|
<span class="kn">from</span> <span class="nn">..reader.geometry</span> <span class="kn">import</span> <span class="n">Geometry</span> <span class="k">as</span> <span class="n">GeometryReader</span>
|
|
<span class="kn">from</span> <span class="nn">..util.reader</span> <span class="kn">import</span> <span class="n">Reader</span>
|
|
<span class="kn">from</span> <span class="nn">..util.reference</span> <span class="kn">import</span> <span class="n">set_geometry_reader</span>
|
|
|
|
|
|
<div class="viewcode-block" id="load_dna"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.load_dna">[docs]</a><span class="k">def</span> <span class="nf">load_dna</span><span class="p">(</span><span class="n">dna_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">DNAModel</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">DNA</span><span class="o">.</span><span class="n">load_dna</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="n">dna_path</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="DNA"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA">[docs]</a><span class="k">class</span> <span class="nc">DNA</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> A class used to represent the character config</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="DNA.load_dna"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.load_dna">[docs]</a> <span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">load_dna</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">DNAModel</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Loads in the DNA from the given file path</span>
|
|
|
|
<span class="sd"> @type dna: DNAModel</span>
|
|
<span class="sd"> @param dna: The DNA data</span>
|
|
|
|
<span class="sd"> @rtype: DNA</span>
|
|
<span class="sd"> @returns: An object representing the DNA data</span>
|
|
<span class="sd"> """</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">"loading DNA </span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
<span class="n">reader</span> <span class="o">=</span> <span class="n">DNA</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">()</span></div>
|
|
|
|
<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">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">stream_reader</span> <span class="o">=</span> <span class="n">Reader</span><span class="o">.</span><span class="n">create_stream_reader</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">dna</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">DNAModel</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<div class="viewcode-block" id="DNA.read"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">DNAModel</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Reads in the base DNA data as well as the meshes</span>
|
|
|
|
<span class="sd"> @rtype: DNAModel</span>
|
|
<span class="sd"> @returns: The DNA data</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">dna</span> <span class="o">=</span> <span class="n">DNAModel</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">read_base</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">load_meshes</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">dna</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.read_base"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read_base">[docs]</a> <span class="k">def</span> <span class="nf">read_base</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""Reads in the base DNA data without the mesh data"""</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">dna</span><span class="o">.</span><span class="n">descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_descriptor</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">definition</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_definition</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">behavior</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_behavior</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">geometry</span> <span class="o">=</span> <span class="n">GeometryModel</span><span class="p">()</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.load_meshes"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.load_meshes">[docs]</a> <span class="k">def</span> <span class="nf">load_meshes</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""Loads all the mesh data"""</span>
|
|
|
|
<span class="k">for</span> <span class="n">lod</span> <span class="ow">in</span> <span class="nb">range</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">descriptor</span><span class="o">.</span><span class="n">lod_count</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">mesh_index</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">dna</span><span class="o">.</span><span class="n">definition</span><span class="o">.</span><span class="n">meshes</span><span class="o">.</span><span class="n">indices_for_lod</span><span class="p">[</span><span class="n">lod</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">geometry</span><span class="o">.</span><span class="n">meshes</span><span class="p">[</span><span class="n">mesh_index</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">load_mesh</span><span class="p">(</span>
|
|
<span class="n">mesh_index</span><span class="o">=</span><span class="n">mesh_index</span>
|
|
<span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.load_mesh"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.load_mesh">[docs]</a> <span class="k">def</span> <span class="nf">load_mesh</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mesh_index</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">Mesh</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Loads geometry data for a single mesh at the given index</span>
|
|
|
|
<span class="sd"> @type mesh_index: int</span>
|
|
<span class="sd"> @param mesh_index: mesh index</span>
|
|
|
|
<span class="sd"> @rtype: Mesh</span>
|
|
<span class="sd"> @returns: mesh data</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_geometry_for_mesh_index</span><span class="p">(</span><span class="n">mesh_index</span><span class="o">=</span><span class="n">mesh_index</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.read_descriptor"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read_descriptor">[docs]</a> <span class="k">def</span> <span class="nf">read_descriptor</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">DescriptorModel</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Reads the descriptor part of the DNA</span>
|
|
|
|
<span class="sd"> @rtype: DescriptorModel</span>
|
|
<span class="sd"> @returns: Descriptor data from the DNA</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">return</span> <span class="n">DescriptorReader</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stream_reader</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.read_definition"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read_definition">[docs]</a> <span class="k">def</span> <span class="nf">read_definition</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">DefinitionModel</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Reads the definition part of the DNA</span>
|
|
|
|
<span class="sd"> @rtype: DefinitionModel</span>
|
|
<span class="sd"> @returns: Definition data from the DNA</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">return</span> <span class="n">DefinitionReader</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stream_reader</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.read_behavior"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read_behavior">[docs]</a> <span class="k">def</span> <span class="nf">read_behavior</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">BehaviorModel</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Reads the descriptor part of the DNA</span>
|
|
|
|
<span class="sd"> @rtype: DescriptorModel</span>
|
|
<span class="sd"> @returns: Descriptor data from the DNA</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">return</span> <span class="n">BehaviorReader</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stream_reader</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span></div>
|
|
|
|
<div class="viewcode-block" id="DNA.read_geometry_for_mesh_index"><a class="viewcode-back" href="../../../dna_viewer.reader.html#dna_viewer.reader.dna.DNA.read_geometry_for_mesh_index">[docs]</a> <span class="k">def</span> <span class="nf">read_geometry_for_mesh_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mesh_index</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">Mesh</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Reads the geometry for a given mesh index</span>
|
|
|
|
<span class="sd"> @type mesh_index: int</span>
|
|
<span class="sd"> @param mesh_index: mesh index</span>
|
|
|
|
<span class="sd"> @rtype: Mesh</span>
|
|
<span class="sd"> @returns: Mesh data</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">reader</span> <span class="o">=</span> <span class="n">GeometryReader</span><span class="p">(</span><span class="n">stream_reader</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">stream_reader</span><span class="p">,</span> <span class="n">mesh_index</span><span class="o">=</span><span class="n">mesh_index</span><span class="p">)</span>
|
|
<span class="n">set_geometry_reader</span><span class="p">(</span><span class="n">dna_path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">geometry_reader</span><span class="o">=</span><span class="n">reader</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">()</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© 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> |