Metahuman_DNA_Calibration/docs/_modules/dna_viewer/util/mesh.html
2022-12-02 14:51:53 +01:00

355 lines
28 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.util.mesh &mdash; 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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>dna_viewer.util.mesh</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.mesh</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">List</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">..builder.scene</span> <span class="kn">import</span> <span class="n">Scene</span> <span class="k">as</span> <span class="n">SceneBuilder</span>
<span class="kn">from</span> <span class="nn">..config.character</span> <span class="kn">import</span> <span class="n">BuildOptions</span><span class="p">,</span> <span class="n">Character</span>
<span class="kn">from</span> <span class="nn">..config.scene</span> <span class="kn">import</span> <span class="n">Scene</span> <span class="k">as</span> <span class="n">SceneConfig</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">..model.dna</span> <span class="kn">import</span> <span class="n">DNA</span>
<span class="kn">from</span> <span class="nn">..util.error</span> <span class="kn">import</span> <span class="n">DNAViewerError</span>
<div class="viewcode-block" id="get_mesh_names"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.get_mesh_names">[docs]</a><span class="k">def</span> <span class="nf">get_mesh_names</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="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the list of mesh names contained in the DNA file.</span>
<span class="sd"> @type dna: DNA</span>
<span class="sd"> @param dna: Instance of DNA</span>
<span class="sd"> @rtype: List[str]</span>
<span class="sd"> @returns: The list of mesh names contained in the DNA file</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">dna</span><span class="o">.</span><span class="n">get_mesh_names</span><span class="p">()</span></div>
<div class="viewcode-block" id="get_mesh_lods"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.get_mesh_lods">[docs]</a><span class="k">def</span> <span class="nf">get_mesh_lods</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="o">-&gt;</span> <span class="n">List</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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the list of list of mesh indices grouped by the lod number.</span>
<span class="sd"> @type dna: DNA</span>
<span class="sd"> @param dna: Instance of DNA.</span>
<span class="sd"> @rtype: List[List[int]]</span>
<span class="sd"> @returns: The list of list of mesh indices grouped by the lod number</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">result</span><span class="p">:</span> <span class="n">List</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="p">[]</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="n">dna</span><span class="o">.</span><span class="n">get_lod_count</span><span class="p">()):</span>
<span class="n">mesh_indices</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">mesh_index</span> <span class="ow">in</span> <span class="n">dna</span><span class="o">.</span><span class="n">get_mesh_indices_for_lod</span><span class="p">(</span><span class="n">lod</span><span class="p">):</span>
<span class="n">mesh_indices</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mesh_index</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mesh_indices</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="create_build_options"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.create_build_options">[docs]</a><span class="k">def</span> <span class="nf">create_build_options</span><span class="p">(</span>
<span class="n">add_joints</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_blend_shapes</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_skin</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_ctrl_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">add_animated_map_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">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">False</span><span class="p">,</span>
<span class="n">add_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="p">)</span> <span class="o">-&gt;</span> <span class="n">BuildOptions</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates the build options object used in the character building process.</span>
<span class="sd"> @type add_joints: bool</span>
<span class="sd"> @param add_joints: Represents if joints should be added</span>
<span class="sd"> @type add_blend_shapes: bool</span>
<span class="sd"> @param add_blend_shapes: Represents if blend shapes should be added</span>
<span class="sd"> @type add_skin: bool</span>
<span class="sd"> @param add_skin: Represents if skin should be added</span>
<span class="sd"> @type add_ctrl_attributes_on_root_joint: bool</span>
<span class="sd"> @param add_ctrl_attributes_on_root_joint: Represents if gui control attributes should be added on the root joint</span>
<span class="sd"> @type add_animated_map_attributes_on_root_joint: bool</span>
<span class="sd"> @param add_animated_map_attributes_on_root_joint: Represents if animated map attributes should be added on the root joint</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"> @type add_key_frames: bool</span>
<span class="sd"> @param add_key_frames: A flag representing whether key frames should be added</span>
<span class="sd"> @rtype: BuildOptions</span>
<span class="sd"> @returns: The created build options object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">BuildOptions</span><span class="p">(</span>
<span class="n">add_joints</span><span class="o">=</span><span class="n">add_joints</span><span class="p">,</span>
<span class="n">add_blend_shapes</span><span class="o">=</span><span class="n">add_blend_shapes</span><span class="p">,</span>
<span class="n">add_skin</span><span class="o">=</span><span class="n">add_skin</span><span class="p">,</span>
<span class="n">add_ctrl_attributes_on_root_joint</span><span class="o">=</span><span class="n">add_ctrl_attributes_on_root_joint</span><span class="p">,</span>
<span class="n">add_animated_map_attributes_on_root_joint</span><span class="o">=</span><span class="n">add_animated_map_attributes_on_root_joint</span><span class="p">,</span>
<span class="n">add_mesh_name_to_blend_shape_channel_name</span><span class="o">=</span><span class="n">add_mesh_name_to_blend_shape_channel_name</span><span class="p">,</span>
<span class="n">add_key_frames</span><span class="o">=</span><span class="n">add_key_frames</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="build_meshes"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.build_meshes">[docs]</a><span class="k">def</span> <span class="nf">build_meshes</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">options</span><span class="p">:</span> <span class="n">BuildOptions</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">group_by_lod</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">mesh_list</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="kc">None</span><span class="p">,</span>
<span class="n">lod_list</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="kc">None</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="kc">False</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Starts the mesh building process with the provided parameters.</span>
<span class="sd"> @type dna: DNA</span>
<span class="sd"> @param dna: Instance of DNA</span>
<span class="sd"> @type options: BuildOptions</span>
<span class="sd"> @param options: The build options used in the build process</span>
<span class="sd"> @type group_by_lod: bool</span>
<span class="sd"> @param group_by_lod: Represents if the created meshes should be added to a holding transform representing the lod</span>
<span class="sd"> @type mesh_list: List[int]</span>
<span class="sd"> @param mesh_list: List of mesh indices that should be added.</span>
<span class="sd"> @type lod_list: List[int]</span>
<span class="sd"> @param lod_list: List of lods from which all containing meshes should be added.</span>
<span class="sd"> @type create_new_scene: bool</span>
<span class="sd"> @param create_new_scene: Represents if a new scene should be created in the build process.</span>
<span class="sd"> @rtype: List[str]</span>
<span class="sd"> @returns: The list of full paths of the created meshes in the maya scene</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">options</span> <span class="o">=</span> <span class="n">options</span> <span class="ow">or</span> <span class="n">BuildOptions</span><span class="p">()</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="p">[]</span>
<span class="n">meshes_by_lod</span> <span class="o">=</span> <span class="n">get_mesh_lods</span><span class="p">(</span><span class="n">dna</span><span class="p">)</span>
<span class="k">if</span> <span class="n">lod_list</span><span class="p">:</span>
<span class="k">for</span> <span class="n">lod</span> <span class="ow">in</span> <span class="n">lod_list</span><span class="p">:</span>
<span class="n">meshes</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">meshes_by_lod</span><span class="p">[</span><span class="n">lod</span><span class="p">])</span>
<span class="k">if</span> <span class="n">mesh_list</span><span class="p">:</span>
<span class="n">meshes</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">mesh_list</span><span class="p">)</span>
<span class="k">if</span> <span class="n">mesh_list</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">lod_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">meshes</span> <span class="o">=</span> <span class="p">[</span><span class="n">mesh_index</span> <span class="k">for</span> <span class="n">meshes</span> <span class="ow">in</span> <span class="n">meshes_by_lod</span> <span class="k">for</span> <span class="n">mesh_index</span> <span class="ow">in</span> <span class="n">meshes</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="o">=</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="n">value</span><span class="o">=</span><span class="n">group_by_lod</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="o">=</span><span class="n">meshes</span><span class="p">)</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">options</span>
<span class="n">config</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">SceneConfig</span><span class="p">()</span>
<span class="o">.</span><span class="n">with_character</span><span class="p">(</span><span class="n">character</span><span class="o">=</span><span class="n">character_config</span><span class="p">)</span>
<span class="o">.</span><span class="n">with_create_new_scene</span><span class="p">(</span><span class="n">create_new_scene</span><span class="p">)</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="p">)</span>
<span class="n">scene_build_result</span> <span class="o">=</span> <span class="n">SceneBuilder</span><span class="p">(</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">character_result</span> <span class="ow">in</span> <span class="n">scene_build_result</span><span class="o">.</span><span class="n">character_results</span><span class="p">:</span>
<span class="k">for</span> <span class="n">nodes_by_lod</span> <span class="ow">in</span> <span class="n">character_result</span><span class="o">.</span><span class="n">nodes</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">nodes_by_lod</span><span class="p">:</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="get_mesh_indices_containing_string"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.get_mesh_indices_containing_string">[docs]</a><span class="k">def</span> <span class="nf">get_mesh_indices_containing_string</span><span class="p">(</span>
<span class="n">mesh_name_part</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">lod</span><span class="p">:</span> <span class="nb">int</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="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the mesh indices containing a search string.</span>
<span class="sd"> @type mesh_name_part: str</span>
<span class="sd"> @param mesh_name_part: The string that is searched for in the meshes</span>
<span class="sd"> @type lod: int</span>
<span class="sd"> @param lod: The lod in which the mesh names will be searched for the result</span>
<span class="sd"> @type dna: DNA</span>
<span class="sd"> @param dna: Instance of DNA</span>
<span class="sd"> @rtype: List[int]</span>
<span class="sd"> @returns: The list of mesh indices which contain the mesh_name_part in their name</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="mi">0</span> <span class="o">&lt;=</span> <span class="n">lod</span> <span class="o">&lt;</span> <span class="n">dna</span><span class="o">.</span><span class="n">get_lod_count</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">DNAViewerError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Lod </span><span class="si">{</span><span class="n">lod</span><span class="si">}</span><span class="s2"> does not exist&quot;</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">mesh_index</span> <span class="ow">in</span> <span class="n">dna</span><span class="o">.</span><span class="n">get_mesh_indices_for_lod</span><span class="p">(</span><span class="n">lod</span><span class="p">):</span>
<span class="k">if</span> <span class="n">mesh_name_part</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">dna</span><span class="o">.</span><span class="n">get_mesh_name</span><span class="p">(</span><span class="n">mesh_index</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mesh_index</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">result</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DNAViewerError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;No results for </span><span class="si">{</span><span class="n">mesh_name_part</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="get_mesh_index"><a class="viewcode-back" href="../../../dna_viewer.util.html#dna_viewer.util.mesh.get_mesh_index">[docs]</a><span class="k">def</span> <span class="nf">get_mesh_index</span><span class="p">(</span><span class="n">mesh_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">lod</span><span class="p">:</span> <span class="nb">int</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="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets a mesh index with the given search string, returns the first one if multiple are found.</span>
<span class="sd"> @type mesh_name: str</span>
<span class="sd"> @param mesh_name: The string that is searched for in the meshes</span>
<span class="sd"> @type lod: int</span>
<span class="sd"> @param lod: The lod in which the mesh names will be searched for the result</span>
<span class="sd"> @type dna: DNA</span>
<span class="sd"> @param dna: Instance of DNA</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">get_mesh_indices_containing_string</span><span class="p">(</span><span class="n">mesh_name</span><span class="p">,</span> <span class="n">lod</span><span class="p">,</span> <span class="n">dna</span><span class="p">)</span>
<span class="k">if</span> <span class="n">results</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s2">&quot;Multiple meshes found, first result is returned, you should probably try a more specific mesh name&quot;</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">except</span> <span class="n">DNAViewerError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">None</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>