<spanid="dna-viewer-builder-builder-module"></span><h2>dna_viewer.builder.builder module<aclass="headerlink"href="#module-dna_viewer.builder.builder"title="Permalink to this headline"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.builder.</span></span><spanclass="sig-name descname"><spanclass="pre">BuildResult</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">meshes_per_lod:</span><spanclass="pre">typing.Dict[int</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">typing.List[str]]</span><spanclass="pre">=</span><spanclass="pre"><factory></span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#BuildResult"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.BuildResult"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_all_meshes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#BuildResult.get_all_meshes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.BuildResult.get_all_meshes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">meshes_per_lod</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">Dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#dna_viewer.builder.builder.BuildResult.meshes_per_lod"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.builder.</span></span><spanclass="sig-name descname"><spanclass="pre">Builder</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dna</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA"title="dna_viewer.dnalib.dnalib.DNA"><spanclass="pre">dna_viewer.dnalib.dnalib.DNA</span></a></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#dna_viewer.builder.config.Config"title="dna_viewer.builder.config.Config"><spanclass="pre">dna_viewer.builder.config.Config</span></a><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_animated_map_attributes_on_root_joint</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_animated_map_attributes_on_root_joint"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_animated_map_attributes_on_root_joint"title="Permalink to this definition"></a></dt>
<dd><p>Adds and sets the animated map attributes on root joint.</p>
<spanclass="sig-name descname"><spanclass="pre">add_attribute</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">control_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">long_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_attribute"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_attribute"title="Permalink to this definition"></a></dt>
<dd><p>Adds attributes wrapper for internal usage.</p>
<spanclass="sig-name descname"><spanclass="pre">add_ctrl_attributes_on_root_joint</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_ctrl_attributes_on_root_joint"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_ctrl_attributes_on_root_joint"title="Permalink to this definition"></a></dt>
<dd><p>Adds and sets the raw gui control attributes on root joint.</p>
<spanclass="sig-name descname"><spanclass="pre">add_joints</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_joints"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_joints"title="Permalink to this definition"></a></dt>
<dd><p>Starts adding the joints the character, if the character configuration options have add_joints set to False,
<spanclass="sig-name descname"><spanclass="pre">add_key_frames</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_key_frames"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_key_frames"title="Permalink to this definition"></a></dt>
<dd><p>Adds a starting key frame to the facial root joint if joints are added and the add_key_frames option is set
<spanclass="sig-name descname"><spanclass="pre">add_mesh_to_display_layer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mesh_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lod</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.add_mesh_to_display_layer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.add_mesh_to_display_layer"title="Permalink to this definition"></a></dt>
<dd><p>Add the mesh with the given name to an already created display layer.</p>
<p>@type mesh_name: str
@param mesh_name: The name of the mesh that should be added to a display layer.</p>
<p>@type lod: int
@param lod: The lod value, this is needed for determining the name of the display layer that the mesh should be added to.</p>
<spanclass="sig-name descname"><spanclass="pre">attach_mesh_to_lod</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mesh_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lod</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.attach_mesh_to_lod"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.attach_mesh_to_lod"title="Permalink to this definition"></a></dt>
<dd><p>Attaches the mesh called mesh_name to a given lod.</p>
<p>@type mesh_name: str
@param mesh_name: The mesh that needs to be attached to a lod holder object.</p>
<p>@type lod: str
@param lod: The name of the mesh that should be added to a display layer.</p>
<spanclass="sig-name descname"><spanclass="pre">build</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#dna_viewer.builder.builder.BuildResult"title="dna_viewer.builder.builder.BuildResult"><spanclass="pre">dna_viewer.builder.builder.BuildResult</span></a></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.build"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.build"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">build_meshes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.build_meshes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.build_meshes"title="Permalink to this definition"></a></dt>
<dd><p>Builds the meshes. If specified in the config they get parented to a created
character node transform, otherwise the meshes get put to the root level of the scene.</p>
<spanclass="sig-name descname"><spanclass="pre">build_meshes_by_lod</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">lod</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">meshes_per_lod</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.build_meshes_by_lod"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.build_meshes_by_lod"title="Permalink to this definition"></a></dt>
<dd><p>Builds the meshes from the provided mesh ids and then attaches them to a given lod if specified in the
character configuration.</p>
<p>@type lod: int
@param lod: The lod number representing the display layer the meshes to the display layer.</p>
<p>@type meshes_per_lod: List[int]
@param meshes_per_lod: List of mesh indices that are being built.</p>
<p>@rtype: List[MObject]
@returns: The list of maya objects that represent the meshes added to the scene.</p>
<spanclass="sig-name descname"><spanclass="pre">create_groups</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.create_groups"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.create_groups"title="Permalink to this definition"></a></dt>
<dd><p>Creates a Maya transform which will hold the character, if the character configuration options have
create_character_node set to False, this step will be skipped.</p>
<spanclass="sig-name descname"><spanclass="pre">default_lambert_shader</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mesh_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.default_lambert_shader"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.default_lambert_shader"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_angle_unit</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#dna_viewer.builder.config.AngleUnit"title="dna_viewer.builder.config.AngleUnit"><spanclass="pre">dna_viewer.builder.config.AngleUnit</span></a></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_angle_unit"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_angle_unit"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_angle_unit_from_int</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#dna_viewer.builder.config.AngleUnit"title="dna_viewer.builder.config.AngleUnit"><spanclass="pre">dna_viewer.builder.config.AngleUnit</span></a></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_angle_unit_from_int"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_angle_unit_from_int"title="Permalink to this definition"></a></dt>
<dd><p>Returns an enum from an int value.
0 -> degree
1 -> radian</p>
<p>@type value: int
@param value: The value that the enum is mapped to.</p>
<p>@rtype: AngleUnit
@returns: AngleUnit.degree or AngleUnit.radian</p>
<spanclass="sig-name descname"><spanclass="pre">get_display_layers</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_display_layers"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_display_layers"title="Permalink to this definition"></a></dt>
<dd><p>Gets a lod id list that need to be created for the meshes from @config</p>
<spanclass="sig-name descname"><spanclass="pre">get_filtered_meshes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_filtered_meshes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_filtered_meshes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_linear_unit</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#dna_viewer.builder.config.LinearUnit"title="dna_viewer.builder.config.LinearUnit"><spanclass="pre">dna_viewer.builder.config.LinearUnit</span></a></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_linear_unit"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_linear_unit"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_linear_unit_from_int</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#dna_viewer.builder.config.LinearUnit"title="dna_viewer.builder.config.LinearUnit"><spanclass="pre">dna_viewer.builder.config.LinearUnit</span></a></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_linear_unit_from_int"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_linear_unit_from_int"title="Permalink to this definition"></a></dt>
<dd><p>Returns an enum from an int value.
0 -> cm
1 -> m</p>
<p>@type value: int
@param value: The value that the enum is mapped to.</p>
<spanclass="sig-name descname"><spanclass="pre">get_mesh_indices_filter</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_mesh_indices_filter"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_mesh_indices_filter"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_mesh_node_fullpath_on_root</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mesh_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">str</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.get_mesh_node_fullpath_on_root"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.get_mesh_node_fullpath_on_root"title="Permalink to this definition"></a></dt>
<dd><p>Gets the full path in the scene of a mesh.</p>
<p>@type mesh_name: str
@param mesh_name: The mesh thats path is needed.</p>
<p>@rtype: str
@returns: The full path of the mesh object in the scene</p>
<spanclass="sig-name descname"><spanclass="pre">new_scene</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.new_scene"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.new_scene"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">set_filtered_meshes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.set_filtered_meshes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.set_filtered_meshes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">set_units</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/builder.html#Builder.set_units"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.builder.Builder.set_units"title="Permalink to this definition"></a></dt>
<dd><p>Sets the translation and rotation units of the scene from @config</p>
<spanid="dna-viewer-builder-config-module"></span><h2>dna_viewer.builder.config module<aclass="headerlink"href="#module-dna_viewer.builder.config"title="Permalink to this headline"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.config.</span></span><spanclass="sig-name descname"><spanclass="pre">AngleUnit</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/config.html#AngleUnit"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.config.AngleUnit"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">degree</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">0</span></em><aclass="headerlink"href="#dna_viewer.builder.config.AngleUnit.degree"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">radian</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">1</span></em><aclass="headerlink"href="#dna_viewer.builder.config.AngleUnit.radian"title="Permalink to this definition"></a></dt>
<ddclass="field-odd"><p>List of mesh names that should be filtered. Mash names can be just substrings. [“head”] will find all meshes that contins string “head” in its mash name.</p>
@param add_mesh_name_to_blend_shape_channel_name: A flag representing whether mesh name of blend shape channel is added to name when creating it</p>
<spanclass="sig-name descname"><spanclass="pre">add_animated_map_attributes_on_root_joint</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_animated_map_attributes_on_root_joint"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_blend_shapes</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_blend_shapes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_ctrl_attributes_on_root_joint</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_ctrl_attributes_on_root_joint"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_joints</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_joints"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_key_frames</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_key_frames"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_mesh_name_to_blend_shape_channel_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_mesh_name_to_blend_shape_channel_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_skin_cluster</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.add_skin_cluster"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">animated_map_attribute_multipliers_name</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'FRM_WMmultipliers'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.animated_map_attribute_multipliers_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">blend_shape_group_prefix</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'BlendshapeGroup_'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.blend_shape_group_prefix"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">blend_shape_name_postfix</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'_blendShapes'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.blend_shape_name_postfix"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">create_display_layers</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.create_display_layers"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">facial_root_joint_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'FACIAL_C_FacialRoot'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.facial_root_joint_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">geometry_group</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'geometry'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.geometry_group"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_geometry_group</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">str</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/config.html#Config.get_geometry_group"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.config.Config.get_geometry_group"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_rig_group</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">str</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/config.html#Config.get_rig_group"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.config.Config.get_rig_group"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_top_level_group</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">str</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/config.html#Config.get_top_level_group"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.config.Config.get_top_level_group"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">group_by_lod</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.group_by_lod"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">lod_filter</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.lod_filter"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">mesh_filter</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.mesh_filter"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">meshes</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.meshes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">skin_cluster_suffix</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'skinCluster'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.skin_cluster_suffix"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">top_level_group</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'head'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.Config.top_level_group"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.config.</span></span><spanclass="sig-name descname"><spanclass="pre">LinearUnit</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/config.html#LinearUnit"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.config.LinearUnit"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">cm</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">0</span></em><aclass="headerlink"href="#dna_viewer.builder.config.LinearUnit.cm"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">m</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">1</span></em><aclass="headerlink"href="#dna_viewer.builder.config.LinearUnit.m"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">aas_method</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'run_after_assemble'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.aas_method"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">aas_parameter</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">Dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.aas_parameter"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">aas_path</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">None</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.aas_path"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_rig_logic</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">True</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.add_rig_logic"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">analog_gui_path</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">None</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.analog_gui_path"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">animated_map_naming</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">''</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.animated_map_naming"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">blend_shape_naming</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">''</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.blend_shape_naming"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">central_aim</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'GRP_C_eyesAim'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.central_aim"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">central_driver_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'LOC_C_eyeDriver'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.central_driver_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">control_naming</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'<objName>.<attrName>'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.control_naming"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">eye_gui_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'CTRL_C_eye'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.eye_gui_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">gui_path</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">None</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.gui_path"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">gui_translate_x</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">float</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">10</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.gui_translate_x"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">joint_naming</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'<objName>.<attrName>'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.joint_naming"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">le_aim</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'GRP_L_eyeAim'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.le_aim"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">left_eye_aim_up_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'LOC_L_eyeAimUp'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.left_eye_aim_up_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">left_eye_driver_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'LOC_L_eyeDriver'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.left_eye_driver_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">left_eye_joint_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'FACIAL_L_Eye'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.left_eye_joint_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">re_aim</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'GRP_R_eyeAim'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.re_aim"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">rig_logic_command</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'createEmbeddedNodeRL4'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.rig_logic_command"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">rig_logic_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">''</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.rig_logic_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">right_eye_aim_up_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'LOC_R_eyeAimUp'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.right_eye_aim_up_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">right_eye_driver_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'LOC_R_eyeDriver'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.right_eye_driver_name"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">right_eye_joint_name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'FACIAL_R_Eye'</span></em><aclass="headerlink"href="#dna_viewer.builder.config.RigConfig.right_eye_joint_name"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.joint.</span></span><spanclass="sig-name descname"><spanclass="pre">Joint</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">joints</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">List</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">dna_viewer.model.Joint</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/joint.html#Joint"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.joint.Joint"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_joint_to_scene</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">joint</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">dna_viewer.model.Joint</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/joint.html#Joint.add_joint_to_scene"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.joint.Joint.add_joint_to_scene"title="Permalink to this definition"></a></dt>
<dd><p>Adds the given joint to the scene</p>
<p>@type joint: JointModel
@param joint: The joint to be added to the scene</p>
<spanclass="sig-name descname"><spanclass="pre">process</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/joint.html#Joint.process"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.joint.Joint.process"title="Permalink to this definition"></a></dt>
<dd><p>Starts adding all the provided joints to the scene</p>
<spanid="dna-viewer-builder-mesh-module"></span><h2>dna_viewer.builder.mesh module<aclass="headerlink"href="#module-dna_viewer.builder.mesh"title="Permalink to this headline"></a></h2>
<spanclass="sig-name descname"><spanclass="pre">add_blend_shapes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.add_blend_shapes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.add_blend_shapes"title="Permalink to this definition"></a></dt>
<dd><p>Reads in the blend shapes, then adds them to the mesh if it is set in the build options</p>
<spanclass="sig-name descname"><spanclass="pre">add_skin_cluster</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.add_skin_cluster"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.add_skin_cluster"title="Permalink to this definition"></a></dt>
<dd><p>Adds skin cluster to the mesh if it is set in the build options</p>
<spanclass="sig-name descname"><spanclass="pre">build</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.build"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.build"title="Permalink to this definition"></a></dt>
<dd><p>Starts the build process, creates the neutral mesh, then adds normals, blends shapes and skin if needed</p>
<spanclass="sig-name descname"><spanclass="pre">create_neutral_mesh</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.create_neutral_mesh"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.create_neutral_mesh"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">prepare_joint_ids</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.prepare_joint_ids"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.prepare_joint_ids"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">prepare_joints</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/mesh.html#Mesh.prepare_joints"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.mesh.Mesh.prepare_joints"title="Permalink to this definition"></a></dt>
<dd><p>Gets the joint indices and names needed for the given mesh.</p>
<h2>dna_viewer.builder.rig_builder module<aclass="headerlink"href="#dna-viewer-builder-rig-builder-module"title="Permalink to this headline"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">dna_viewer.builder.rig_builder.</span></span><spanclass="sig-name descname"><spanclass="pre">RigBuilder</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dna</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="dna_viewer.dnalib.html#dna_viewer.dnalib.dnalib.DNA"title="dna_viewer.dnalib.dnalib.DNA"><spanclass="pre">dna_viewer.dnalib.dnalib.DNA</span></a></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#dna_viewer.builder.config.RigConfig"title="dna_viewer.builder.config.RigConfig"><spanclass="pre">dna_viewer.builder.config.RigConfig</span></a><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_analog_gui</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_analog_gui"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_analog_gui"title="Permalink to this definition"></a></dt>
<dd><p>Adds an analog gui according to the specified analog gui options. If none is specified no analog gui will be
<spanclass="sig-name descname"><spanclass="pre">add_animated_map_attributes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_animated_map_attributes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_animated_map_attributes"title="Permalink to this definition"></a></dt>
<dd><p>Adds and sets the animated map attributes.</p>
<spanclass="sig-name descname"><spanclass="pre">add_ctrl_attributes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_ctrl_attributes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_ctrl_attributes"title="Permalink to this definition"></a></dt>
<dd><p>Adds and sets the raw gui control attributes.</p>
<spanclass="sig-name descname"><spanclass="pre">add_eye_locators</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_eye_locators"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_eye_locators"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_eyes</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_eyes"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_eyes"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_gui</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_gui"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_gui"title="Permalink to this definition"></a></dt>
<dd><p>Adds a gui according to the specified gui options. If none is specified no gui will be added.</p>
<spanclass="sig-name descname"><spanclass="pre">add_rig_logic</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.add_rig_logic"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.add_rig_logic"title="Permalink to this definition"></a></dt>
<dd><p>Creates and adds a rig logic node specified in the character configuration.</p>
<spanclass="sig-name descname"><spanclass="pre">import_gui</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">gui_path</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.import_gui"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.import_gui"title="Permalink to this definition"></a></dt>
<dd><p>Imports a gui using the provided parameters.</p>
<p>@type gui_path: str
@param gui_path: The path of the gui file that needs to be imported.</p>
<p>@type group_name: str
@param group_name: The name of the transform that holds the imported asset.</p>
<spanclass="sig-name descname"><spanclass="pre">position_gui</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group_name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.position_gui"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.position_gui"title="Permalink to this definition"></a></dt>
<dd><p>Sets the gui position to align with the character eyes</p>
<spanclass="sig-name descname"><spanclass="pre">run_additional_assemble_script</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.run_additional_assemble_script"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.run_additional_assemble_script"title="Permalink to this definition"></a></dt>
<dd><p>Runs an additional assemble script if specified in the character configuration.</p>
<spanclass="sig-name descname"><spanclass="pre">source_py_file</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">module</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="_modules/dna_viewer/builder/rig_builder.html#RigBuilder.source_py_file"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#dna_viewer.builder.rig_builder.RigBuilder.source_py_file"title="Permalink to this definition"></a></dt>
<dd><p>Used for loading a python file, used for additional assemble script.</p>