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.assemble — 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.assemble< / 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.assemble< / 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" > Any< / span > < span class = "p" > ,< / span > < span class = "n" > Dict< / span > < span class = "p" > ,< / span > < span class = "n" > List< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..builder.scene< / span > < span class = "kn" > import< / span > < span class = "n" > Scene< / span > < span class = "p" > ,< / span > < span class = "n" > SceneResult< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..config.aas< / span > < span class = "kn" > import< / span > < span class = "n" > AdditionalAssemblyScript< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..config.character< / span > < span class = "kn" > import< / span > < span class = "n" > Character< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..config.gui< / span > < span class = "kn" > import< / span > < span class = "n" > Gui< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..config.rig_logic< / span > < span class = "kn" > import< / span > < span class = "n" > RigLogic< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..config.units< / span > < span class = "kn" > import< / span > < span class = "n" > AngleUnit< / span > < span class = "p" > ,< / span > < span class = "n" > LinearUnit< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..const.naming< / span > < span class = "kn" > import< / span > < span class = "n" > BLEND_SHAPE_NAME_POSTFIX< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..model.dna< / span > < span class = "kn" > import< / span > < span class = "n" > DNA< / span >
< div class = "viewcode-block" id = "assemble_rig" > < a class = "viewcode-back" href = "../../../dna_viewer.util.html#dna_viewer.util.assemble.assemble_rig" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > assemble_rig< / 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" > analog_gui_path< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span >
< span class = "n" > gui_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 = "n" > gui< / span > < span class = "p" > :< / span > < span class = "n" > Gui< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ,< / span >
< span class = "n" > aas_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 = "n" > aas_fn< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s2" > " run_after_assemble" < / span > < span class = "p" > ,< / span >
< span class = "n" > aas_params< / 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" > Any< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ,< / span >
< span class = "n" > with_attributes_on_root_joint< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span >
< span class = "n" > with_key_frames< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span >
< span class = "n" > add_mesh_name_to_blend_shape_channel_name< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span >
< span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > SceneResult< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Used for assembling the rig with the following parameters< / span >
< span class = "sd" > @type dna: DNA< / span >
< span class = "sd" > @param dna: Instance of DNA< / span >
< span class = "sd" > @type gui_path: str< / span >
< span class = "sd" > @param gui_path: The file location of the gui< / span >
< span class = "sd" > @type gui: Gui< / span >
< span class = "sd" > @param gui: The gui configuration, this can be used instead of gui_path for finer control< / span >
< span class = "sd" > @type analog_gui_path: str< / span >
< span class = "sd" > @param analog_gui_path: The file location of the analog gui< / span >
< span class = "sd" > @type aas_path: str< / span >
< span class = "sd" > @param aas_path: The file location of the additional assembly script< / span >
< span class = "sd" > @type aas_fn: str< / span >
< span class = "sd" > @param aas_fn: The method name called from the additional assembly script (default is " run_after_assemble" )< / span >
< span class = "sd" > @type aas_params: str< / span >
< span class = "sd" > @param aas_params: The parameters dictionary that will get passed to the provided method name called from the additional assembly script (default is None)< / span >
< span class = "sd" > @type with_attributes_on_root_joint: bool< / span >
< span class = "sd" > @param with_attributes_on_root_joint: A flag used for adding attributes on the root joint (default is False)< / span >
< span class = "sd" > @type with_key_frames: bool< / span >
< span class = "sd" > @param with_key_frames: A flag used for adding key frames (default is False)< / span >
< span class = "sd" > @type add_mesh_name_to_blend_shape_channel_name: bool< / span >
< span class = "sd" > @param add_mesh_name_to_blend_shape_channel_name: A flag representing whether mash name of blend shape channel is added to name when creating it< / span >
< span class = "sd" > @rtype: SceneResult< / span >
< span class = "sd" > @returns: A SceneResult object representing the info about the finished build process< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > meshes< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "nb" > int< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "nb" > range< / span > < span class = "p" > (< / span > < span class = "n" > dna< / span > < span class = "o" > .< / span > < span class = "n" > get_mesh_count< / span > < span class = "p" > ()))< / span >
< span class = "n" > rig_logic< / span > < span class = "o" > =< / span > < span class = "n" > RigLogic< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "n" > add_mesh_name_to_blend_shape_channel_name< / span > < span class = "p" > :< / span >
< span class = "n" > rig_logic< / span > < span class = "o" > .< / span > < span class = "n" > with_blend_shape_naming< / span > < span class = "p" > (< / span >
< span class = "sa" > f< / span > < span class = "s2" > " < objName> < / span > < span class = "si" > {< / span > < span class = "n" > BLEND_SHAPE_NAME_POSTFIX< / span > < span class = "si" > }< / span > < span class = "s2" > .< objName> __< attrName> " < / span >
< span class = "p" > )< / span >
< span class = "n" > character_config< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "n" > Character< / span > < span class = "p" > ()< / span >
< span class = "o" > .< / span > < span class = "n" > with_dna< / span > < span class = "p" > (< / span > < span class = "n" > dna< / span > < span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_character_node< / span > < span class = "p" > (< / span > < span class = "kc" > False< / span > < span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_meshes< / span > < span class = "p" > (< / span > < span class = "n" > meshes< / span > < span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_analog_gui_path< / span > < span class = "p" > (< / span > < span class = "n" > analog_gui_path< / span > < span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_additional_assembly_script< / span > < span class = "p" > (< / span >
< span class = "n" > AdditionalAssemblyScript< / span > < span class = "p" > (< / span >
< span class = "n" > path< / span > < span class = "o" > =< / span > < span class = "n" > aas_path< / span > < span class = "p" > ,< / span >
< span class = "n" > method< / span > < span class = "o" > =< / span > < span class = "n" > aas_fn< / span > < span class = "p" > ,< / span >
< span class = "n" > parameter< / span > < span class = "o" > =< / span > < span class = "n" > aas_params< / span > < span class = "k" > if< / span > < span class = "n" > aas_params< / span > < span class = "k" > else< / span > < span class = "p" > {},< / span >
< span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_joints< / span > < span class = "p" > ()< / span >
< span class = "o" > .< / span > < span class = "n" > with_normals< / span > < span class = "p" > ()< / span >
< span class = "o" > .< / span > < span class = "n" > with_blend_shapes< / span > < span class = "p" > ()< / span >
< span class = "o" > .< / span > < span class = "n" > with_skin< / span > < span class = "p" > ()< / span >
< span class = "o" > .< / span > < span class = "n" > with_rig_logic< / span > < span class = "p" > (< / span > < span class = "n" > rig_logic< / span > < span class = "p" > )< / span >
< span class = "o" > .< / span > < span class = "n" > with_add_meshes_to_display_layers< / span > < span class = "p" > (< / span > < span class = "kc" > False< / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > gui_path< / span > < span class = "p" > :< / span >
< span class = "n" > character_config< / span > < span class = "o" > .< / span > < span class = "n" > with_gui_path< / span > < span class = "p" > (< / span > < span class = "n" > gui_path< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > gui< / span > < span class = "p" > :< / span >
< span class = "n" > character_config< / span > < span class = "o" > .< / span > < span class = "n" > with_gui< / span > < span class = "p" > (< / span > < span class = "n" > gui< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > with_attributes_on_root_joint< / span > < span class = "p" > :< / span >
< span class = "n" > character_config< / span > < span class = "o" > .< / span > < span class = "n" > with_ctrl_attributes_on_root_joint< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > with_animated_map_attributes_on_root_joint< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "n" > with_key_frames< / span > < span class = "p" > :< / span >
< span class = "n" > character_config< / span > < span class = "o" > .< / span > < span class = "n" > with_key_frames< / span > < span class = "p" > ()< / span >
< span class = "n" > character_config< / span > < span class = "o" > .< / span > < span class = "n" > options< / span > < span class = "o" > .< / span > < span class = "n" > add_mesh_name_to_blend_shape_channel_name< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "n" > add_mesh_name_to_blend_shape_channel_name< / span >
< span class = "p" > )< / span >
< span class = "n" > scene_builder< / span > < span class = "o" > =< / span > < span class = "n" > Scene< / span > < span class = "p" > ()< / span >
< span class = "n" > scene_builder< / span > < span class = "o" > .< / span > < span class = "n" > config< / span > < span class = "o" > .< / span > < span class = "n" > with_character< / span > < span class = "p" > (< / span > < span class = "n" > character_config< / span > < span class = "p" > )< / span >
< span class = "n" > scene_builder< / span > < span class = "o" > .< / span > < span class = "n" > config< / span > < span class = "o" > .< / span > < span class = "n" > with_linear_unit< / span > < span class = "p" > (< / span > < span class = "n" > unit< / span > < span class = "o" > =< / span > < span class = "n" > LinearUnit< / span > < span class = "o" > .< / span > < span class = "n" > cm< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > with_angle_unit< / span > < span class = "p" > (< / span >
< span class = "n" > unit< / span > < span class = "o" > =< / span > < span class = "n" > AngleUnit< / span > < span class = "o" > .< / span > < span class = "n" > degree< / span >
< span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > scene_builder< / span > < span class = "o" > .< / span > < span class = "n" > build< / span > < span class = "p" > ()< / span > < / 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 >
