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.config.scene — 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.config.scene< / 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.config.scene< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "kn" > import< / span > < span class = "nn" > pathlib< / span >
< span class = "kn" > from< / span > < span class = "nn" > dataclasses< / span > < span class = "kn" > import< / span > < span class = "n" > dataclass< / span > < span class = "p" > ,< / span > < span class = "n" > field< / span >
< span class = "kn" > from< / span > < span class = "nn" > typing< / span > < span class = "kn" > import< / span > < span class = "n" > List< / span > < span class = "p" > ,< / span > < span class = "n" > Optional< / 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" > .units< / span > < span class = "kn" > import< / span > < span class = "n" > AngleUnit< / span > < span class = "p" > ,< / span > < span class = "n" > LinearUnit< / span > < span class = "p" > ,< / span > < span class = "n" > Unit< / span >
< div class = "viewcode-block" id = "SaveOptions" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.SaveOptions" > [docs]< / a > < span class = "nd" > @dataclass< / span >
< span class = "k" > class< / span > < span class = "nc" > SaveOptions< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > A class used to represent the save options< / span >
< span class = "sd" > Attributes< / span >
< span class = "sd" > ----------< / span >
< span class = "sd" > @type name: str< / span >
< span class = "sd" > @param name: The name of the scene< / span >
< span class = "sd" > @type extension: str< / span >
< span class = "sd" > @param extension: The extension< / span >
< span class = "sd" > @type destination_path: str< / span >
< span class = "sd" > @param destination_path: The location where the scene should be saved, if no value provided it defaults to the current working directory< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "n" > extension< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "n" > destination_path< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "nb" > str< / span > < span class = "p" > (< / span > < span class = "n" > pathlib< / span > < span class = "o" > .< / span > < span class = "n" > Path< / span > < span class = "o" > .< / span > < span class = "n" > cwd< / span > < span class = "p" > ()))< / span >
< div class = "viewcode-block" id = "SaveOptions.get_path" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.SaveOptions.get_path" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_path< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Returns the file path< / span >
< span class = "sd" > @rtype: str< / span >
< span class = "sd" > @returns: The file path< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > destination_path< / span > < span class = "si" > }< / span > < span class = "s2" > /< / span > < span class = "si" > {< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "si" > }< / span > < span class = "s2" > .< / span > < span class = "si" > {< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > extension< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span > < / div > < / div >
< div class = "viewcode-block" id = "Scene" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene" > [docs]< / a > < span class = "nd" > @dataclass< / span >
< span class = "k" > class< / span > < span class = "nc" > Scene< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > A class used to represent the scene config< / span >
< span class = "sd" > Attributes< / span >
< span class = "sd" > ----------< / span >
< span class = "sd" > @type dna_path: str< / span >
< span class = "sd" > @param dna_path: The location of the DNA file< / span >
< span class = "sd" > @type characters: List[Character]< / span >
< span class = "sd" > @param characters: The list of character configuration objects that need to be processed for the scene< / span >
< span class = "sd" > @type units: Unit< / span >
< span class = "sd" > @param units: The configuration containing the units for the scene< / span >
< span class = "sd" > @type create_new_scene: bool< / span >
< span class = "sd" > @param create_new_scene: A flag representing whether a new should be created when the build process starts< / span >
< span class = "sd" > @type save_options: SaveOptions< / span >
< span class = "sd" > @param save_options: A flag representing whether the created meshes should be assigned to a display layer< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > dna_path< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "n" > characters< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Character< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default_factory< / span > < span class = "o" > =< / span > < span class = "nb" > list< / span > < span class = "p" > )< / span >
< span class = "n" > units< / span > < span class = "p" > :< / span > < span class = "n" > Unit< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default_factory< / span > < span class = "o" > =< / span > < span class = "n" > Unit< / span > < span class = "p" > )< / span >
< span class = "n" > create_new_scene< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "n" > save_options< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > SaveOptions< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > field< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "Scene.with_character" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene.with_character" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_character< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > character< / span > < span class = "p" > :< / span > < span class = "n" > Character< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Scene" < / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Adds a character to the list of characters that need to be processed< / span >
< span class = "sd" > @type character: Character< / span >
< span class = "sd" > @param character: The character configuration object< / span >
< span class = "sd" > @rtype: Scene< / span >
< span class = "sd" > @returns: The instance of the changed object< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > characters< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "n" > character< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < / div >
< div class = "viewcode-block" id = "Scene.with_linear_unit" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene.with_linear_unit" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_linear_unit< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > unit< / span > < span class = "p" > :< / span > < span class = "n" > LinearUnit< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Scene" < / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Set the linear unit for the scene< / span >
< span class = "sd" > @type unit: str< / span >
< span class = "sd" > @param unit: The linear unit name< / span >
< span class = "sd" > @rtype: Scene< / span >
< span class = "sd" > @returns: The instance of the changed object< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > units< / span > < span class = "o" > .< / span > < span class = "n" > linear_unit< / span > < span class = "o" > =< / span > < span class = "n" > unit< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < / div >
< div class = "viewcode-block" id = "Scene.with_angle_unit" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene.with_angle_unit" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_angle_unit< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > unit< / span > < span class = "p" > :< / span > < span class = "n" > AngleUnit< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Scene" < / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Set the angle unit for the scene< / span >
< span class = "sd" > @type unit: str< / span >
< span class = "sd" > @param unit: The angle unit name< / span >
< span class = "sd" > @rtype: Scene< / span >
< span class = "sd" > @returns: The instance of the changed object< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > units< / span > < span class = "o" > .< / span > < span class = "n" > angle_unit< / span > < span class = "o" > =< / span > < span class = "n" > unit< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < / div >
< div class = "viewcode-block" id = "Scene.with_create_new_scene" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene.with_create_new_scene" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_create_new_scene< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > create_new_scene< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Scene" < / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Set the flag representing whether a new should be created when the build process starts< / span >
< span class = "sd" > @type create_new_scene: bool< / span >
< span class = "sd" > @param create_new_scene: The flag representing whether a new should be created when the build process starts< / span >
< span class = "sd" > @rtype: Scene< / span >
< span class = "sd" > @returns: The instance of the changed object< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > create_new_scene< / span > < span class = "o" > =< / span > < span class = "n" > create_new_scene< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < / div >
< div class = "viewcode-block" id = "Scene.with_scene_file_path" > < a class = "viewcode-back" href = "../../../dna_viewer.config.html#dna_viewer.config.scene.Scene.with_scene_file_path" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_scene_file_path< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "p" > ,< / span >
< span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s2" > " untitled_scene" < / span > < span class = "p" > ,< / span >
< span class = "n" > extension< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s2" > " mb" < / span > < span class = "p" > ,< / span >
< span class = "n" > destination_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 = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Scene" < / span > < span class = "p" > :< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Set the scene save configuration< / span >
< span class = "sd" > @type name: str< / span >
< span class = "sd" > @param name: The name of the scene< / span >
< span class = "sd" > @type extension: str< / span >
< span class = "sd" > @param extension: The extension< / span >
< span class = "sd" > @type destination_path: str< / span >
< span class = "sd" > @param destination_path: The location where the scene should be saved< / span >
< span class = "sd" > @rtype: Scene< / span >
< span class = "sd" > @returns: The instance of the changed object< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > destination_path< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< span class = "n" > destination_path< / span > < span class = "o" > =< / span > < span class = "nb" > str< / span > < span class = "p" > (< / span > < span class = "n" > pathlib< / span > < span class = "o" > .< / span > < span class = "n" > Path< / span > < span class = "o" > .< / span > < span class = "n" > cwd< / span > < span class = "p" > ())< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > save_options< / span > < span class = "o" > =< / span > < span class = "n" > SaveOptions< / span > < span class = "p" > (< / span >
< span class = "n" > name< / span > < span class = "o" > =< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > extension< / span > < span class = "o" > =< / span > < span class = "n" > extension< / span > < span class = "p" > ,< / span > < span class = "n" > destination_path< / span > < span class = "o" > =< / span > < span class = "n" > destination_path< / span >
< span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / 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 >
