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.util.reference — 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 >
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 >
< / 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.util.reference< / 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.util.reference< / h1 > < div class = "highlight" > < pre >
< span > < / 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 = "kn" > from< / span > < span class = "nn" > ..reader.geometry< / span > < span class = "kn" > import< / span > < span class = "n" > Geometry< / span >
< div class = "viewcode-block" id = "get_geometry_reader" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.reference.get_geometry_reader" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_geometry_reader< / 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 = "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" > Geometry< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Gets a Geometry reader for a given mesh index and a dna_file path.< / span >
< span class = "sd" > @type mesh_index: int< / span >
< span class = "sd" > @param mesh_index: The mesh index< / span >
< span class = "sd" > @type dna_path: str< / span >
< span class = "sd" > @param dna_path: The path of the DNA file< / span >
< span class = "sd" > @rtype: Geometry< / span >
< span class = "sd" > @returns: A geometry reader stored in the Reference class object for the given mesh index and DNA< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > get_geometry_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" > dna_path< / span > < span class = "o" > =< / span > < span class = "n" > dna_path< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "set_geometry_reader" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.reference.set_geometry_reader" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > set_geometry_reader< / span > < span class = "p" > (< / span > < span class = "n" > dna_path< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > geometry_reader< / span > < span class = "p" > :< / span > < span class = "n" > Geometry< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Adds a new geometry reader to the the references mapped to the DNA file path.< / span >
< span class = "sd" > @type dna_path: str< / span >
< span class = "sd" > @param dna_path: The path of the DNA file< / span >
< span class = "sd" > @type geometry_reader: Geometry< / span >
< span class = "sd" > @param geometry_reader: The geometry stream reader< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > set_geometry_reader< / span > < span class = "p" > (< / span >
< span class = "n" > dna_path< / span > < span class = "o" > =< / span > < span class = "n" > dna_path< / span > < span class = "p" > ,< / span > < span class = "n" > geometry_reader< / span > < span class = "o" > =< / span > < span class = "n" > geometry_reader< / span >
< span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "Reference" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.reference.Reference" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > Reference< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > A class used for storing and retrieving geometry readers.< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > geometry_readers< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Geometry< / span > < span class = "p" > ]]< / span > < span class = "o" > =< / span > < span class = "p" > {}< / span >
< div class = "viewcode-block" id = "Reference.get_geometry_reader" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.reference.Reference.get_geometry_reader" > [docs]< / a > < span class = "nd" > @staticmethod< / span >
< span class = "k" > def< / span > < span class = "nf" > get_geometry_reader< / 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 = "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" > Geometry< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Gets a Geometry reader for a given mesh index and a dna_file path.< / span >
< span class = "sd" > @type mesh_index: int< / span >
< span class = "sd" > @param mesh_index: The mesh index< / span >
< span class = "sd" > @type dna_path: str< / span >
< span class = "sd" > @param dna_path: The path of the DNA file< / span >
< span class = "sd" > @rtype: Geometry< / span >
< span class = "sd" > @returns: A stored geometry reader for the given mesh index and DNA< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > dna_path< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span > < span class = "c1" > # defaults to first one< / span >
< span class = "n" > geometry_readers_for_dna< / span > < span class = "o" > =< / span > < span class = "nb" > next< / span > < span class = "p" > (< / span > < span class = "nb" > iter< / span > < span class = "p" > (< / span > < span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > geometry_readers< / span > < span class = "o" > .< / span > < span class = "n" > values< / span > < span class = "p" > ()))< / span >
< span class = "k" > return< / span > < span class = "n" > geometry_readers_for_dna< / span > < span class = "p" > [< / span > < span class = "n" > mesh_index< / span > < span class = "p" > ]< / span >
< span class = "k" > return< / span > < span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > geometry_readers< / span > < span class = "p" > [< / span > < span class = "n" > dna_path< / span > < span class = "p" > ][< / span > < span class = "n" > mesh_index< / span > < span class = "p" > ]< / span > < / div >
< div class = "viewcode-block" id = "Reference.set_geometry_reader" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.reference.Reference.set_geometry_reader" > [docs]< / a > < span class = "nd" > @staticmethod< / span >
< span class = "k" > def< / span > < span class = "nf" > set_geometry_reader< / span > < span class = "p" > (< / span > < span class = "n" > dna_path< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > geometry_reader< / span > < span class = "p" > :< / span > < span class = "n" > Geometry< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Adds a mapping value of a geometry reader to the DNA file path.< / span >
< span class = "sd" > @type dna_path: str< / span >
< span class = "sd" > @param dna_path: The path of the DNA file< / span >
< span class = "sd" > @type geometry_reader: Geometry< / span >
< span class = "sd" > @param geometry_reader: The geometry reader that should be added to the mapping.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > dna_path< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > geometry_readers< / span > < span class = "p" > :< / span >
< span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > geometry_readers< / span > < span class = "p" > [< / span > < span class = "n" > dna_path< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > []< / span >
< span class = "n" > Reference< / span > < span class = "o" > .< / span > < span class = "n" > geometry_readers< / span > < span class = "p" > [< / span > < span class = "n" > dna_path< / span > < span class = "p" > ]< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "n" > geometry_reader< / 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 >
