2022-11-28 19:21:26 +08:00
<!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 — 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 = "Usage in Maya" href = "dna_viewer_maya_md.html" / >
2023-04-21 18:19:55 +08:00
< link rel = "prev" title = "API overview" href = "dnacalib_api_md.html" / >
2022-11-28 19:21:26 +08:00
< / 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 >
2022-12-02 21:35:01 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "index_.html" > MetaHuman DNA Calibration< / a > < / li >
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 >
2023-04-21 18:19:55 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "dnacalib_api_md.html" > API overview< / a > < / li >
2022-11-28 19:21:26 +08:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > DNAViewer< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > DNAViewer< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#examples" > Examples< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#usage-from-code" > Usage from code< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#usage-in-maya" > Usage in Maya< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#folder-structure" > Folder structure< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#how-it-works" > How it works< / a > < / li >
< / ul >
< / 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 >
2023-04-21 18:19:55 +08:00
< 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 >
2022-11-28 19:21:26 +08:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Technical documentation< / span > < / p >
< ul >
2023-04-21 18:19:55 +08:00
< 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 >
2022-11-28 19:21:26 +08:00
< / 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 > DNAViewer< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/dna_viewer_md.md.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" >
< h1 > DNAViewer< a class = "headerlink" href = "#dnaviewer" title = "Permalink to this headline" > < / a > < / h1 >
< p > The < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dna_viewer" > < code class = "docutils literal notranslate" > < span class = "pre" > dna_viewer< / span > < / code > < / a > contains all the needed classes for reading and creating a functional rig in Maya from the DNA file.
It is organized in a way that allows every option to be configurable, so you can easily get the exact result you want.< / p >
< section id = "examples" >
< h2 > Examples< a class = "headerlink" href = "#examples" title = "Permalink to this headline" > < / a > < / h2 >
< ul class = "simple" >
2023-04-21 18:19:55 +08:00
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_build_rig.py" > Generates rig< / a > < / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_export_fbx.py" > Export FBX per LOD< / a > < / p > < / li >
2022-11-28 19:21:26 +08:00
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_grab_changes_from_scene_and_propagate_to_dna.py" > Propagate changes from Maya scene to dna< / a > < / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_run_in_maya.py" > Simple UI< / a > < / p > < / li >
< / ul >
< / section >
< section id = "usage-from-code" >
< h2 > Usage from code< a class = "headerlink" href = "#usage-from-code" title = "Permalink to this headline" > < / a > < / h2 >
< p > There are two < a class = "reference internal" href = "dna_viewer_api_md.html" > < span class = "doc std std-doc" > APIs< / span > < / a > :< / p >
< ul class = "simple" >
2023-04-21 18:19:55 +08:00
< li > < p > < a class = "reference internal" href = "dna_viewer_api_build_meshes_md.html" > < span class = "doc std std-doc" > build_meshes< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "dna_viewer_api_build_rig_md.html" > < span class = "doc std std-doc" > build_rig< / span > < / a > < / p > < / li >
2022-11-28 19:21:26 +08:00
< / ul >
< / section >
< section id = "usage-in-maya" >
< h2 > Usage in Maya< a class = "headerlink" href = "#usage-in-maya" title = "Permalink to this headline" > < / a > < / h2 >
< p > Usage in Maya is explained < a class = "reference internal" href = "dna_viewer_maya_md.html" > < span class = "doc std std-doc" > here< / span > < / a > < / p >
< / section >
< section id = "folder-structure" >
< h2 > Folder structure< a class = "headerlink" href = "#folder-structure" title = "Permalink to this headline" > < / a > < / h2 >
< ul class = "simple" >
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dna_viewer/builder" > builder< / a > - Contains the builder classes, which are used for easily adding configuration options
2023-04-21 18:19:55 +08:00
and building the scene, configurations, meshes, etc..< / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dna_viewer/dnalib" > dnalib< / a > - Contains classes for nicer API accessing DNA file.< / p > < / li >
2022-11-28 19:21:26 +08:00
< li > < p > < a class = "reference external" href = "https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dna_viewer/ui" > ui< / a > - Contains the classes needed for the Maya UI.< / p > < / li >
< / ul >
< / section >
< section id = "how-it-works" >
< h2 > How it works< a class = "headerlink" href = "#how-it-works" title = "Permalink to this headline" > < / a > < / h2 >
< p > The general flow is the following:< / p >
< p > < img alt = "image" src = "_images/flow_general.png" / > < / p >
< p > The flow of the scene building process is the following:< / p >
< p > < img alt = "image" src = "_images/flow_scene_build.png" / > < / p >
< p > The flow of the rig building process is the following:< / p >
< p > < img alt = "image" src = "_images/flow_character_build.png" / > < / p >
< p > Legend:< / p >
< ul class = "simple" >
< li > < p > < span style = "color:blue" > blue: builder-related< / span > .< / p > < / li >
< li > < p > < span style = "color:green" > green: config-related< / span > .< / p > < / li >
< li > < p > < span style = "color:brown" > brown: model-related< / span > .< / p > < / li >
< li > < p > < span style = "color:purple" > purple: reader-related< / span > .< / p > < / li >
< / ul >
< / section >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
2023-04-21 18:19:55 +08:00
< a href = "dnacalib_api_md.html" class = "btn btn-neutral float-left" title = "API overview" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2022-11-28 19:21:26 +08:00
< a href = "dna_viewer_maya_md.html" class = "btn btn-neutral float-right" title = "Usage in Maya" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< / div >
< hr / >
< div role = "contentinfo" >
2023-04-21 18:19:55 +08:00
< p > © Copyright 2023, Epic Games.< / p >
2022-11-28 19:21:26 +08:00
< / 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 >