diff options
| author | home_pc <[email protected]> | 2020-01-20 13:48:51 -0800 |
|---|---|---|
| committer | home_pc <[email protected]> | 2020-01-20 13:48:51 -0800 |
| commit | 75fa1d1810e98453960a81115d88302e276d817f (patch) | |
| tree | 92f37accb3cb041d056d00525b5830a69862631a /docs/build/sections | |
| parent | fixed install.mel issue (diff) | |
| download | artv2-75fa1d1810e98453960a81115d88302e276d817f.tar.xz artv2-75fa1d1810e98453960a81115d88302e276d817f.zip | |
Uploading work on refactor
At this point, all components can build their skeletons. Next steps are to get components building their rigs.
Diffstat (limited to 'docs/build/sections')
54 files changed, 16812 insertions, 0 deletions
diff --git a/docs/build/sections/rigging_tools/group_bake_offsets.html b/docs/build/sections/rigging_tools/group_bake_offsets.html new file mode 100644 index 0000000..e1d236d --- /dev/null +++ b/docs/build/sections/rigging_tools/group_bake_offsets.html @@ -0,0 +1,221 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Bake Offsets — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li>Group Bake Offsets</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/sections/rigging_tools/group_bake_offsets.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-bake-offsets"> +<h1>Group Bake Offsets<a class="headerlink" href="#group-bake-offsets" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="section" id="overview"> +<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> +<p>The interface is comprised of three main elements:</p> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../_images/group_bake_offsets.png"><img alt="../../_images/group_bake_offsets.png" src="../../_images/group_bake_offsets.png" style="width: 198px; height: 366px;" /></a> +</div> +<ol class="arabic simple"> +<li>Search bar: filters components in the list by the search term.</li> +<li>Component list: displays components in the scene.</li> +<li>Bake Offsets button: bakes offsets on selected components in the list.</li> +</ol> +</div> +<div class="section" id="usage"> +<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> +<p>To use, select any number of components in the component list. Then hit the “Bake Offsets” button.</p> +<p>Example:</p> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../_images/group_bake_offsets_usage.gif"><img alt="../../_images/group_bake_offsets_usage.gif" src="../../_images/group_bake_offsets_usage.gif" style="width: 519px; height: 383px;" /></a> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/rigging_tools/group_mirror_xforms.html b/docs/build/sections/rigging_tools/group_mirror_xforms.html new file mode 100644 index 0000000..a6b6b4c --- /dev/null +++ b/docs/build/sections/rigging_tools/group_mirror_xforms.html @@ -0,0 +1,224 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Mirror Transformations — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li>Group Mirror Transformations</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/sections/rigging_tools/group_mirror_xforms.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-mirror-transformations"> +<h1>Group Mirror Transformations<a class="headerlink" href="#group-mirror-transformations" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="section" id="overview"> +<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> +<p>The interface is comprised of four main elements:</p> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../_images/group_mirror_xforms.png"><img alt="../../_images/group_mirror_xforms.png" src="../../_images/group_mirror_xforms.png" style="width: 301px; height: 327px;" /></a> +</div> +<ol class="arabic simple"> +<li>left side component list</li> +<li>right side component list (matches with left side mirror)</li> +<li>direction button (which list are you mirrring from and to. Default is left list to right list).</li> +<li>mirror button. Executes mirroring on selected components using the direction specified.</li> +</ol> +</div> +<div class="section" id="usage"> +<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> +<p>To use, select any number of components in the left list. The mirrors of those components will automatically be selected +in the right list. Choose whether you want to mirror from left to right, or right to left by toggling the button in +between the two lists. Finally, hit the Mirror button to complete the operation.</p> +<p>Example:</p> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../_images/group_mirror_xforms_usage.gif"><img alt="../../_images/group_mirror_xforms_usage.gif" src="../../_images/group_mirror_xforms_usage.gif" style="width: 519px; height: 383px;" /></a> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/rigging_tools/pose_manager.html b/docs/build/sections/rigging_tools/pose_manager.html new file mode 100644 index 0000000..d6ac665 --- /dev/null +++ b/docs/build/sections/rigging_tools/pose_manager.html @@ -0,0 +1,238 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Pose Manager — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li>Pose Manager</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/sections/rigging_tools/pose_manager.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="pose-manager"> +<h1>Pose Manager<a class="headerlink" href="#pose-manager" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="section" id="overview"> +<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> +<p>The pose manager is meant for users who may need to repose their model in order to have a better pose for rigging. +For example, in the image below, we have a mesh that is modeled in a pose where the feet are not planted. +This isn’t ideal for rigging and animation.</p> +<img alt="../../_images/pose_manager_model.png" src="../../_images/pose_manager_model.png" /> +<p>Using the pose manager, we can store this “model” pose, and create a new “rig” pose, and freely switch between them. +This way, when we build our deformation skeleton, we’ll build it in the rig pose, so the rotations are nice and clean, +but then we can set it to the model pose, so that the skeleton lines up with the mesh for doing deformations.</p> +<img alt="../../_images/pose_manager_overview.gif" src="../../_images/pose_manager_overview.gif" /> +<p>Right-clicking on a pose will bring up a context menu that allows you to remove the pose.</p> +<img alt="../../_images/pose_manager_remove.png" src="../../_images/pose_manager_remove.png" /> +<p>This diagram shows the workflow intended with the pose manager. In the section below, we’ll go through the process step +by step.</p> +<img alt="../../_images/pose_manager_diagram.png" src="../../_images/pose_manager_diagram.png" /> +</div> +<div class="section" id="usage"> +<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> +<p>Using the above example, we have a mesh that was modeled in a pose like this:</p> +<img alt="../../_images/pose_manager_model.png" src="../../_images/pose_manager_model.png" /> +<p>We place our components in this pose, but we don’t really want to build our rig in this pose, so using the pose manager, +we can store our model pose by opening the interface, and clicking the bottom button to store the pose. Give the pose a +name, like “model”.</p> +<img alt="../../_images/pose_manager_modelpose.gif" src="../../_images/pose_manager_modelpose.gif" /> +<p>Now, let’s re-pose our components so that the legs are straight and the bends in the arms are removed (for example).</p> +<img alt="../../_images/pose_manager_rigpose.png" src="../../_images/pose_manager_rigpose.png" /> +<p>Using the pose manager, we can now store this as a pose. I’ll call it “rig”.</p> +<img alt="../../_images/pose_manager_rigpose.gif" src="../../_images/pose_manager_rigpose.gif" /> +<p>Now, when we build the skeleton, I’ll use the pose manager to set the pose to the rig pose. This way, our skeleton is +built in this pose, which is the pose we want our rig to be built in. By building in this pose, we ensure the +rotation values are clean and zeroed out.</p> +<img alt="../../_images/pose_manager_buildskeleton.gif" src="../../_images/pose_manager_buildskeleton.gif" /> +<p>Now we can use the pose manager to set the pose back to “model”, so our skeleton fits the mesh again, and do our +deformations.</p> +<img alt="../../_images/pose_manager_deform.gif" src="../../_images/pose_manager_deform.gif" /> +<p>When we go to build the rig, we’ll want to set the pose back to the “rig” pose.</p> +</div> +</div> + + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/aim_helper.html b/docs/build/sections/tech_docs/components/aim_helper.html new file mode 100644 index 0000000..eb083d5 --- /dev/null +++ b/docs/build/sections/tech_docs/components/aim_helper.html @@ -0,0 +1,304 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Aim Helper — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Base Classes" href="base_classes.html" /> + <link rel="prev" title="Joint Mover" href="joint_mover.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="components_overview.html">Components Overview</a> »</li> + + <li>Aim Helper</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/aim_helper.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="aim-helper"> +<h1>Aim Helper<a class="headerlink" href="#aim-helper" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.base_components.aim_helper.AimHelper"> +<em class="property">class </em><code class="descname">AimHelper</code><span class="sig-paren">(</span><em>metanode</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper" title="Permalink to this definition">¶</a></dt> +<dd><blockquote> +<div><p>Class that handles toggling aim mode on a component. This class is instantiated on a JointMover object. +Aim mode is a mode that can be toggled that determines whether joints aim at their children when the joint mover +controls are moved or rotated. This setup is done using the joint mover markup tool and setting the attributes it +adds concerning aim mode.</p> +<p>The relevant attributes are:</p> +<blockquote> +<div><ul class="simple"> +<li>Can Aim</li> +<li>Aim Joint</li> +<li>Aim Axis</li> +<li>Invert Aim Axis</li> +<li>Up Axis</li> +<li>Maintain Offset</li> +</ul> +</div></blockquote> +<dl class="glossary docutils"> +</dl> +</div></blockquote> +<p><strong>Can Aim</strong></p> +<blockquote> +<div>Whether this joint should aim at another joint when aim mode is turned on.</div></blockquote> +<p><strong>Aim Joint</strong></p> +<blockquote> +<div>Which joint this joint should aim at when aim mode is turned on. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Aim Axis</strong></p> +<blockquote> +<div>Which axis represents the aim axis. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Invert Aim Axis</strong></p> +<blockquote> +<div>If the aim axis should be inverted. (If your aim axis is set to X, but needs to be -X, this would be True) +(This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Up Axis</strong></p> +<blockquote> +<div>The axis of the joint that is closes to the world up axis. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Maintain Offset</strong></p> +<blockquote> +<div>This will probably not ever need to be used, but in the case of some special circumstance, this will create the +aim constraint while maintaining offsets. +(This is ignored if Can Aim is False)</div></blockquote> +<dl class="method"> +<dt id="artv2.components.base_components.aim_helper.AimHelper.setup_aim_mode"> +<code class="descname">setup_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.setup_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.setup_aim_mode" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets up the aim constraints on the joint mover controls that have aim mode setup.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.aim_helper.AimHelper.tear_down_aim_mode"> +<code class="descname">tear_down_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.tear_down_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.tear_down_aim_mode" title="Permalink to this definition">¶</a></dt> +<dd><p>Removes the aim constraints from the joint mover controls.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.aim_helper.AimHelper.toggle_aim_mode"> +<code class="descname">toggle_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.toggle_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.toggle_aim_mode" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles aim mode on a component. Aim mode determines whether joints aim at their children when the joint +mover controls are moved or rotated. Which joints and their settings are setup using the joint mover markup +tool.</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="base_classes.html" class="btn btn-neutral float-right" title="Base Classes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="joint_mover.html" class="btn btn-neutral float-left" title="Joint Mover" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/arm_component.html b/docs/build/sections/tech_docs/components/arm_component.html new file mode 100644 index 0000000..6a6a62a --- /dev/null +++ b/docs/build/sections/tech_docs/components/arm_component.html @@ -0,0 +1,300 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Arm Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Finger Component" href="finger.html" /> + <link rel="prev" title="Spine Component" href="spine.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Arm Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/arm_component.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="arm-component"> +<h1>Arm Component<a class="headerlink" href="#arm-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.arm.Arm"> +<em class="property">class </em><code class="descname">Arm</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/arm.html#Arm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.arm.Arm" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class is define and creates the arm component. The arm component consists of at minimum, 3 joints: +the shoulder, elbow, and wrist. There are also options for 3 twist joints in the upper and lower arm areas.</p> +<dl class="attribute"> +<dt id="artv2.components.arm.Arm.num_lowerarm_twists"> +<code class="descname">num_lowerarm_twists</code><a class="headerlink" href="#artv2.components.arm.Arm.num_lowerarm_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of lowerarm twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">arm_inst</span> <span class="o">=</span> <span class="n">arm</span><span class="o">.</span><span class="n">Arm</span><span class="p">()</span> +<span class="n">arm_inst</span><span class="o">.</span><span class="n">num_lowerarm_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of lowerarm twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.arm.Arm.num_upperarm_twists"> +<code class="descname">num_upperarm_twists</code><a class="headerlink" href="#artv2.components.arm.Arm.num_upperarm_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of upperarm twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">arm_inst</span> <span class="o">=</span> <span class="n">arm</span><span class="o">.</span><span class="n">Arm</span><span class="p">()</span> +<span class="n">arm_inst</span><span class="o">.</span><span class="n">num_upperarm_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of upperarm twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finger.html" class="btn btn-neutral float-right" title="Finger Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="spine.html" class="btn btn-neutral float-left" title="Spine Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/base_classes.html b/docs/build/sections/tech_docs/components/base_classes.html new file mode 100644 index 0000000..955db2c --- /dev/null +++ b/docs/build/sections/tech_docs/components/base_classes.html @@ -0,0 +1,247 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Base Classes — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Component Base Class" href="component_base.html" /> + <link rel="prev" title="Aim Helper" href="aim_helper.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Base Classes</a><ul> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li>Base Classes</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/base_classes.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="base-classes"> +<h1>Base Classes<a class="headerlink" href="#base-classes" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l1"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l1"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l1"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l1"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="component_base.html" class="btn btn-neutral float-right" title="Component Base Class" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="aim_helper.html" class="btn btn-neutral float-left" title="Aim Helper" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/biped_leg_component.html b/docs/build/sections/tech_docs/components/biped_leg_component.html new file mode 100644 index 0000000..a639182 --- /dev/null +++ b/docs/build/sections/tech_docs/components/biped_leg_component.html @@ -0,0 +1,323 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Bipedal Leg Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Hind Leg Component" href="hind_leg.html" /> + <link rel="prev" title="Finger Component" href="finger.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Bipedal Leg Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/biped_leg_component.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="bipedal-leg-component"> +<h1>Bipedal Leg Component<a class="headerlink" href="#bipedal-leg-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.biped_leg.BipedLeg"> +<em class="property">class </em><code class="descname">BipedLeg</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/biped_leg.html#BipedLeg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.biped_leg.BipedLeg" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class defines and creates a bipedal leg component. The biped leg component consists of at +minimum, 4 joints: the thigh, calf, foot, and ball. There are also options for 3 twist joints in the upper and +lower leg areas as well as having a ball and toe joint (which it does by default).</p> +<dl class="attribute"> +<dt id="artv2.components.biped_leg.BipedLeg.has_ball_joint"> +<code class="descname">has_ball_joint</code><a class="headerlink" href="#artv2.components.biped_leg.BipedLeg.has_ball_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds a boolean value on whether or not a ball joint will be included in the setup.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">biped_leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">has_ball_joint</span> <span class="o">=</span> <span class="bp">False</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">bool</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.biped_leg.BipedLeg.num_calf_twists"> +<code class="descname">num_calf_twists</code><a class="headerlink" href="#artv2.components.biped_leg.BipedLeg.num_calf_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of calf twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">biped_leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">num_calf_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of calf twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.biped_leg.BipedLeg.num_thigh_twists"> +<code class="descname">num_thigh_twists</code><a class="headerlink" href="#artv2.components.biped_leg.BipedLeg.num_thigh_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of thigh twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">biped_leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">num_thigh_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of thigh twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="hind_leg.html" class="btn btn-neutral float-right" title="Hind Leg Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finger.html" class="btn btn-neutral float-left" title="Finger Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/camera.html b/docs/build/sections/tech_docs/components/camera.html new file mode 100644 index 0000000..756e765 --- /dev/null +++ b/docs/build/sections/tech_docs/components/camera.html @@ -0,0 +1,252 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Camera Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Creating Your Own Component" href="creating_custom_component.html" /> + <link rel="prev" title="Hinge Component" href="hinge.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Camera Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/camera.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="camera-component"> +<h1>Camera Component<a class="headerlink" href="#camera-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.camera.Camera"> +<em class="property">class </em><code class="descname">Camera</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/camera.html#Camera"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.camera.Camera" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class creates a camera component, which is a unique component meant for animating a game camera. +The camera component creates 3 joints: a camera root, a camera joint, and an aim joint.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="creating_custom_component.html" class="btn btn-neutral float-right" title="Creating Your Own Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hinge.html" class="btn btn-neutral float-left" title="Hinge Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/chain.html b/docs/build/sections/tech_docs/components/chain.html new file mode 100644 index 0000000..33309ae --- /dev/null +++ b/docs/build/sections/tech_docs/components/chain.html @@ -0,0 +1,273 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Chain Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Segment Component" href="segment.html" /> + <link rel="prev" title="Joint Component" href="joint.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Chain Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/chain.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="chain-component"> +<h1>Chain Component<a class="headerlink" href="#chain-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.chain.Chain"> +<em class="property">class </em><code class="descname">Chain</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/chain.html#Chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.chain.Chain" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class defines and creates the chain component, for creating a chain with 3 to 99 joints.</p> +<dl class="attribute"> +<dt id="artv2.components.chain.Chain.num_joints"> +<code class="descname">num_joints</code><a class="headerlink" href="#artv2.components.chain.Chain.num_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Property for defining/returning the number of chain joints</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">chain_inst</span> <span class="o">=</span> <span class="n">chain</span><span class="o">.</span><span class="n">Chain</span><span class="p">()</span> +<span class="n">chain_inst</span><span class="o">.</span><span class="n">num_joints</span> <span class="o">=</span> <span class="mi">10</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(int) number of chain joints.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="segment.html" class="btn btn-neutral float-right" title="Segment Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="joint.html" class="btn btn-neutral float-left" title="Joint Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/component_base.html b/docs/build/sections/tech_docs/components/component_base.html new file mode 100644 index 0000000..5ffe6d1 --- /dev/null +++ b/docs/build/sections/tech_docs/components/component_base.html @@ -0,0 +1,577 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Component Base Class — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Pose" href="pose.html" /> + <link rel="prev" title="Base Classes" href="base_classes.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="base_classes.html">Base Classes</a> »</li> + + <li>Component Base Class</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/component_base.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="component-base-class"> +<h1>Component Base Class<a class="headerlink" href="#component-base-class" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.base_components.base_component.ART_Component"> +<em class="property">class </em><code class="descname">ART_Component</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component" title="Permalink to this definition">¶</a></dt> +<dd><p>Base class for defining a component (arm, leg, torso, single joint, etc) in ARTv2. All components should inherit +from this class.</p> +<p>When creating a new component, here is a list of common attributes and functions you will want or need to override.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="11%" /> +<col width="21%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Type</th> +<th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>attribute</td> +<td>nice_name</td> +<td>(string) The nice name of the component (as it will appear in UIs)</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>category</td> +<td>(string) The name of the category where this component will show up in the +user interface. For example: “Limbs”, “Primitives”, etc.</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>base_name</td> +<td>The string base name of the component. This is a simple string used to +identify the component type and append onto nodes created by the component. +For example, on a leg component, the base_name is simply: “leg”</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>has_sides</td> +<td>Bool for whether or not the component supports different sides,like a leg +or arm do.</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>can_overwrite_names</td> +<td>Bool for whether or not the user can overwrite the names of the joints of +this component.</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>joint_mover_file</td> +<td>The relative path from the ARTv2 directory to the joint mover file of the +component. For example, self.joint_mover_file = +“resources/rigging_guides/root.ma”</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>mirror_table</td> +<td>A dictionary of translate and rotate attributes with their multiplier for +mirroring values to mirrored controls.</td> +</tr> +<tr class="row-odd"><td>function</td> +<td>_add_metadata</td> +<td>This method adds attributes you want to keep track of that are unique to +your component. Make sure that you still call on the base class’s +_add_metadata method to setup the required attributes.</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.change_num_joints"> +<code class="descname">change_num_joints</code><span class="sig-paren">(</span><em>joints</em>, <em>offset_movers</em>, <em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.change_num_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.change_num_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets the build state (whether or not they will be created) of the given joints to the given state.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>joints</strong> – List of PyNode joints to toggle build state on</li> +<li><strong>offset_movers</strong> – List of PyNode offset movers to toggle visibility on.</li> +<li><strong>state</strong> – The build state to set.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.copy_settings"> +<code class="descname">copy_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.copy_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.copy_settings" title="Permalink to this definition">¶</a></dt> +<dd><p>Copies the values of the class properties (things like number of twist joints, etc) and writes them to a temp +file.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.create_mirror"> +<code class="descname">create_mirror</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.create_mirror"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.create_mirror" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a mirror of the component, then mirrors its transformations.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>prefix</strong> (<em>str</em>) – prefix to give the created mirrored component.</li> +<li><strong>suffix</strong> (<em>str</em>) – suffix to give the created mirrored component.</li> +<li><strong>parent</strong> (<em>str</em>) – parent joint for the created mirrored component.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Instance of the mirrored component</p> +</td> +</tr> +</tbody> +</table> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span> +<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">mirror</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">create_mirror</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"r"</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="s2">"root"</span><span class="p">)</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.delete"> +<code class="descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.delete" title="Permalink to this definition">¶</a></dt> +<dd><p>Deletes the component from the scene.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span> +<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">leg</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.duplicate"> +<code class="descname">duplicate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.duplicate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.duplicate" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a duplicate instance of self, with the same settings, parent, and transforms. A unique trailing suffix +is appended to prevent naming issues.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span> +<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">leg</span><span class="o">.</span><span class="n">duplicate</span><span class="p">()</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.paste_settings"> +<code class="descname">paste_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.paste_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.paste_settings" title="Permalink to this definition">¶</a></dt> +<dd><p>Retrieves values from the temp file (if it exists) and sets any properties of the class matching those stored in +the temp file, to those values.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.rename_joint"> +<code class="descname">rename_joint</code><span class="sig-paren">(</span><em>new_name</em>, <em>old_name</em>, <em>offset_mover</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.rename_joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.rename_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>Renames a joint that the component creates. The component’s prefix and suffix will be maintained. +For example, if the component has a prefix of “_l”, and it will create a joint named foot, the user can rename +foot to ankle, and the new name will be l_ankle.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>new_name</strong> (<em>str</em>) – The new name of the joint</li> +<li><strong>old_name</strong> (<em>str</em>) – The old name of the joint</li> +<li><strong>offset_mover</strong> – The offset mover (PyNode) for the joint</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span> +<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">data</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">get_joint_labels</span><span class="p">(</span><span class="n">leg</span><span class="o">.</span><span class="n">network_node</span><span class="p">)</span> +<span class="n">leg</span><span class="o">.</span><span class="n">rename_joint</span><span class="p">(</span><span class="s2">"ankle"</span><span class="p">,</span> <span class="s2">"foot"</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"foot"</span><span class="p">)[</span><span class="mi">2</span><span class="p">])</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.reset_settings"> +<code class="descname">reset_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.reset_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.reset_settings" title="Permalink to this definition">¶</a></dt> +<dd><p>Resets all values of the class properties to the default they had at creation.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.set_mirror"> +<code class="descname">set_mirror</code><span class="sig-paren">(</span><em>mirror_metanode</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_mirror"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_mirror" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets the mirror component if the passed in mirror component is of the same class type.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mirror_metanode</strong> – The network node for the mirror component to be set.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.set_side"> +<code class="descname">set_side</code><span class="sig-paren">(</span><em>new_side</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_side"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_side" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets the side of a component if that components supports setting sides. Setting a side from left to right, for +example, will change the local rotation axis to be mirrored on the joints.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>new_side</strong> – This can be any of the following: “left”, “Left”, “right”, “Right”, 0, 1</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.base_component.ART_Component.set_twist_joints"> +<code class="descname">set_twist_joints</code><span class="sig-paren">(</span><em>attr</em>, <em>new_number</em>, <em>attr_min</em>, <em>attr_max</em>, <em>keyword</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_twist_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_twist_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Base logic for setting number of twist joints via properties in components like arm, leg.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>attr</strong> – the property name</li> +<li><strong>new_number</strong> – The new value to set the property to</li> +<li><strong>attr_min</strong> – The minimum value of allowable values</li> +<li><strong>attr_max</strong> – The maximum value of allowable values</li> +<li><strong>keyword</strong> – The keyword to search mover nodes for</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.base_components.base_component.ART_Component.network_node"> +<code class="descname">network_node</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.network_node" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the network node that contains this component’s metadata.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.base_components.base_component.ART_Component.parent"> +<code class="descname">parent</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.parent" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the joint name of the parent of this component.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.base_components.base_component.ART_Component.prefix"> +<code class="descname">prefix</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.prefix" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the component’s prefix (optional)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s prefix.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.base_components.base_component.ART_Component.suffix"> +<code class="descname">suffix</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.suffix" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the component’s suffix (optional)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s suffix.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<div class="section" id="properties"> +<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2> +<dl class="attribute"> +<dt id="prefix"> +<code class="descname">prefix</code><a class="headerlink" href="#prefix" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the component’s prefix (optional)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s prefix.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="suffix"> +<code class="descname">suffix</code><a class="headerlink" href="#suffix" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the component’s suffix (optional)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s suffix.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="parent"> +<code class="descname">parent</code><a class="headerlink" href="#parent" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the joint name of the parent of this component.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="network_node"> +<code class="descname">network_node</code><a class="headerlink" href="#network_node" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the network node that contains this module’s metadata.</p> +</dd></dl> + +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pose.html" class="btn btn-neutral float-right" title="Pose" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="base_classes.html" class="btn btn-neutral float-left" title="Base Classes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/component_classes.html b/docs/build/sections/tech_docs/components/component_classes.html new file mode 100644 index 0000000..07a9964 --- /dev/null +++ b/docs/build/sections/tech_docs/components/component_classes.html @@ -0,0 +1,257 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Component Classes — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Root Component" href="root_component.html" /> + <link rel="prev" title="Template" href="template.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Component Classes</a><ul> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li>Component Classes</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/component_classes.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="component-classes"> +<h1>Component Classes<a class="headerlink" href="#component-classes" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l1"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="root_component.html" class="btn btn-neutral float-right" title="Root Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="template.html" class="btn btn-neutral float-left" title="Template" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/components.html b/docs/build/sections/tech_docs/components/components.html new file mode 100644 index 0000000..bdb4f4b --- /dev/null +++ b/docs/build/sections/tech_docs/components/components.html @@ -0,0 +1,234 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Components — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Components Overview" href="components_overview.html" /> + <link rel="prev" title="Useful Scripting Commands" href="../useful_scripting_commands.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Components</a><ul> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li>Components</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/components.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="components"> +<h1>Components<a class="headerlink" href="#components" title="Permalink to this headline">¶</a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l1"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l1"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="components_overview.html" class="btn btn-neutral float-right" title="Components Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../useful_scripting_commands.html" class="btn btn-neutral float-left" title="Useful Scripting Commands" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/components_overview.html b/docs/build/sections/tech_docs/components/components_overview.html new file mode 100644 index 0000000..24eae36 --- /dev/null +++ b/docs/build/sections/tech_docs/components/components_overview.html @@ -0,0 +1,274 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Components Overview — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Assets" href="rig_asset.html" /> + <link rel="prev" title="Components" href="components.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Components Overview</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#terminology">Terminology</a></li> +<li class="toctree-l4"><a class="reference internal" href="#class-diagram">Class Diagram</a></li> +<li class="toctree-l4"><a class="reference internal" href="#classes-associated-with-components">Classes Associated with Components</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li>Components Overview</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/components_overview.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="components-overview"> +<h1>Components Overview<a class="headerlink" href="#components-overview" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<div class="section" id="terminology"> +<h2>Terminology<a class="headerlink" href="#terminology" title="Permalink to this headline">¶</a></h2> +<dl class="glossary docutils"> +<dt id="term-asset">asset</dt> +<dd>An asset is the totality of all of the parts that make up the rig. In terms of a character, an asset would be +the encapsulation of the components that make up the character, as well as metadata defining the character, +like its name, etc.</dd> +<dt id="term-component">component</dt> +<dd>Components are the individual parts that make up an asset. Components are things like, a leg, an arm, a torso, +etc.</dd> +<dt id="term-metanode">metanode</dt> +<dd><p class="first">Each component (and asset) has a metanode, which is a Maya network node that stores metadata. The most basic +metadata are things like the prefix, suffix, full name of the module, and many more useful bits of information.</p> +<img alt="../../../_images/metanode.png" class="last" src="../../../_images/metanode.png" /> +</dd> +<dt id="term-joint-mover">joint mover</dt> +<dd>A joint mover is a simple rig attached to a component that aids in the creation of the skeleton. It makes joint +placement clean and consistent across all components.</dd> +<dt id="term-aim-helper">aim helper</dt> +<dd>A component that handles ensuring a parent joint aims at its child for the joint mover controls. +Aim constraints are placed on joints in the joint mover that have been marked up to aim at their child. +Those same constraints are removed if aim mode is toggled off. How aim mode is setup is done through the +<a class="reference internal" href="creating_custom_component.html#joint-mover-markup-ref"><span class="std std-ref">joint mover markup tool</span></a>.</dd> +</dl> +</div> +<div class="section" id="class-diagram"> +<h2>Class Diagram<a class="headerlink" href="#class-diagram" title="Permalink to this headline">¶</a></h2> +<img alt="../../../_images/artv2_class_diagram.png" src="../../../_images/artv2_class_diagram.png" /> +</div> +<div class="section" id="classes-associated-with-components"> +<h2>Classes Associated with Components<a class="headerlink" href="#classes-associated-with-components" title="Permalink to this headline">¶</a></h2> +<p>The following classes are used by or associated with the component classes.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l1"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +</ul> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="rig_asset.html" class="btn btn-neutral float-right" title="Assets" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="components.html" class="btn btn-neutral float-left" title="Components" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/creating_custom_component.html b/docs/build/sections/tech_docs/components/creating_custom_component.html new file mode 100644 index 0000000..3a724e0 --- /dev/null +++ b/docs/build/sections/tech_docs/components/creating_custom_component.html @@ -0,0 +1,442 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Creating Your Own Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Utilities" href="../utilities/utilities.html" /> + <link rel="prev" title="Camera Component" href="camera.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Creating Your Own Component</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#creating-the-maya-file">Creating the Maya File</a></li> +<li class="toctree-l4"><a class="reference internal" href="#joint-mover-markup-tool">Joint Mover Markup Tool</a></li> +<li class="toctree-l4"><a class="reference internal" href="#creating-the-python-class">Creating the Python Class</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li>Creating Your Own Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/creating_custom_component.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="creating-your-own-component"> +<h1>Creating Your Own Component<a class="headerlink" href="#creating-your-own-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<p>In order to create your own component, there are two things you need: a python file for the class, and a maya ascii +file that defines the joints that component can create.</p> +<div class="section" id="creating-the-maya-file"> +<h2>Creating the Maya File<a class="headerlink" href="#creating-the-maya-file" title="Permalink to this headline">¶</a></h2> +<p>This file is generally referred to as the ‘joint mover file’. In a new Maya scene, simply create the joints you want +your component to create. If your component has options like number of twist joints, create the maximum configuration +in this Maya scene. The exception to this are components where we want to insert joints into the hierarchy, like the +chain and spine components. With these types of components, I create the minimum configuration. Let’s compare what the +joint mover files for a biped leg and a chain look like:</p> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/joint_mover_compare.png"><img alt="../../../_images/joint_mover_compare.png" src="../../../_images/joint_mover_compare.png" style="width: 404px; height: 256px;" /></a> +</div> +<p>As you can see, the leg has the maximum configuration and the spine has the minimum configuration. How those +configurations change is defined in the properties of the python class. You’ll also notice that some default names +have been given to each joint. +In the leg, for example, I don’t want the twist joints to be available by default (their property will be set to 0), +so I will hide those joints.</p> +<p>Let’s build a component as a demonstration. In a new Maya scene, I will create a basic hinge setup for an arm and name +the joints shoulder, elbow, and wrist. Make sure the rotations are frozen and the joint orients are clean.</p> +<img alt="../../../_images/joint_mover_demo_01.png" src="../../../_images/joint_mover_demo_01.png" /> +<p>Now, I will add three twist joints to the shoulder, naming them shoulder_twist_01, shoulder_twist_02, and +shoulder_twist_03. These are parented under the shoulder. Because I don’t want them to be there by default, I will +hide them.</p> +<img alt="../../../_images/joint_mover_demo_01.gif" src="../../../_images/joint_mover_demo_01.gif" /> +<p>The last thing we need to do with the maya scene is markup these joints with some attributes for how the joint mover +rig will be created.</p> +</div> +<div class="section" id="joint-mover-markup-tool"> +<span id="joint-mover-markup-ref"></span><h2>Joint Mover Markup Tool<a class="headerlink" href="#joint-mover-markup-tool" title="Permalink to this headline">¶</a></h2> +<p>Under the ART v2 menu, in the Development sub-menu, click on the Joint Mover Markup menu item.</p> +<img alt="../../../_images/joint_mover_markup_01.png" src="../../../_images/joint_mover_markup_01.png" /> +<p>Once the interface is displayed, clicking on ‘Markup Joints’ will put attributes on all of the joints in the scene. +Let’s talk about each of these attributes and what they do.</p> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/joint_mover_markup_02.png"><img alt="../../../_images/joint_mover_markup_02.png" src="../../../_images/joint_mover_markup_02.png" style="width: 263px; height: 348px;" /></a> +<p class="caption"><span class="caption-text">The markup attributes that were created can be seen here.</span></p> +</div> +<dl class="glossary docutils"> +<dt id="term-can-aim">Can Aim</dt> +<dd>Whether this joint should aim at another joint when aim mode is turned on.</dd> +<dt id="term-aim-joint">Aim Joint</dt> +<dd>Which joint this joint should aim at when aim mode is turned on. (This is ignored if Can Aim is False)</dd> +<dt id="term-aim-axis">Aim Axis</dt> +<dd>Which axis represents the aim axis. (This is ignored if Can Aim is False)</dd> +<dt id="term-invert-aim-axis">Invert Aim Axis</dt> +<dd>If the aim axis should be inverted. (If your aim axis is set to X, but needs to be -X, this would be True) +(This is ignored if Can Aim is False)</dd> +<dt id="term-up-axis">Up Axis</dt> +<dd>The axis of the joint that is closes to the world up axis. (This is ignored if Can Aim is False)</dd> +<dt id="term-maintain-offset">Maintain Offset</dt> +<dd>This will probably not ever need to be used, but in the case of some special circumstance, this will create the +aim constraint while maintaining offsets. +(This is ignored if Can Aim is False)</dd> +<dt id="term-twist-joint">Twist Joint</dt> +<dd>Whether the joint is to be setup as a twist joint. A twist joint gets no global mover control. Instead it +gets an offset mover that is only unlocked along the length axis, and is automatically driven to keep equal +spacing between the start joint and end joint (calf and foot for example).</dd> +<dt id="term-control-type">Control Type</dt> +<dd>The shape that the joint mover control should have. This list is populated by the files located in +/resources/control_shapes.</dd> +<dt id="term-control-size">Control Size</dt> +<dd>The scale factor to create the control at. If you use the “Create Preview Movers” button in the markup tool, +you can then set this value in order to see how the control will be built and at what size.</dd> +<dt id="term-control-offset-x-y-z">Control Offset X, Y, Z</dt> +<dd>When creating the control, the rotational offset to apply on creation. You can use the “Create Preview Movers” +button to see how the control will be created given your offsets.</dd> +</dl> +<p>So in this case, let’s set shoulder and elbow’s “.canAim” to True, then set the shoulder’s aim joint to elbow, and the +elbow’s to wrist. The up axis for both of those will be Z. I’ll set all three of those joints to use a circle shape and +set the size to 10. For the three twist joints, set their “.twistJoint” attribute to True, and let’s put their control +size at 8. You can use the “Create Preview Movers” and “Delete Preview Movers” to see how your controls will be created +given these settings.</p> +<div class="align-center figure" id="id2"> +<a class="reference internal image-reference" href="../../../_images/joint_mover_markup_03.png"><img alt="../../../_images/joint_mover_markup_03.png" src="../../../_images/joint_mover_markup_03.png" style="width: 265px; height: 348px;" /></a> +<p class="caption"><span class="caption-text">The shoulder with markup data set.</span></p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Create Preview Movers works on a selection!</p> +</div> +<p>Make sure any preview movers have been deleted using the “Delete Preview Movers” and save the scene in: +ARTv2/resources/rigging_guides as a maya ascii file.</p> +</div> +<div class="section" id="creating-the-python-class"> +<h2>Creating the Python Class<a class="headerlink" href="#creating-the-python-class" title="Permalink to this headline">¶</a></h2> +<p>Create a new python file in artv2/components. In this file, add an import for the base component:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">artv2.components.base_components.base_component</span> <span class="kn">as</span> <span class="nn">base</span> +</pre></div> +</div> +<p>Now create your class and inherit from base. There are some attributes you need to add to the class (above any +constructor) and fill out their values. These are the attributes and what they do:</p> +<blockquote> +<div><table border="1" class="docutils"> +<colgroup> +<col width="11%" /> +<col width="21%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Type</th> +<th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>attribute</td> +<td>nice_name</td> +<td>(string) The nice name of the component (as it will appear in UIs)</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>category</td> +<td>(string) The name of the category where this component will show up in the +user interface. For example: “Limbs”, “Primitives”, etc.</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>base_name</td> +<td>The string base name of the component. This is a simple string used to +identify the component type and append onto nodes created by the component. +For example, on a leg component, the base_name is simply: “leg”</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>has_sides</td> +<td>Bool for whether or not the component supports different sides,like a leg +or arm do.</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>can_overwrite_names</td> +<td>Bool for whether or not the user can overwrite the names of the joints of +this component.</td> +</tr> +<tr class="row-odd"><td>attribute</td> +<td>joint_mover_file</td> +<td>The relative path from the ARTv2 directory to the joint mover file of the +component. For example, self.joint_mover_file = +“resources/rigging_guides/root.ma”</td> +</tr> +<tr class="row-even"><td>attribute</td> +<td>mirror_table</td> +<td>A dictionary of translate and rotate attributes with their multiplier for +mirroring values to mirrored controls.</td> +</tr> +</tbody> +</table> +</div></blockquote> +<p>At this point, your class should look something like this:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">artv2.components.base_components.base_component</span> <span class="kn">as</span> <span class="nn">base</span> + +<span class="k">class</span> <span class="nc">MyComponent</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">ART_Component</span><span class="p">):</span> + + <span class="n">nice_name</span> <span class="o">=</span> <span class="s2">"Test"</span> + <span class="n">category</span> <span class="o">=</span> <span class="s2">"Primitives"</span> + <span class="n">base_name</span> <span class="o">=</span> <span class="s2">"test"</span> + <span class="n">has_sides</span> <span class="o">=</span> <span class="bp">True</span> + <span class="n">can_overwrite_names</span> <span class="o">=</span> <span class="bp">True</span> + <span class="n">joint_mover_file</span> <span class="o">=</span> <span class="s2">"resources</span><span class="se">\\</span><span class="s2">rigging_guides</span><span class="se">\\</span><span class="s2">test.ma"</span> + <span class="n">mirror_table</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"translateX"</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"translateY"</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"translateZ"</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"rotateX"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"rotateY"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"rotateZ"</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span> +</pre></div> +</div> +<p>Usually, you will not need to implement an __init__ method, since the base class should take care of anything you need +there, but if not, you would want to implement that, and make sure you call on the base class’s constructor as well.</p> +<p>The main method you need to implement is _add_metadata. This method adds attributes to the network node of the component +that coincide with properties on the class. For example, in our test, we had three twist joints, so I could add a +property called num_twist_joints. There are already some methods in the base class that will help with the property +setter implementation ( we’ll go over that in a minute). Because we will be adding this property, we also want to add +an attribute on the network node for num_twist_joints. So in this example, here is what our _add_metadata method would +look like:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">_add_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">network_node</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span> + + <span class="c1"># call on the base class's method to get the default attributes first, then unlock the network node and add our</span> + <span class="c1"># own. Remember to re-lock the network node after!</span> + <span class="nb">super</span><span class="p">(</span><span class="n">MyComponent</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_add_metadata</span><span class="p">(</span><span class="n">network_node</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span> + + <span class="n">network_node</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span> + + <span class="c1"># notice how the minimum and maximum are set to match our configuration on the maya file. Since our twist joints</span> + <span class="c1"># are hidden by default, the default value is 0.</span> + <span class="n">network_node</span><span class="o">.</span><span class="n">addAttr</span><span class="p">(</span><span class="s2">"num_twist_joints"</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="nb">max</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">dv</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">keyable</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span> + <span class="n">network_node</span><span class="o">.</span><span class="n">num_upperarm_twists</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">lock</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> + + <span class="n">network_node</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span> +</pre></div> +</div> +<p>Now let’s define that property that coincides with our attribute.</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@property</span> +<span class="k">def</span> <span class="nf">num_twist_joints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + + <span class="c1"># the getter of our property will just read the value on the network node of the same attribute!</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">network_node</span><span class="o">.</span><span class="n">num_twist_joints</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> +</pre></div> +</div> +<p>Our property setter is where the implementation of any configuration changes happens. The base class already has a +method for dealing with this situation, so our setter is pretty simple here:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@num_upperarm_twists.setter</span> +<span class="k">def</span> <span class="nf">num_upperarm_twists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_number</span><span class="p">):</span> + <span class="c1"># here we pass in the attribute, the new number, the min and max, and a keyword to search for on the joints.</span> + <span class="c1"># because our joints are named shoulder_twist_01, etc, we can pass in the key _shoulder_twist_0 to find any</span> + <span class="c1"># relevant twist joints.</span> + <span class="bp">self</span><span class="o">.</span><span class="n">set_twist_joints</span><span class="p">(</span><span class="s2">"num_twist_joints"</span><span class="p">,</span> <span class="n">new_number</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">"_shoulder_twist_0"</span><span class="p">)</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">To see a more complex implementation of a property setter, check out the chain component’s num_joints +property.</p> +</div> +<p>At this point, you should be able to reload the scripts (or restart Maya) and your component should be in the UI, and +properly load into the scene, creating a joint mover rig, and a widget for changing your properties.</p> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../utilities/utilities.html" class="btn btn-neutral float-right" title="Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="camera.html" class="btn btn-neutral float-left" title="Camera Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/finger.html b/docs/build/sections/tech_docs/components/finger.html new file mode 100644 index 0000000..e9cd389 --- /dev/null +++ b/docs/build/sections/tech_docs/components/finger.html @@ -0,0 +1,251 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Finger Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Bipedal Leg Component" href="biped_leg_component.html" /> + <link rel="prev" title="Arm Component" href="arm_component.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Finger Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/finger.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="finger-component"> +<h1>Finger Component<a class="headerlink" href="#finger-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.finger.Finger"> +<em class="property">class </em><code class="descname">Finger</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/finger.html#Finger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.finger.Finger" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class creates and defines the finger component, which by default, will create 4 joints.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="biped_leg_component.html" class="btn btn-neutral float-right" title="Bipedal Leg Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="arm_component.html" class="btn btn-neutral float-left" title="Arm Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/hind_leg.html b/docs/build/sections/tech_docs/components/hind_leg.html new file mode 100644 index 0000000..3a48e21 --- /dev/null +++ b/docs/build/sections/tech_docs/components/hind_leg.html @@ -0,0 +1,323 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Hind Leg Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Joint Component" href="joint.html" /> + <link rel="prev" title="Bipedal Leg Component" href="biped_leg_component.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Hind Leg Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/hind_leg.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="hind-leg-component"> +<h1>Hind Leg Component<a class="headerlink" href="#hind-leg-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.hind_leg.HindLeg"> +<em class="property">class </em><code class="descname">HindLeg</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/hind_leg.html#HindLeg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.hind_leg.HindLeg" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="biped_leg_component.html#artv2.components.biped_leg.BipedLeg" title="artv2.components.biped_leg.BipedLeg"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.biped_leg.BipedLeg</span></code></a></p> +<p>This class defines and creates the hind leg component. The hind leg creates at a minimum, +4 joints: thigh, calf, heel, foot. There are options for 3 twist joints in the upper and lower leg areas as well as +ball and toe joints. The ball and toe and there by default.</p> +<dl class="attribute"> +<dt id="artv2.components.hind_leg.HindLeg.has_ball_joint"> +<code class="descname">has_ball_joint</code><a class="headerlink" href="#artv2.components.hind_leg.HindLeg.has_ball_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds a boolean value on whether or not a ball joint will be included in the setup.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">hind_leg</span><span class="o">.</span><span class="n">HindLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">has_ball_joint</span> <span class="o">=</span> <span class="bp">False</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">bool</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.hind_leg.HindLeg.num_calf_twists"> +<code class="descname">num_calf_twists</code><a class="headerlink" href="#artv2.components.hind_leg.HindLeg.num_calf_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of calf twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">hind_leg</span><span class="o">.</span><span class="n">HindLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">num_calf_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of calf twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.hind_leg.HindLeg.num_thigh_twists"> +<code class="descname">num_thigh_twists</code><a class="headerlink" href="#artv2.components.hind_leg.HindLeg.num_thigh_twists" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the number (int) of thigh twist joints that the module will create or has.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">leg_inst</span> <span class="o">=</span> <span class="n">hind_leg</span><span class="o">.</span><span class="n">HindLeg</span><span class="p">()</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">num_thigh_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of thigh twist joints the module has.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="joint.html" class="btn btn-neutral float-right" title="Joint Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="biped_leg_component.html" class="btn btn-neutral float-left" title="Bipedal Leg Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/hinge.html b/docs/build/sections/tech_docs/components/hinge.html new file mode 100644 index 0000000..4289c39 --- /dev/null +++ b/docs/build/sections/tech_docs/components/hinge.html @@ -0,0 +1,251 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Hinge Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Camera Component" href="camera.html" /> + <link rel="prev" title="Segment Component" href="segment.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Hinge Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/hinge.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="hinge-component"> +<h1>Hinge Component<a class="headerlink" href="#hinge-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.hinge.Hinge"> +<em class="property">class </em><code class="descname">Hinge</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/hinge.html#Hinge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.hinge.Hinge" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class defines and creates the hinge component. The hinge component creates 3 joints for a basic hinge.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="camera.html" class="btn btn-neutral float-right" title="Camera Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="segment.html" class="btn btn-neutral float-left" title="Segment Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/joint.html b/docs/build/sections/tech_docs/components/joint.html new file mode 100644 index 0000000..1722e54 --- /dev/null +++ b/docs/build/sections/tech_docs/components/joint.html @@ -0,0 +1,252 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Joint Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Chain Component" href="chain.html" /> + <link rel="prev" title="Hind Leg Component" href="hind_leg.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Joint Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/joint.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="joint-component"> +<h1>Joint Component<a class="headerlink" href="#joint-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.joint.Joint"> +<em class="property">class </em><code class="descname">Joint</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/joint.html#Joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.joint.Joint" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class defines and creates the joint component. Just a simple joint you can use for things like +packs, pouches, or a clavicle. Wherever you may need a simple joint.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="chain.html" class="btn btn-neutral float-right" title="Chain Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hind_leg.html" class="btn btn-neutral float-left" title="Hind Leg Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/joint_mover.html b/docs/build/sections/tech_docs/components/joint_mover.html new file mode 100644 index 0000000..8233819 --- /dev/null +++ b/docs/build/sections/tech_docs/components/joint_mover.html @@ -0,0 +1,545 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Joint Mover — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Aim Helper" href="aim_helper.html" /> + <link rel="prev" title="Assets" href="rig_asset.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="components_overview.html">Components Overview</a> »</li> + + <li>Joint Mover</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/joint_mover.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="joint-mover"> +<h1>Joint Mover<a class="headerlink" href="#joint-mover" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.base_components.joint_mover.JointMover"> +<em class="property">class </em><code class="descname">JointMover</code><span class="sig-paren">(</span><em>path</em>, <em>metanode</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover" title="Permalink to this definition">¶</a></dt> +<dd><p>Class for creating and working with a joint mover rig, which is a simplified rig used to aid in the creation and +placement of a skeleton, keeping it clean and consistent. The JointMover is instantiated by a component and is +passed that component’s network_node.</p> +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.add_joint_mover"> +<code class="descname">add_joint_mover</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.add_joint_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.add_joint_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Adds the joint mover maya ascii file to the maya scene.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.bake_offsets"> +<code class="descname">bake_offsets</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.bake_offsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.bake_offsets" title="Permalink to this definition">¶</a></dt> +<dd><p>Ensures that the global movers are aligned with the offset movers, so that the offsets are once again zeroed +out. This function runs twice to account for aim mode, which changes the orientation of an offset mover (on a +group above) when a global mover is moved. The second run cleans up the orientation offsets that were added due +to this.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.copy_transforms"> +<code class="descname">copy_transforms</code><span class="sig-paren">(</span><em>template=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.copy_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.copy_transforms" title="Permalink to this definition">¶</a></dt> +<dd><p>Copies the translate, rotate, and scale values of the joint mover control and stores them to a file on disk.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.create_joint_mover_controls"> +<code class="descname">create_joint_mover_controls</code><span class="sig-paren">(</span><em>root_joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.create_joint_mover_controls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.create_joint_mover_controls" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates the joint mover controls on the joints that come in from the ascii file.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>root_joint</strong> – Root joint of the hierarchy from the joint mover ascii file.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.get_containers"> +<code class="descname">get_containers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.get_containers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.get_containers" title="Permalink to this definition">¶</a></dt> +<dd><p>Get and return the containers that our joint mover controls and utility nodes are contained in.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">PyNodes of containers that our joint mover controls and utility nodes reside in.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.get_created_joints"> +<code class="descname">get_created_joints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.get_created_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.get_created_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds and returns the joints created by this JointMover.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string array of joint names</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.get_driven_joints"> +<code class="descname">get_driven_joints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.get_driven_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.get_driven_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the joint mover joints currently driven by the movers (these are not the same as the created joints).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of PyNodes representing the joint mover joints.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.get_movers"> +<code class="descname">get_movers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.get_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.get_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds and returns the joint mover control objects created by the JointMover.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of joint movers with the keys: global and offset.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.mirror_transforms"> +<code class="descname">mirror_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.mirror_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.mirror_transforms" title="Permalink to this definition">¶</a></dt> +<dd><p>Mirrors joint mover transforms to the owning component’s mirror (if it has one).</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span> +<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">mirror</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">create_mirror</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"r"</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="s2">"root"</span><span class="p">)</span> +<span class="n">leg</span><span class="o">.</span><span class="n">joint_mover</span><span class="o">.</span><span class="n">mirror_transforms</span><span class="p">()</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.paste_transforms"> +<code class="descname">paste_transforms</code><span class="sig-paren">(</span><em>mirror=False</em>, <em>template=False</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.paste_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.paste_transforms" title="Permalink to this definition">¶</a></dt> +<dd><p>Opens the file on disk that has clipboard data for copied transforms, and sets any applicable data on the joint +mover controls.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>mirror</strong> – Whether to mirror the values when pasting.</li> +<li><strong>template</strong> – Whether this is being called from loading a template.</li> +<li><strong>data</strong> – (optional) data of transforms to paste rather than using clipboard.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.remove_movers"> +<code class="descname">remove_movers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.remove_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.remove_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Remove the generated joint mover controls from the driven joints (as well as any associated containers, nodes).</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.rename_movers"> +<code class="descname">rename_movers</code><span class="sig-paren">(</span><em>old_prefix</em>, <em>old_suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.rename_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.rename_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Renames joint movers with the new component prefix and/or suffix.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>old_prefix</strong> (<em>str</em>) – The old prefix to search/replace</li> +<li><strong>old_suffix</strong> (<em>str</em>) – The old suffix to search/replace</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.reset_movers"> +<code class="descname">reset_movers</code><span class="sig-paren">(</span><em>mover_type</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.reset_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.reset_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Resets the joint movers to their default transform values.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mover_type</strong> (<em>str</em>) – Valid options are “all”, “offset”, “global”.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.return_top_mover_grp"> +<code class="descname">return_top_mover_grp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.return_top_mover_grp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.return_top_mover_grp" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds the top-most global mover group and returns it.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string name of the top-most global mover group.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.select_top_mover"> +<code class="descname">select_top_mover</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.select_top_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.select_top_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Selects the top-most joint mover control for this component.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.set_mover_parent"> +<code class="descname">set_mover_parent</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.set_mover_parent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.set_mover_parent" title="Permalink to this definition">¶</a></dt> +<dd><p>Parents the top-most group in the joint mover file under the given parent joint’s global mover.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> (<em>str</em>) – Name of parent joint.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="staticmethod"> +<dt id="artv2.components.base_components.joint_mover.JointMover.set_mover_values"> +<em class="property">static </em><code class="descname">set_mover_values</code><span class="sig-paren">(</span><em>value_data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.set_mover_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.set_mover_values" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets values on the joint mover controls.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value_data</strong> – The values to set on the controls. It should be formatted like the dictionary generated +by the get_mover_values method.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.toggle_build_joint"> +<code class="descname">toggle_build_joint</code><span class="sig-paren">(</span><em>joint</em>, <em>mover</em>, <em>build=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.toggle_build_joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.toggle_build_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles the visibility of the given joint and associated movers, as well as setting the build state.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>joint</strong> – The guide joint (PyNode) to toggle visiblity on.</li> +<li><strong>mover</strong> – The offset mover (PyNode) to set the build state on and toggle visibility on.</li> +<li><strong>build</strong> – The boolean value of whether to build the joint or not.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.toggle_global_visibility"> +<code class="descname">toggle_global_visibility</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.toggle_global_visibility"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.toggle_global_visibility" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles the visibility of the global movers’ shape nodes whose joints are set to be built.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> – The visibility value to set on the global mover shapes.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.toggle_offset_visibility"> +<code class="descname">toggle_offset_visibility</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.toggle_offset_visibility"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.toggle_offset_visibility" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles the visibility of the offset movers’ shape nodes whose joints are set to be built.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> – The visibility value to set on the offset mover shapes.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.toggle_pin_component"> +<code class="descname">toggle_pin_component</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.toggle_pin_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.toggle_pin_component" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles whether the component is pinned, meaning if pinned, the component is unaffected by any transforms of +its parent.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.components.base_components.joint_mover.JointMover.toggle_visibility"> +<code class="descname">toggle_visibility</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/joint_mover.html#JointMover.toggle_visibility"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.toggle_visibility" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles visibility of joint mover nodes.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="artv2.components.base_components.joint_mover.JointMover.metanode"> +<code class="descname">metanode</code><a class="headerlink" href="#artv2.components.base_components.joint_mover.JointMover.metanode" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the metanode that is passed in from our component using the joint mover.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the metanode from our component as a pynode.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<div class="section" id="properties"> +<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2> +<dl class="attribute"> +<dt id="metanode"> +<code class="descname">metanode</code><a class="headerlink" href="#metanode" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds a reference to the owning component’s network node (the component that created this joint +mover.</p> +</dd></dl> + +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="aim_helper.html" class="btn btn-neutral float-right" title="Aim Helper" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="rig_asset.html" class="btn btn-neutral float-left" title="Assets" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/pose.html b/docs/build/sections/tech_docs/components/pose.html new file mode 100644 index 0000000..f57019f --- /dev/null +++ b/docs/build/sections/tech_docs/components/pose.html @@ -0,0 +1,302 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Pose — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Template" href="template.html" /> + <link rel="prev" title="Component Base Class" href="component_base.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="base_classes.html">Base Classes</a> »</li> + + <li>Pose</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/pose.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="pose"> +<h1>Pose<a class="headerlink" href="#pose" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="scripts.artv2.components.base_components.pose.Pose"> +<em class="property">class </em><code class="descname">Pose</code><span class="sig-paren">(</span><em>controls</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/pose.html#Pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.pose.Pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a pose object, which can gather data for creating a pose, load a pose, or save a pose. The constructor is +passed a list of controls for which to either gather data for or load data onto.</p> +<dl class="method"> +<dt id="scripts.artv2.components.base_components.pose.Pose.create_pose"> +<code class="descname">create_pose</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/pose.html#Pose.create_pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.pose.Pose.create_pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Gathers the data from this object’s controls and returns that data in a dictionary.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># create a pose instance with some joints as the "controls"</span> +<span class="kn">import</span> <span class="nn">artv2.components.base_components.pose</span> <span class="kn">as</span> <span class="nn">pose</span> +<span class="n">cmds</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s2">"root"</span><span class="p">,</span> <span class="n">hi</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> +<span class="n">poseInst</span> <span class="o">=</span> <span class="n">pose</span><span class="o">.</span><span class="n">Pose</span><span class="p">(</span><span class="n">cmds</span><span class="o">.</span><span class="n">ls</span><span class="p">(</span><span class="n">sl</span><span class="o">=</span><span class="bp">True</span><span class="p">))</span> + +<span class="c1"># with our pose instance, create a pose named "test".</span> +<span class="n">data</span> <span class="o">=</span> <span class="n">poseInst</span><span class="o">.</span><span class="n">create_pose</span><span class="p">(</span><span class="s2">"test"</span><span class="p">)</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name for the created pose.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of pose data.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="scripts.artv2.components.base_components.pose.Pose.load_pose"> +<code class="descname">load_pose</code><span class="sig-paren">(</span><em>pose_data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/pose.html#Pose.load_pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.pose.Pose.load_pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads the given pose data on this object’s controls.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># create a pose instance with some joints as the "controls"</span> +<span class="kn">import</span> <span class="nn">artv2.components.base_components.pose</span> <span class="kn">as</span> <span class="nn">pose</span> +<span class="n">cmds</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s2">"root"</span><span class="p">,</span> <span class="n">hi</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> +<span class="n">poseInst</span> <span class="o">=</span> <span class="n">pose</span><span class="o">.</span><span class="n">Pose</span><span class="p">(</span><span class="n">cmds</span><span class="o">.</span><span class="n">ls</span><span class="p">(</span><span class="n">sl</span><span class="o">=</span><span class="bp">True</span><span class="p">))</span> + +<span class="c1"># with our pose instance, load the data from a created pose from earlier.</span> +<span class="n">poseInst</span><span class="o">.</span><span class="n">load_pose</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pose_data</strong> – pose data dictionary to load onto controls.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="template.html" class="btn btn-neutral float-right" title="Template" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="component_base.html" class="btn btn-neutral float-left" title="Component Base Class" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/rig_asset.html b/docs/build/sections/tech_docs/components/rig_asset.html new file mode 100644 index 0000000..4fcd60f --- /dev/null +++ b/docs/build/sections/tech_docs/components/rig_asset.html @@ -0,0 +1,323 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Assets — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Joint Mover" href="joint_mover.html" /> + <link rel="prev" title="Components Overview" href="components_overview.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="components_overview.html">Components Overview</a> »</li> + + <li>Assets</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/rig_asset.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="assets"> +<h1>Assets<a class="headerlink" href="#assets" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset"> +<em class="property">class </em><code class="descname">RigAsset</code><span class="sig-paren">(</span><em>network_node=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/rig_asset.html#RigAsset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset" title="Permalink to this definition">¶</a></dt> +<dd><p>The rig asset class defines the top-level representation of a rig and holds data like which components make up +that rig, what the asset name is, etc.</p> +<dl class="method"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.get_movers"> +<code class="descname">get_movers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/rig_asset.html#RigAsset.get_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.get_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Get all joint movers of this asset (returns movers from every component associated with this asset.)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns a list of pynodes that are the joint mover controls from every component in this asset.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.load_dag_pose"> +<code class="descname">load_dag_pose</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/rig_asset.html#RigAsset.load_dag_pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.load_dag_pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads a pose on the component movers or skeleton with the given name (if it exists).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – The name of the pose to load.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.remove_dag_pose"> +<code class="descname">remove_dag_pose</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/rig_asset.html#RigAsset.remove_dag_pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.remove_dag_pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Removes a bind pose with the given name (if it exists).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of the pose to remove.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.save_dag_pose"> +<code class="descname">save_dag_pose</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/rig_asset.html#RigAsset.save_dag_pose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.save_dag_pose" title="Permalink to this definition">¶</a></dt> +<dd><p>Saves a new pose for the component movers and skeleton (basically storing dag poses). Stores the pose data on +the network node for this asset.</p> +<p>param name: The name of the pose.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.name"> +<code class="descname">name</code><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.name" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the asset name. This could be the name of the character, for example.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="scripts.artv2.components.base_components.rig_asset.RigAsset.network_node"> +<code class="descname">network_node</code><a class="headerlink" href="#scripts.artv2.components.base_components.rig_asset.RigAsset.network_node" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the network node that contains the asset’s metadata.</p> +</dd></dl> + +</dd></dl> + +<div class="section" id="properties"> +<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2> +<dl class="attribute"> +<dt id="name"> +<code class="descname">name</code><a class="headerlink" href="#name" title="Permalink to this definition">¶</a></dt> +<dd><p>This property holds the asset name. This could be the name of the character, for example.</p> +</dd></dl> + +<dl class="attribute"> +<dt> +<code class="descname">network_node</code></dt> +<dd><p>This property holds the network node that contains this asset’s metadata.</p> +</dd></dl> + +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="joint_mover.html" class="btn btn-neutral float-right" title="Joint Mover" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="components_overview.html" class="btn btn-neutral float-left" title="Components Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/root_component.html b/docs/build/sections/tech_docs/components/root_component.html new file mode 100644 index 0000000..4c475c1 --- /dev/null +++ b/docs/build/sections/tech_docs/components/root_component.html @@ -0,0 +1,260 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Root Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Spine Component" href="spine.html" /> + <link rel="prev" title="Component Classes" href="component_classes.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Root Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/root_component.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="root-component"> +<h1>Root Component<a class="headerlink" href="#root-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.root.Root"> +<em class="property">class </em><code class="descname">Root</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/root.html#Root"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.root.Root" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>The root rig component class serves as the master control and root joint of the rig and skeleton. Every asset +will always have a root component.</p> +<dl class="method"> +<dt id="artv2.components.root.Root.delete"> +<code class="descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/root.html#Root.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.root.Root.delete" title="Permalink to this definition">¶</a></dt> +<dd><p>Overridden method from base class that checks if this component has any children before it can be deleted. +Other components, when deleted, have any dependencies reparented to the root. So if the root is deleted, it must +have no dependencies (children).</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="spine.html" class="btn btn-neutral float-right" title="Spine Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="component_classes.html" class="btn btn-neutral float-left" title="Component Classes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/segment.html b/docs/build/sections/tech_docs/components/segment.html new file mode 100644 index 0000000..27a1d14 --- /dev/null +++ b/docs/build/sections/tech_docs/components/segment.html @@ -0,0 +1,251 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Segment Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Hinge Component" href="hinge.html" /> + <link rel="prev" title="Chain Component" href="chain.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="spine.html">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Segment Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/segment.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="segment-component"> +<h1>Segment Component<a class="headerlink" href="#segment-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.segment.Segment"> +<em class="property">class </em><code class="descname">Segment</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/segment.html#Segment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.segment.Segment" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="component_base.html#artv2.components.base_components.base_component.ART_Component" title="artv2.components.base_components.base_component.ART_Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.base_components.base_component.ART_Component</span></code></a></p> +<p>This class defines and creates a simple joint segment component.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="hinge.html" class="btn btn-neutral float-right" title="Hinge Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="chain.html" class="btn btn-neutral float-left" title="Chain Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/spine.html b/docs/build/sections/tech_docs/components/spine.html new file mode 100644 index 0000000..4bdd951 --- /dev/null +++ b/docs/build/sections/tech_docs/components/spine.html @@ -0,0 +1,273 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Spine Component — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Arm Component" href="arm_component.html" /> + <link rel="prev" title="Root Component" href="root_component.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3"><a class="reference internal" href="base_classes.html">Base Classes</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="component_classes.html">Component Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="root_component.html">Root Component</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Spine Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="arm_component.html">Arm Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="finger.html">Finger Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hind_leg.html">Hind Leg Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint.html">Joint Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="chain.html">Chain Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="segment.html">Segment Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="hinge.html">Hinge Component</a></li> +<li class="toctree-l4"><a class="reference internal" href="camera.html">Camera Component</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="component_classes.html">Component Classes</a> »</li> + + <li>Spine Component</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/spine.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="spine-component"> +<h1>Spine Component<a class="headerlink" href="#spine-component" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="artv2.components.spine.Spine"> +<em class="property">class </em><code class="descname">Spine</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/spine.html#Spine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.spine.Spine" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="chain.html#artv2.components.chain.Chain" title="artv2.components.chain.Chain"><code class="xref py py-class docutils literal notranslate"><span class="pre">artv2.components.chain.Chain</span></code></a></p> +<p>This class creates a pine component for creating a spine with a pelvis and 3 to 5 spine joints.</p> +<dl class="attribute"> +<dt id="artv2.components.spine.Spine.num_joints"> +<code class="descname">num_joints</code><a class="headerlink" href="#artv2.components.spine.Spine.num_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Property for defining/returning the number of spine joints</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">spine_inst</span> <span class="o">=</span> <span class="n">spine</span><span class="o">.</span><span class="n">Spine</span><span class="p">()</span> +<span class="n">spine_inst</span><span class="o">.</span><span class="n">num_joints</span> <span class="o">=</span> <span class="mi">5</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(int) number of spine joints.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="arm_component.html" class="btn btn-neutral float-right" title="Arm Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="root_component.html" class="btn btn-neutral float-left" title="Root Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/components/template.html b/docs/build/sections/tech_docs/components/template.html new file mode 100644 index 0000000..25ec9b4 --- /dev/null +++ b/docs/build/sections/tech_docs/components/template.html @@ -0,0 +1,293 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Template — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Component Classes" href="component_classes.html" /> + <link rel="prev" title="Pose" href="pose.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li> +<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li> +<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Template</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li> +<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="components.html">Components</a> »</li> + + <li><a href="base_classes.html">Base Classes</a> »</li> + + <li>Template</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/components/template.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="template"> +<h1>Template<a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<dl class="class"> +<dt id="scripts.artv2.components.base_components.template.Template"> +<em class="property">class </em><code class="descname">Template</code><span class="sig-paren">(</span><em>path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/template.html#Template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.template.Template" title="Permalink to this definition">¶</a></dt> +<dd><p>The template class saves and loads templates. Templates contain a dictionary of components, their settings, their +positions, and their joint name overrides.</p> +<dl class="method"> +<dt id="scripts.artv2.components.base_components.template.Template.load_template"> +<code class="descname">load_template</code><span class="sig-paren">(</span><em>components</em>, <em>aim=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/template.html#Template.load_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.template.Template.load_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads a template file from disk. If the components don’t exist (from the passed in list), then those components +are created. Then, depending on the settings (load settings, positions, overrides), data is applied to those +components.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># create a template instance using an existing path to a template on disk.</span> +<span class="n">inst</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">Template</span><span class="p">(</span><span class="sa">r</span><span class="s2">"C:\Users\jernst\Documents\ARTv2\resources\templates\test.json"</span><span class="p">)</span> +<span class="n">inst</span><span class="o">.</span><span class="n">load_settings</span><span class="o">=</span><span class="bp">False</span> +<span class="n">inst</span><span class="o">.</span><span class="n">load_template</span><span class="p">([</span><span class="s2">"clavicle_l"</span><span class="p">,</span> <span class="s2">"arm_l"</span><span class="p">,</span> <span class="s2">"torso"</span><span class="p">,</span> <span class="s2">"master"</span><span class="p">])</span> +</pre></div> +</div> +</dd> +</dl> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>components</strong> – A list of the components from the template to load.</li> +<li><strong>aim</strong> – Whether or not aim model should be turned on the component.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="scripts.artv2.components.base_components.template.Template.save_template"> +<code class="descname">save_template</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/scripts/artv2/components/base_components/template.html#Template.save_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scripts.artv2.components.base_components.template.Template.save_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Saves a template file to disk.</p> +<dl class="docutils"> +<dt>example usage:</dt> +<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># get a filename to save a template to, then create a template instance and save the template.</span> +<span class="n">path</span> <span class="o">=</span> <span class="n">QtWidgets</span><span class="o">.</span><span class="n">QFileDialog</span><span class="o">.</span><span class="n">getSaveFileName</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"Save Template"</span><span class="p">,</span> <span class="n">template_path</span><span class="p">,</span> <span class="s2">"*.json"</span><span class="p">)</span> +<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">])):</span> + <span class="n">template_instance</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">Template</span><span class="p">(</span><span class="n">utils</span><span class="o">.</span><span class="n">path_unify</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span> + <span class="n">template_instance</span><span class="o">.</span><span class="n">save_template</span><span class="p">()</span> +</pre></div> +</div> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="component_classes.html" class="btn btn-neutral float-right" title="Component Classes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pose.html" class="btn btn-neutral float-left" title="Pose" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/add_component_widget.html b/docs/build/sections/tech_docs/rigging_tools/add_component_widget.html new file mode 100644 index 0000000..edc958b --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/add_component_widget.html @@ -0,0 +1,284 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Add Component Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Available Components Widget" href="available_components_widget.html" /> + <link rel="prev" title="Rigging Tools" href="rigging_tools.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Add Component Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/add_component_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="add-component-widget"> +<h1>Add Component Widget<a class="headerlink" href="#add-component-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.add_component_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.add_component_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that displays a user interface for adding/creating a component and supplying an +optional prefix, suffix, as well as a required parent. If the component class has sides, then an option for +choosing a side will be present.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.add_component_widget.AddComponentWidget"> +<em class="property">class </em><code class="descname">AddComponentWidget</code><span class="sig-paren">(</span><em>component_data</em>, <em>parent_inst</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/add_component_widget.html#AddComponentWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.add_component_widget.AddComponentWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class displays a user interface for adding/creating a component and supplying information needed for the +constructor of the component, like the prefix and suffix. A widget for obtaining the parent joint is also +provided, as is a widget for choosing a side if the component has sides. It is instantiated from the +AvailableComponentsWidget class.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>component_data</strong> – list of information for the component. [component category, module to import, +component class]</li> +<li><strong>parent_inst</strong> – the AvailableComponentsWidget instance this class was instantiated from.</li> +<li><strong>parent</strong> – the parent widget of this class, which will be a RigBuilderUI instance.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/available_components_widget.png"><img alt="../../../_images/available_components_widget.png" src="../../../_images/available_components_widget.png" style="width: 197px; height: 334px;" /></a> +<p class="caption"><span class="caption-text">The area in red is the AvailableComponentsWidget class. If you click on an item in this widget, it will then +launch the AddComponentWidget, seen below.</span></p> +</div> +<div class="align-center figure" id="id2"> +<a class="reference internal image-reference" href="../../../_images/add_component_widget.png"><img alt="../../../_images/add_component_widget.png" src="../../../_images/add_component_widget.png" style="width: 254px; height: 207px;" /></a> +<p class="caption"><span class="caption-text">Once an item is clicked in the AvailableComponentsWidget, the AddComponentWidget will be displayed.</span></p> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="available_components_widget.html" class="btn btn-neutral float-right" title="Available Components Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="rigging_tools.html" class="btn btn-neutral float-left" title="Rigging Tools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/available_components_widget.html b/docs/build/sections/tech_docs/rigging_tools/available_components_widget.html new file mode 100644 index 0000000..11048dd --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/available_components_widget.html @@ -0,0 +1,271 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Available Components Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Component Context Menu" href="component_context_menu.html" /> + <link rel="prev" title="Add Component Widget" href="add_component_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Available Components Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/available_components_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="available-components-widget"> +<h1>Available Components Widget<a class="headerlink" href="#available-components-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.available_components_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.available_components_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that is a menu widget that attaches to the “Add Component” button in the RigBuilderUI +class. This menu widget searches for component classes, and adds them to the menu.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.available_components_widget.AvailableComponentsWidget"> +<em class="property">class </em><code class="descname">AvailableComponentsWidget</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/available_components_widget.html#AvailableComponentsWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.available_components_widget.AvailableComponentsWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class is a custom QMenu widget that attaches the to “Add Component” button in the RigBuilderUI instance. It +is populated with available component classes as found in the artv2.components directory.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the parent widget of this class, which will be a RigBuilderUI instance.</td> +</tr> +</tbody> +</table> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/available_components_widget.png"><img alt="../../../_images/available_components_widget.png" src="../../../_images/available_components_widget.png" style="width: 197px; height: 334px;" /></a> +<p class="caption"><span class="caption-text">The area in red is the AvailableComponentsWidget class. It is instantiated from the RigBuilderUI and attached +to the QPushButton at the top.</span></p> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="component_context_menu.html" class="btn btn-neutral float-right" title="Component Context Menu" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="add_component_widget.html" class="btn btn-neutral float-left" title="Add Component Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/bone_counter_ui.html b/docs/build/sections/tech_docs/rigging_tools/bone_counter_ui.html new file mode 100644 index 0000000..0c6c676 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/bone_counter_ui.html @@ -0,0 +1,276 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Bone Counter UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Group Bake Offsets UI" href="group_bake_offsets_ui.html" /> + <link rel="prev" title="Set Parent Widget" href="set_parent_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Bone Counter UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/bone_counter_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="bone-counter-ui"> +<h1>Bone Counter UI<a class="headerlink" href="#bone-counter-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.bone_counter_ui</p> +<span class="target" id="module-artv2.tools.rigging.bone_counter_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that creates a widget displaying the current bone count given the component settings, +and has the ability to set the bone count target.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.bone_counter_ui.BoneCounterUI"> +<em class="property">class </em><code class="descname">BoneCounterUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/bone_counter_ui.html#BoneCounterUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.bone_counter_ui.BoneCounterUI" title="Permalink to this definition">¶</a></dt> +<dd><p>User Interface for displaying and setting bone count targets. Invoked from the toolbar on the RigBuilderUI.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the parent for this widget, which by default is Maya’s main window.</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/bone_counter_ui.png"><img alt="../../../_images/bone_counter_ui.png" src="../../../_images/bone_counter_ui.png" style="width: 200px; height: 150px;" /></a> +</div> +<dl class="method"> +<dt id="artv2.tools.rigging.bone_counter_ui.BoneCounterUI.refresh"> +<code class="descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/bone_counter_ui.html#BoneCounterUI.refresh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.bone_counter_ui.BoneCounterUI.refresh" title="Permalink to this definition">¶</a></dt> +<dd><p>Refreshes the current number and progress on the progress bar.</p> +</dd></dl> + +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.bone_counter_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/bone_counter_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.bone_counter_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the BoneCounterUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="group_bake_offsets_ui.html" class="btn btn-neutral float-right" title="Group Bake Offsets UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="set_parent_widget.html" class="btn btn-neutral float-left" title="Set Parent Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/component_context_menu.html b/docs/build/sections/tech_docs/rigging_tools/component_context_menu.html new file mode 100644 index 0000000..06d1be5 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/component_context_menu.html @@ -0,0 +1,277 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Component Context Menu — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Component Settings Widget" href="component_settings_widget.html" /> + <link rel="prev" title="Available Components Widget" href="available_components_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Component Context Menu</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/component_context_menu.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="component-context-menu"> +<h1>Component Context Menu<a class="headerlink" href="#component-context-menu" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.component_context_menu</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.component_context_menu"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that is a context menu for installed components in the scene. The context menu provides +functions for manipulating the components. Things like copy/paste settings or transforms, duplicating, creating a +mirror, mirroring transforms, renaming, deleting, etc.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.component_context_menu.ComponentContextMenu"> +<em class="property">class </em><code class="descname">ComponentContextMenu</code><span class="sig-paren">(</span><em>metanode</em>, <em>list_widget</em>, <em>point</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/component_context_menu.html#ComponentContextMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.component_context_menu.ComponentContextMenu" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a custom QMenu that serves as a context menu for installed components in the scene. The context +menu provides functions for manipulating the components. Things like copy/paste settings or transforms, +duplicating, creating a mirror, mirroring transforms, renaming, deleting, etc. It is instantiated from the +RigBuilderUI class when an item has a menu requested.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – the string name of the network node for that component, which can then be used to access that +component’s instance.</li> +<li><strong>list_widget</strong> – the instance of the InstalledComponentsWidget in the RigBuilderUI that contains the items.</li> +<li><strong>point</strong> – the coordinates of the cursor when the menu was requested.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI which will be this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<img alt="../../../_images/component_context.png" src="../../../_images/component_context.png" /> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="component_settings_widget.html" class="btn btn-neutral float-right" title="Component Settings Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="available_components_widget.html" class="btn btn-neutral float-left" title="Available Components Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/component_settings_widget.html b/docs/build/sections/tech_docs/rigging_tools/component_settings_widget.html new file mode 100644 index 0000000..302584b --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/component_settings_widget.html @@ -0,0 +1,276 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Component Settings Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Installed Components Widget" href="installed_components_widget.html" /> + <link rel="prev" title="Component Context Menu" href="component_context_menu.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Component Settings Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/component_settings_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="component-settings-widget"> +<h1>Component Settings Widget<a class="headerlink" href="#component-settings-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.component_settings_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.component_settings_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that builds a widget for editing a component’s settings, like number of joints, or +prefix/suffix, etc.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.component_settings_widget.ComponentSettingsWidget"> +<em class="property">class </em><code class="descname">ComponentSettingsWidget</code><span class="sig-paren">(</span><em>metanode</em>, <em>layout</em>, <em>list_item</em>, <em>list_label</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/component_settings_widget.html#ComponentSettingsWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.component_settings_widget.ComponentSettingsWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a widget that is used to edit a component’s settings, like number of joint, prefix/suffix, +parent, etc.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – string name of the component’s network node that contains the component’s settings.</li> +<li><strong>layout</strong> – the layout this widget will be added to.</li> +<li><strong>list_item</strong> – the QListWidgetItem that was clicked on to invoke the creation of this widget.</li> +<li><strong>list_label</strong> – the label of the QListWidgetItem that was clicked on to invoke the creation of this widget.</li> +<li><strong>parent</strong> – an instance of the InstalledComponentsWidget that is this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/component_settings_widget.png"><img alt="../../../_images/component_settings_widget.png" src="../../../_images/component_settings_widget.png" style="width: 213px; height: 468px;" /></a> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="installed_components_widget.html" class="btn btn-neutral float-right" title="Installed Components Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="component_context_menu.html" class="btn btn-neutral float-left" title="Component Context Menu" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/group_bake_offsets_ui.html b/docs/build/sections/tech_docs/rigging_tools/group_bake_offsets_ui.html new file mode 100644 index 0000000..e46c5e7 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/group_bake_offsets_ui.html @@ -0,0 +1,271 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Bake Offsets UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Group Mirror UI" href="group_mirror_ui.html" /> + <link rel="prev" title="Bone Counter UI" href="bone_counter_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Group Bake Offsets UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/group_bake_offsets_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-bake-offsets-ui"> +<h1>Group Bake Offsets UI<a class="headerlink" href="#group-bake-offsets-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.group_bake_offsets_ui</p> +<span class="target" id="module-artv2.tools.rigging.group_bake_offsets_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class for creating a user interface for selecting multiple components and baking their +offsets all at the same time.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.group_bake_offsets_ui.GroupBakeUI"> +<em class="property">class </em><code class="descname">GroupBakeUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_bake_offsets_ui.html#GroupBakeUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_bake_offsets_ui.GroupBakeUI" title="Permalink to this definition">¶</a></dt> +<dd><p>The class creates a user interface for baking offsets on multiple components at once. Invoked from the RigBuilderUI +toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/group_bake_offsets_widget.png"><img alt="../../../_images/group_bake_offsets_widget.png" src="../../../_images/group_bake_offsets_widget.png" style="width: 199px; height: 364px;" /></a> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.group_bake_offsets_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_bake_offsets_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_bake_offsets_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the GroupBakeUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="group_mirror_ui.html" class="btn btn-neutral float-right" title="Group Mirror UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="bone_counter_ui.html" class="btn btn-neutral float-left" title="Bone Counter UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/group_mirror_ui.html b/docs/build/sections/tech_docs/rigging_tools/group_mirror_ui.html new file mode 100644 index 0000000..1bcfbb5 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/group_mirror_ui.html @@ -0,0 +1,269 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Mirror UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Group Mirror Transforms UI" href="group_mirror_xforms_ui.html" /> + <link rel="prev" title="Group Bake Offsets UI" href="group_bake_offsets_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Group Mirror UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/group_mirror_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-mirror-ui"> +<h1>Group Mirror UI<a class="headerlink" href="#group-mirror-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.group_mirror_ui</p> +<span class="target" id="module-artv2.tools.rigging.group_mirror_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that creates a widget for creating mirrors of multiple components at once.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.group_mirror_ui.GroupMirrorUI"> +<em class="property">class </em><code class="descname">GroupMirrorUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_mirror_ui.html#GroupMirrorUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_mirror_ui.GroupMirrorUI" title="Permalink to this definition">¶</a></dt> +<dd><p>User Interface for creating mirrors of multiple components at once. Invoked from the RigBuilderUI toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/group_mirror_ui.png"><img alt="../../../_images/group_mirror_ui.png" src="../../../_images/group_mirror_ui.png" style="width: 202px; height: 370px;" /></a> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.group_mirror_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_mirror_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_mirror_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the GroupMirrorUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="group_mirror_xforms_ui.html" class="btn btn-neutral float-right" title="Group Mirror Transforms UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="group_bake_offsets_ui.html" class="btn btn-neutral float-left" title="Group Bake Offsets UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/group_mirror_xforms_ui.html b/docs/build/sections/tech_docs/rigging_tools/group_mirror_xforms_ui.html new file mode 100644 index 0000000..ec30304 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/group_mirror_xforms_ui.html @@ -0,0 +1,271 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Mirror Transforms UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Group Reset UI" href="group_reset_ui.html" /> + <link rel="prev" title="Group Mirror UI" href="group_mirror_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Group Mirror Transforms UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/group_mirror_xforms_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-mirror-transforms-ui"> +<h1>Group Mirror Transforms UI<a class="headerlink" href="#group-mirror-transforms-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.group_mirror_xforms_ui</p> +<span class="target" id="module-artv2.tools.rigging.group_mirror_xforms_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains the class for creating the user interface that allows a user to mirror transformations on +multiple components at once.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.group_mirror_xforms_ui.MirrorXformsUI"> +<em class="property">class </em><code class="descname">MirrorXformsUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_mirror_xforms_ui.html#MirrorXformsUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_mirror_xforms_ui.MirrorXformsUI" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates the user interface for mirror transformations on multiple components at once. Invoked from the +RigBuilderUI toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/group_mirror_xforms_ui.png"><img alt="../../../_images/group_mirror_xforms_ui.png" src="../../../_images/group_mirror_xforms_ui.png" style="width: 301px; height: 326px;" /></a> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.group_mirror_xforms_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_mirror_xforms_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_mirror_xforms_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the MirrorXformsUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="group_reset_ui.html" class="btn btn-neutral float-right" title="Group Reset UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="group_mirror_ui.html" class="btn btn-neutral float-left" title="Group Mirror UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/group_reset_ui.html b/docs/build/sections/tech_docs/rigging_tools/group_reset_ui.html new file mode 100644 index 0000000..d70b88f --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/group_reset_ui.html @@ -0,0 +1,271 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Group Reset UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Load Template UI" href="load_template_ui.html" /> + <link rel="prev" title="Group Mirror Transforms UI" href="group_mirror_xforms_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Group Reset UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/group_reset_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="group-reset-ui"> +<h1>Group Reset UI<a class="headerlink" href="#group-reset-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.group_reset_ui</p> +<span class="target" id="module-artv2.tools.rigging.group_reset_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that creates an interface for selecting multiple components and resetting their +settings or transforms or both.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.group_reset_ui.GroupResetUI"> +<em class="property">class </em><code class="descname">GroupResetUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_reset_ui.html#GroupResetUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_reset_ui.GroupResetUI" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a user interface for selecting components and resetting their settings and/or transforms. It is +invoked from the RigBuilderUI toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/group_reset_ui.png"><img alt="../../../_images/group_reset_ui.png" src="../../../_images/group_reset_ui.png" style="width: 198px; height: 429px;" /></a> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.group_reset_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/group_reset_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.group_reset_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the GroupResetUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="load_template_ui.html" class="btn btn-neutral float-right" title="Load Template UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="group_mirror_xforms_ui.html" class="btn btn-neutral float-left" title="Group Mirror Transforms UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/installed_components_widget.html b/docs/build/sections/tech_docs/rigging_tools/installed_components_widget.html new file mode 100644 index 0000000..90bd68f --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/installed_components_widget.html @@ -0,0 +1,303 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Installed Components Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Mirror Component Widget" href="mirror_component_widget.html" /> + <link rel="prev" title="Component Settings Widget" href="component_settings_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Installed Components Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/installed_components_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="installed-components-widget"> +<h1>Installed Components Widget<a class="headerlink" href="#installed-components-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.installed_components_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.installed_components_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains the class that is a custom QListWidget for displaying components installed in the scene. +It has some extras, like buttons next to each item for pinning and aiming the component.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget"> +<em class="property">class </em><code class="descname">InstalledComponentsWidget</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/installed_components_widget.html#InstalledComponentsWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class is a custom QListWidget for displaying installed components in the scene. Each list widget item in the +list has three buttons next to it for toggling visibility, pinning and aim mode.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – an instance of the RigBuilderUI that this widget is parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/installed_components.png"><img alt="../../../_images/installed_components.png" src="../../../_images/installed_components.png" style="width: 200px; height: 457px;" /></a> +</div> +<dl class="method"> +<dt id="artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.filter_list"> +<code class="descname">filter_list</code><span class="sig-paren">(</span><em>search_widget</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/installed_components_widget.html#InstalledComponentsWidget.filter_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.filter_list" title="Permalink to this definition">¶</a></dt> +<dd><p>Filters the list widget by the search term in the given search widget.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>search_widget</strong> – QLineEdit widget to grab text from for search term.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.get_items"> +<code class="descname">get_items</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/installed_components_widget.html#InstalledComponentsWidget.get_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.get_items" title="Permalink to this definition">¶</a></dt> +<dd><p>Get the labels of the list widget items and store them in a dictionary where the values are the items.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">{[label]= QListWidgetItem, }</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.refresh_list"> +<code class="descname">refresh_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/installed_components_widget.html#InstalledComponentsWidget.refresh_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.installed_components_widget.InstalledComponentsWidget.refresh_list" title="Permalink to this definition">¶</a></dt> +<dd><p>Refresh the list of installed components.</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="mirror_component_widget.html" class="btn btn-neutral float-right" title="Mirror Component Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="component_settings_widget.html" class="btn btn-neutral float-left" title="Component Settings Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/load_template_ui.html b/docs/build/sections/tech_docs/rigging_tools/load_template_ui.html new file mode 100644 index 0000000..3674686 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/load_template_ui.html @@ -0,0 +1,275 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Load Template UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Pose Manager UI" href="pose_manager_ui.html" /> + <link rel="prev" title="Group Reset UI" href="group_reset_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Load Template UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/load_template_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="load-template-ui"> +<h1>Load Template UI<a class="headerlink" href="#load-template-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.load_template_ui</p> +<span class="target" id="module-artv2.tools.rigging.load_template_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains the class for creating and displaying the load template interface.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.load_template_ui.LoadTemplateUI"> +<em class="property">class </em><code class="descname">LoadTemplateUI</code><span class="sig-paren">(</span><em>path</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/load_template_ui.html#LoadTemplateUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.load_template_ui.LoadTemplateUI" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates the Load Template interface for loading a template from disk. The interface allows the user to +select components to load, as well as what information to load (positions, settings, overrides) and that information +is then passed onto the template class for processing. This is invoked from the RigBuilderUI toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>path</strong> – the path on disk of a template file.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/loadTemplateUI.png"><img alt="../../../_images/loadTemplateUI.png" src="../../../_images/loadTemplateUI.png" style="width: 382px; height: 304px;" /></a> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.load_template_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/load_template_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.load_template_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the LoadTemplateUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pose_manager_ui.html" class="btn btn-neutral float-right" title="Pose Manager UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="group_reset_ui.html" class="btn btn-neutral float-left" title="Group Reset UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/mirror_component_widget.html b/docs/build/sections/tech_docs/rigging_tools/mirror_component_widget.html new file mode 100644 index 0000000..aea67d7 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/mirror_component_widget.html @@ -0,0 +1,275 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Mirror Component Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Choose Parent List Widget" href="parent_list_widget.html" /> + <link rel="prev" title="Installed Components Widget" href="installed_components_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Mirror Component Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/mirror_component_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="mirror-component-widget"> +<h1>Mirror Component Widget<a class="headerlink" href="#mirror-component-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.mirror_component_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.mirror_component_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class for displaying a widget for creating a mirror of a component. The widget has inputs for +the mirror’s prefix, suffix and parent bone.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.mirror_component_widget.MirrorComponentWidget"> +<em class="property">class </em><code class="descname">MirrorComponentWidget</code><span class="sig-paren">(</span><em>metanode</em>, <em>parent_inst</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/mirror_component_widget.html#MirrorComponentWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.mirror_component_widget.MirrorComponentWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a QMainWindow for creating a mirror of a component. It has QLineEdits for setting the prefix +and suffix, as well as a QComboBox for selecting the parent joint of the created mirror. It is instantiated from +the ComponentContextMenu when ‘Create Mirror of Component’ is selected.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – string name of the component’s network node whom we want to mirror.</li> +<li><strong>parent_inst</strong> – the instance of the ComponentContextMenu that instantiated this widget.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI which will be this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/mirror_component_widget.png"><img alt="../../../_images/mirror_component_widget.png" src="../../../_images/mirror_component_widget.png" style="width: 223px; height: 172px;" /></a> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="parent_list_widget.html" class="btn btn-neutral float-right" title="Choose Parent List Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="installed_components_widget.html" class="btn btn-neutral float-left" title="Installed Components Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/parent_list_widget.html b/docs/build/sections/tech_docs/rigging_tools/parent_list_widget.html new file mode 100644 index 0000000..b100956 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/parent_list_widget.html @@ -0,0 +1,274 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Choose Parent List Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Rename Component Widget" href="rename_widget.html" /> + <link rel="prev" title="Mirror Component Widget" href="mirror_component_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Choose Parent List Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/parent_list_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="choose-parent-list-widget"> +<h1>Choose Parent List Widget<a class="headerlink" href="#choose-parent-list-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.parent_list_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.parent_list_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class for showing a QListWidget of available joints that can be chosen as a parent for a +component.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.parent_list_widget.ChooseParentList"> +<em class="property">class </em><code class="descname">ChooseParentList</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/parent_list_widget.html#ChooseParentList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.parent_list_widget.ChooseParentList" title="Permalink to this definition">¶</a></dt> +<dd><p>This class shows a QListWidgets of available joints that can be chosen as a parent for a component. This widget is +instantiated from multiple places: AddComponentWidget, ComponentSettingsWidget, and SetParentWidget.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Param:</th><td class="field-body">parent: the instance of the widget that invoked this widget that this widget will be parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/parent_list_widget_sources.png"><img alt="../../../_images/parent_list_widget_sources.png" src="../../../_images/parent_list_widget_sources.png" style="width: 600px; height: 375px;" /></a> +<p class="caption"><span class="caption-text">The buttons with a red outline are the buttons on different widgets that invoke this ChooseParentList class.</span></p> +</div> +<div class="align-center figure" id="id2"> +<a class="reference internal image-reference" href="../../../_images/parent_list_widget.png"><img alt="../../../_images/parent_list_widget.png" src="../../../_images/parent_list_widget.png" style="width: 164px; height: 321px;" /></a> +<p class="caption"><span class="caption-text">The actual ChooseParentList widget.</span></p> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="rename_widget.html" class="btn btn-neutral float-right" title="Rename Component Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="mirror_component_widget.html" class="btn btn-neutral float-left" title="Mirror Component Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/pose_manager_ui.html b/docs/build/sections/tech_docs/rigging_tools/pose_manager_ui.html new file mode 100644 index 0000000..d97a2a0 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/pose_manager_ui.html @@ -0,0 +1,273 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Pose Manager UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Running Tests" href="../running_tests.html" /> + <link rel="prev" title="Load Template UI" href="load_template_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a></li> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Pose Manager UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/pose_manager_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="pose-manager-ui"> +<h1>Pose Manager UI<a class="headerlink" href="#pose-manager-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.pose_manager_ui</p> +<span class="target" id="module-artv2.tools.rigging.pose_manager_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class for creating a user interface for storing new bind poses, removing bind poses, and +setting the active bind pose.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.pose_manager_ui.PoseManagerUI"> +<em class="property">class </em><code class="descname">PoseManagerUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/pose_manager_ui.html#PoseManagerUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.pose_manager_ui.PoseManagerUI" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a user interface that allows the user to create new bind poses, set the active bind pose, or remove +bind poses. This is invoked from the RigBuilderUI toolbar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – the instance of the RigBuilderUI this widget will be parented to.</td> +</tr> +</tbody> +</table> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/pose_manager_overview.gif"><img alt="../../../_images/pose_manager_overview.gif" src="../../../_images/pose_manager_overview.gif" style="width: 717px; height: 557px;" /></a> +<p class="caption"><span class="caption-text">this example shows two poses that have been saved with the pose manager. One for the pose the model was +delivered in and one for the pose we want to build the rig in.</span></p> +</div> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.pose_manager_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/pose_manager_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.pose_manager_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the PoseManagerUI instance</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../running_tests.html" class="btn btn-neutral float-right" title="Running Tests" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="load_template_ui.html" class="btn btn-neutral float-left" title="Load Template UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/rename_widget.html b/docs/build/sections/tech_docs/rigging_tools/rename_widget.html new file mode 100644 index 0000000..baae9eb --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/rename_widget.html @@ -0,0 +1,273 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Rename Component Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Rig Builder UI" href="rig_builder_ui.html" /> + <link rel="prev" title="Choose Parent List Widget" href="parent_list_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Rename Component Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/rename_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="rename-component-widget"> +<h1>Rename Component Widget<a class="headerlink" href="#rename-component-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.rename_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.rename_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that presents a simple widget for setting a prefix and suffix for a component.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.rename_widget.RenameComponentWidget"> +<em class="property">class </em><code class="descname">RenameComponentWidget</code><span class="sig-paren">(</span><em>metanode</em>, <em>parent_inst</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rename_widget.html#RenameComponentWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rename_widget.RenameComponentWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a QMainWindow that has QLineEdits for setting a prefix and suffix for a component. It is invoked +from the ComponentContextMenu.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – the string name of the component’s network node that is to be renamed.</li> +<li><strong>parent_inst</strong> – the instance of the ComponentContextMenu that invoked this class.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI that will be this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/rename_component_widget.png"><img alt="../../../_images/rename_component_widget.png" src="../../../_images/rename_component_widget.png" style="width: 219px; height: 127px;" /></a> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="rig_builder_ui.html" class="btn btn-neutral float-right" title="Rig Builder UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="parent_list_widget.html" class="btn btn-neutral float-left" title="Choose Parent List Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/rig_builder_ui.html b/docs/build/sections/tech_docs/rigging_tools/rig_builder_ui.html new file mode 100644 index 0000000..8129b07 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/rig_builder_ui.html @@ -0,0 +1,305 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Rig Builder UI — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Set Mirror Widget" href="set_mirror_widget.html" /> + <link rel="prev" title="Rename Component Widget" href="rename_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Rig Builder UI</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/rig_builder_ui.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="rig-builder-ui"> +<h1>Rig Builder UI<a class="headerlink" href="#rig-builder-ui" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.rig_builder_ui</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.rig_builder_ui"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains the class that provides the main user interface that is used to build up an asset with +different rig components.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI"> +<em class="property">class </em><code class="descname">RigBuilderUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rig_builder_ui.html#RigBuilderUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI" title="Permalink to this definition">¶</a></dt> +<dd><p>This class provides the main user interface that is used to build up an asset with different rig components. It is +invoked from the ART v2 menu on Maya’s main menu bar.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – Parent for this widget, which will be Maya’s main window.</td> +</tr> +</tbody> +</table> +<div class="align-center figure" id="id1"> +<a class="reference internal image-reference" href="../../../_images/rig_builder.png"><img alt="../../../_images/rig_builder.png" src="../../../_images/rig_builder.png" style="width: 495px; height: 659px;" /></a> +<p class="caption"><span class="caption-text">the rig builder interface.</span></p> +</div> +<dl class="method"> +<dt id="artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI.set_states"> +<code class="descname">set_states</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rig_builder_ui.html#RigBuilderUI.set_states"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI.set_states" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets the state of the UI and of some of the widgets in the UI. For example, depending on the state of the asset, +the UI will either display component settings and creation widgets, deformation widgets, or build widgets. +Also, depending on the state of the asset, other buttons may be toggled on or off.</p> +</dd></dl> + +<dl class="method"> +<dt id="artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI.update_list"> +<code class="descname">update_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rig_builder_ui.html#RigBuilderUI.update_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rig_builder_ui.RigBuilderUI.update_list" title="Permalink to this definition">¶</a></dt> +<dd><p>Updates the installed components list and then refreshes the state of the UI.</p> +</dd></dl> + +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.rig_builder.rig_builder_ui.create_new_asset"> +<code class="descname">create_new_asset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rig_builder_ui.html#create_new_asset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rig_builder_ui.create_new_asset" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a new rig asset and root component if one does not exist.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">returns True if the user decided to create a new asset. False if not.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.tools.rigging.rig_builder.rig_builder_ui.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/rig_builder_ui.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.rig_builder_ui.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the RigBuilderUI instance, and if no asset exists in the scene at time of launch, then also will create a +new rig asset and root component.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="set_mirror_widget.html" class="btn btn-neutral float-right" title="Set Mirror Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="rename_widget.html" class="btn btn-neutral float-left" title="Rename Component Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/rigging_tools.html b/docs/build/sections/tech_docs/rigging_tools/rigging_tools.html new file mode 100644 index 0000000..cfd09ff --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/rigging_tools.html @@ -0,0 +1,283 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Rigging Tools — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Add Component Widget" href="add_component_widget.html" /> + <link rel="prev" title="Rigging Utilities" href="../utilities/rigging_utilities.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Rigging Tools</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#rig-builder">Rig Builder</a><ul> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#rig-builder-toolbar">Rig Builder Toolbar</a><ul> +<li class="toctree-l4"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li>Rigging Tools</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/rigging_tools.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="rigging-tools"> +<h1>Rigging Tools<a class="headerlink" href="#rigging-tools" title="Permalink to this headline">¶</a></h1> +<div class="section" id="rig-builder"> +<h2>Rig Builder<a class="headerlink" href="#rig-builder" title="Permalink to this headline">¶</a></h2> +<img alt="../../../_images/rig_builder.png" src="../../../_images/rig_builder.png" /> +<p>The following tools are all part of the rig builder interface, usually as widgets within that interface, but a few are +modal dialogs that the rig builder will call upon.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l1"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l1"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</div> +</div> +<div class="section" id="rig-builder-toolbar"> +<h2>Rig Builder Toolbar<a class="headerlink" href="#rig-builder-toolbar" title="Permalink to this headline">¶</a></h2> +<img alt="../../../_images/rig_builder_toolbar.png" src="../../../_images/rig_builder_toolbar.png" /> +<p>The following tools invoked from the toolbar of the rig builder interface.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="bone_counter_ui.html">Bone Counter UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="group_bake_offsets_ui.html">Group Bake Offsets UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="group_mirror_ui.html">Group Mirror UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="group_mirror_xforms_ui.html">Group Mirror Transforms UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="group_reset_ui.html">Group Reset UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="load_template_ui.html">Load Template UI</a></li> +<li class="toctree-l1"><a class="reference internal" href="pose_manager_ui.html">Pose Manager UI</a></li> +</ul> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="add_component_widget.html" class="btn btn-neutral float-right" title="Add Component Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../utilities/rigging_utilities.html" class="btn btn-neutral float-left" title="Rigging Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/set_mirror_widget.html b/docs/build/sections/tech_docs/rigging_tools/set_mirror_widget.html new file mode 100644 index 0000000..327d68f --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/set_mirror_widget.html @@ -0,0 +1,273 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Set Mirror Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Set Parent Widget" href="set_parent_widget.html" /> + <link rel="prev" title="Rig Builder UI" href="rig_builder_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Set Mirror Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_parent_widget.html">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Set Mirror Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/set_mirror_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="set-mirror-widget"> +<h1>Set Mirror Widget<a class="headerlink" href="#set-mirror-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.set_mirror_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.set_mirror_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that creates a simple widget for choosing a mirror component. Mirror components must +be of the same class type.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.set_mirror_widget.SetMirrorWidget"> +<em class="property">class </em><code class="descname">SetMirrorWidget</code><span class="sig-paren">(</span><em>metanode</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/set_mirror_widget.html#SetMirrorWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.set_mirror_widget.SetMirrorWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class creates a QMainWindow that has a QComboBox for selecting a mirror component for the component this was +called on. This widget is invoked by the ComponentContextMenu.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – the string name of the component that the mirror will be set on.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI which will be this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/set_mirror_widget.png"><img alt="../../../_images/set_mirror_widget.png" src="../../../_images/set_mirror_widget.png" style="width: 215px; height: 103px;" /></a> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="set_parent_widget.html" class="btn btn-neutral float-right" title="Set Parent Widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="rig_builder_ui.html" class="btn btn-neutral float-left" title="Rig Builder UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/rigging_tools/set_parent_widget.html b/docs/build/sections/tech_docs/rigging_tools/set_parent_widget.html new file mode 100644 index 0000000..e1aaae6 --- /dev/null +++ b/docs/build/sections/tech_docs/rigging_tools/set_parent_widget.html @@ -0,0 +1,272 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Set Parent Widget — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Bone Counter UI" href="bone_counter_ui.html" /> + <link rel="prev" title="Set Mirror Widget" href="set_mirror_widget.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="rigging_tools.html">Rigging Tools</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="rigging_tools.html#rig-builder">Rig Builder</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="add_component_widget.html">Add Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="available_components_widget.html">Available Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_context_menu.html">Component Context Menu</a></li> +<li class="toctree-l4"><a class="reference internal" href="component_settings_widget.html">Component Settings Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="installed_components_widget.html">Installed Components Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="mirror_component_widget.html">Mirror Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="parent_list_widget.html">Choose Parent List Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rename_widget.html">Rename Component Widget</a></li> +<li class="toctree-l4"><a class="reference internal" href="rig_builder_ui.html">Rig Builder UI</a></li> +<li class="toctree-l4"><a class="reference internal" href="set_mirror_widget.html">Set Mirror Widget</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Set Parent Widget</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="rigging_tools.html#rig-builder-toolbar">Rig Builder Toolbar</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="rigging_tools.html">Rigging Tools</a> »</li> + + <li>Set Parent Widget</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/rigging_tools/set_parent_widget.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="set-parent-widget"> +<h1>Set Parent Widget<a class="headerlink" href="#set-parent-widget" title="Permalink to this headline">¶</a></h1> +<p>artv2.tools.rigging.rig_builder.set_parent_widget</p> +<span class="target" id="module-artv2.tools.rigging.rig_builder.set_parent_widget"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains a class that presents a widget for setting the parent joint of a component.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.tools.rigging.rig_builder.set_parent_widget.SetParentWidget"> +<em class="property">class </em><code class="descname">SetParentWidget</code><span class="sig-paren">(</span><em>metanode</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/tools/rigging/rig_builder/set_parent_widget.html#SetParentWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.tools.rigging.rig_builder.set_parent_widget.SetParentWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>This class presents a widget for setting the parent joint of a component. It is invoked from the +ComponentContextMenu.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>metanode</strong> – string name of the component’s network node that the parent will be set on.</li> +<li><strong>parent</strong> – the instance of the RigBuilderUI which will be this widget’s parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<div class="align-center figure"> +<a class="reference internal image-reference" href="../../../_images/set_parent_widget.png"><img alt="../../../_images/set_parent_widget.png" src="../../../_images/set_parent_widget.png" style="width: 220px; height: 108px;" /></a> +</div> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="bone_counter_ui.html" class="btn btn-neutral float-right" title="Bone Counter UI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="set_mirror_widget.html" class="btn btn-neutral float-left" title="Set Mirror Widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/running_tests.html b/docs/build/sections/tech_docs/running_tests.html new file mode 100644 index 0000000..40018e5 --- /dev/null +++ b/docs/build/sections/tech_docs/running_tests.html @@ -0,0 +1,232 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Running Tests — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="prev" title="Pose Manager UI" href="rigging_tools/pose_manager_ui.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li><a href="../../technical_documentation.html">Technical Documentation</a> »</li> + + <li>Running Tests</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/sections/tech_docs/running_tests.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="running-tests"> +<h1>Running Tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst, Chad Vernon</em></p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>Many thanks to Chad Vernon and his incredibly useful blog posts on running unit tests in Maya. Most of the code +found in the artv2_tester package was from his posts.</p> +<p class="last">Check out his posts <a class="reference external" href="http://www.chadvernon.com/blog/unit-testing-in-maya/">here</a>:</p> +</div> +<p>To run tests to ensure changes to the code base you have made aren’t causing any issues, it’s best to restart Maya, +then under the ART v2 menu, in the Development sub-menu, find Run Tests.</p> +<p>The following interface will appear:</p> +<img alt="../../_images/run_tests.png" src="../../_images/run_tests.png" /> +<p>From here, you can either hit the left-most play button to run all tests, or select a specific test or group of tests +and use the “Run Selected Tests” button.</p> +<p>If a test fails, you will get information on the right side about what failed and where.</p> +<img alt="../../_images/artv2_testing.png" src="../../_images/artv2_testing.png" /> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + + <a href="rigging_tools/pose_manager_ui.html" class="btn btn-neutral float-left" title="Pose Manager UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/useful_scripting_commands.html b/docs/build/sections/tech_docs/useful_scripting_commands.html new file mode 100644 index 0000000..b4ea48a --- /dev/null +++ b/docs/build/sections/tech_docs/useful_scripting_commands.html @@ -0,0 +1,289 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Useful Scripting Commands — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="next" title="Components" href="components/components.html" /> + <link rel="prev" title="Technical Documentation" href="../../technical_documentation.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Useful Scripting Commands</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#creating-a-simple-character">Creating a Simple Character</a></li> +<li class="toctree-l3"><a class="reference internal" href="#accessing-component-data">Accessing Component Data</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="components/components.html">Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="utilities/utilities.html">Utilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li><a href="../../technical_documentation.html">Technical Documentation</a> »</li> + + <li>Useful Scripting Commands</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/sections/tech_docs/useful_scripting_commands.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="useful-scripting-commands"> +<h1>Useful Scripting Commands<a class="headerlink" href="#useful-scripting-commands" title="Permalink to this headline">¶</a></h1> +<p><em>Code author: Jeremy Ernst</em></p> +<p>Below are some examples for scripting aspects of the system. In order to fully understand all the attributes and +methods available, please look at the relevant technical documentation.</p> +<div class="section" id="creating-a-simple-character"> +<h2>Creating a Simple Character<a class="headerlink" href="#creating-a-simple-character" title="Permalink to this headline">¶</a></h2> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Import the necessary modules</span> +<span class="kn">import</span> <span class="nn">artv2.components.base_components.rig_asset</span> <span class="kn">as</span> <span class="nn">rig_asset</span> +<span class="kn">import</span> <span class="nn">artv2.components.root</span> <span class="kn">as</span> <span class="nn">root</span> +<span class="kn">import</span> <span class="nn">artv2.components.spine</span> <span class="kn">as</span> <span class="nn">spine</span> +<span class="kn">import</span> <span class="nn">artv2.components.biped_leg</span> <span class="kn">as</span> <span class="nn">leg</span> +<span class="kn">import</span> <span class="nn">artv2.components.arm</span> <span class="kn">as</span> <span class="nn">arm</span> + +<span class="c1"># Build an asset, which is required to hold other components.</span> +<span class="n">new_asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">RigAsset</span><span class="p">()</span> + +<span class="c1"># Create a root component</span> +<span class="n">root_inst</span> <span class="o">=</span> <span class="n">root</span><span class="o">.</span><span class="n">Root</span><span class="p">()</span> + +<span class="c1"># Create a spine components and set the number of spine joints to 4 and its parent to the root</span> +<span class="n">spine_inst</span> <span class="o">=</span> <span class="n">spine</span><span class="o">.</span><span class="n">Spine</span><span class="p">()</span> +<span class="n">spine_inst</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="s2">"root"</span> +<span class="n">spine_inst</span><span class="o">.</span><span class="n">num_joints</span> <span class="o">=</span> <span class="mi">4</span> + +<span class="c1"># Create a leg component for the left leg and set its parent to the pelvis bone created by the spine component.</span> +<span class="n">l_leg_inst</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">()</span> +<span class="n">l_leg_inst</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="s2">"pelvis"</span> + +<span class="c1"># Create a mirror of the left leg</span> +<span class="n">l_leg_inst</span><span class="o">.</span><span class="n">create_mirror</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"r"</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="s2">"pelvis"</span><span class="p">)</span> + +<span class="c1"># Set the prefix on the left leg instance</span> +<span class="n">l_leg_inst</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="s2">"l"</span> + +<span class="c1"># Create an arm component and set its parent to the last spine joint created by the spine component.</span> +<span class="n">l_arm_inst</span> <span class="o">=</span> <span class="n">arm</span><span class="o">.</span><span class="n">Arm</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span> +<span class="n">l_arm_inst</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="s2">"spine_04"</span> + +<span class="c1"># Create a mirror of the arm component.</span> +<span class="n">r_arm_inst</span> <span class="o">=</span> <span class="n">l_arm_inst</span><span class="o">.</span><span class="n">create_mirror</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"r"</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="s2">"spine_04"</span><span class="p">)</span> +</pre></div> +</div> +</div> +<div class="section" id="accessing-component-data"> +<h2>Accessing Component Data<a class="headerlink" href="#accessing-component-data" title="Permalink to this headline">¶</a></h2> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># In the example, components already exist in the scene, and we want to access information on the components.</span> +<span class="kn">import</span> <span class="nn">artv2.components.base_components.rig_asset</span> <span class="kn">as</span> <span class="nn">rig_asset</span> +<span class="kn">import</span> <span class="nn">artv2.components.biped_leg</span> <span class="kn">as</span> <span class="nn">leg</span> + +<span class="c1"># Assume this code has been run previously, which creates an asset and a leg component.</span> +<span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">RigAsset</span><span class="p">()</span> +<span class="n">leg_inst</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">()</span> + +<span class="c1"># Now assume Maya has been closed and re-opened, so the above variables are no longer valid.</span> +<span class="c1"># To get access to a specific component, pass in that component's network node in the scene:</span> +<span class="n">leg_inst</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">network_node</span><span class="o">=</span><span class="s2">"leg_metadata"</span><span class="p">)</span> + +<span class="c1"># Now let's gather info about the component</span> +<span class="k">print</span><span class="p">(</span><span class="n">leg_inst</span><span class="o">.</span><span class="n">joint_mover</span><span class="o">.</span><span class="n">get_movers</span><span class="p">())</span> +<span class="k">print</span><span class="p">(</span><span class="n">leg_inst</span><span class="o">.</span><span class="n">joint_mover</span><span class="o">.</span><span class="n">get_created_joints</span><span class="p">())</span> + +<span class="c1"># As in the previous example, we can also change properties of the leg, like the prefix, suffix, parent, etc.</span> +<span class="n">leg_inst</span><span class="o">.</span><span class="n">num_thigh_twists</span> <span class="o">=</span> <span class="mi">2</span> +</pre></div> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="components/components.html" class="btn btn-neutral float-right" title="Components" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../../technical_documentation.html" class="btn btn-neutral float-left" title="Technical Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/component_utils.html b/docs/build/sections/tech_docs/utilities/component_utils.html new file mode 100644 index 0000000..4592ab3 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/component_utils.html @@ -0,0 +1,662 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Component Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Error Utilities" href="error_utils.html" /> + <link rel="prev" title="General Utilities" href="general_utils.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Component Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/component_utils.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="component-utilities"> +<h1>Component Utilities<a class="headerlink" href="#component-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.component_utilities</p> +<span class="target" id="module-artv2.utilities.component_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains functions for returning information specific to components or functions that operate +specifically on components.</td> +</tr> +</tbody> +</table> +<dl class="function"> +<dt id="artv2.utilities.component_utilities.check_for_children"> +<code class="descname">check_for_children</code><span class="sig-paren">(</span><em>joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#check_for_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.check_for_children" title="Permalink to this definition">¶</a></dt> +<dd><p>Checks if the given joint has any child components that are using it as their parent.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>joint</strong> (<em>str</em>) – Name of joint to check.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns a list of components that were children of the joint.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str, []</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.check_for_mirror_parent"> +<code class="descname">check_for_mirror_parent</code><span class="sig-paren">(</span><em>joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#check_for_mirror_parent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.check_for_mirror_parent" title="Permalink to this definition">¶</a></dt> +<dd><p>Search the component that created the given joint to see if it has a mirror_component. If so, find the matching +mirrored joint to the given joint. For example, If the given joint is thigh_l, we can find out if the leg_l_metadata +node has a mirror component. If it does (leg_r_metadata), we find a matching joint in that component (thigh_r).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>joint</strong> – Joint name to search for a mirrored match</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of matching mirrored joint if found.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.constrain_joints_to_movers"> +<code class="descname">constrain_joints_to_movers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#constrain_joints_to_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.constrain_joints_to_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Constrains all deformation joints to their respective mover.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.create_duplicate_instance"> +<code class="descname">create_duplicate_instance</code><span class="sig-paren">(</span><em>network_node</em>, <em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#create_duplicate_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.create_duplicate_instance" title="Permalink to this definition">¶</a></dt> +<dd><p>Create a new module instance using the class name of the passed in network node.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>network_node</strong> – Component network node to pull class info off of</li> +<li><strong>prefix</strong> – Prefix to create the new instance with</li> +<li><strong>suffix</strong> – Suffix to create the new instance with</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">instance of component class</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.detect_joint_conflicts"> +<code class="descname">detect_joint_conflicts</code><span class="sig-paren">(</span><em>joints</em>, <em>all_joints</em>, <em>inst</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#detect_joint_conflicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.detect_joint_conflicts" title="Permalink to this definition">¶</a></dt> +<dd><p>When creating a component, detects if the component will create joints with names that other components also create. +This was mostly implemented to handle the edge case of a biped leg and hind leg both being present in the scene +with the same prefix and/or suffix.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>joints</strong> – The created joints of the newly built component.</li> +<li><strong>all_joints</strong> – All joints from other components in the scene.</li> +<li><strong>inst</strong> – The instance of the component class</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns True if there were conflicts present, False otherwise.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.find_associated_mover_from_joint"> +<code class="descname">find_associated_mover_from_joint</code><span class="sig-paren">(</span><em>joint_name</em>, <em>return_offset=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#find_associated_mover_from_joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.find_associated_mover_from_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets the name of the joint mover (global, but offset if global doesn’t exist) that corresponds to the given name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>joint_name</strong> (<em>str</em>) – The name of the joint whose corresponding mover to search for.</li> +<li><strong>return_offset</strong> (<em>bool</em>) – Whether to explicitly return the offset mover instead of the global mover.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The name of the joint mover that corresponds to the joint name.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.find_mover_data_from_name"> +<code class="descname">find_mover_data_from_name</code><span class="sig-paren">(</span><em>inst</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#find_mover_data_from_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.find_mover_data_from_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds the global mover(s), offset mover(s), and guide joint(s) associated with the given name. +:param inst: The component instance +:param name: Name to search nodes for +:return: List of nodes that contain search key [[global movers], [offset movers], [joints]]</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.find_owning_component"> +<code class="descname">find_owning_component</code><span class="sig-paren">(</span><em>joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#find_owning_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.find_owning_component" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a joint, find which component the joint belongs to (responsible for creating the joint) and return the +instance of that component class.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>joint</strong> (<em>str</em>) – name of the joint</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">instance of component class that created given joint</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.fix_dependencies"> +<code class="descname">fix_dependencies</code><span class="sig-paren">(</span><em>dependencies</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#fix_dependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.fix_dependencies" title="Permalink to this definition">¶</a></dt> +<dd><p>Fix dependencies of components that are parented under a component that has been changed or removed in a way that +affects other components, and set the parent of the affected components to the root.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dependencies</strong> – List of components that have been impacted by another component changing or being removed.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return a string list that details which components have had their root set to as their parent.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_all_component_names"> +<code class="descname">get_all_component_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_all_component_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_all_component_names" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a dictionary of all unique names of components in the scene. The value of each key is the metanode for that +component.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of component names with their corresponding metanodes</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_all_created_joints"> +<code class="descname">get_all_created_joints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_all_created_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_all_created_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Get all created joints from all components.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns a list of all joints that components will or have created.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str, []</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_all_rig_asset_nodes"> +<code class="descname">get_all_rig_asset_nodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_all_rig_asset_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_all_rig_asset_nodes" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns all rig asset (character) nodes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list (str) of all rig asset network node names.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_available_components"> +<code class="descname">get_available_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_available_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_available_components" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets all component classes that are available for installing into a scene.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of components where the key is the nice name of the component, and the value is a list +containing the category, the module path, and the class name.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_component_instance"> +<code class="descname">get_component_instance</code><span class="sig-paren">(</span><em>network_node</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_component_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_component_instance" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a network node for a module, create an instance of the module and return it.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>network_node</strong> (<em>PyNode</em>) – The name of the network node to gather the necessary information from to create an inst.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Module instance</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">class.instance</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_joint_labels"> +<code class="descname">get_joint_labels</code><span class="sig-paren">(</span><em>network_node</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_joint_labels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_joint_labels" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds not only the created joints for a component, but their base labels, the guide joints, and the offset mover. +This information is then returned in a dictionary with the format of:</p> +<blockquote> +<div>{base_label: [created_joint, connected_joint, offset_mover]}</div></blockquote> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>network_node</strong> (<em>str</em>) – The network node for the component</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of joint data {base_label: [created_joint, connected_joint, offset_mover]}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_mirror_components"> +<code class="descname">get_mirror_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_mirror_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_mirror_components" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a dictionary of components that have mirrors, wherein the format is (key = component, value = mirror).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">dictionary of components with their mirrors</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_rig_asset_node"> +<code class="descname">get_rig_asset_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_rig_asset_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_rig_asset_node" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the network node for the entire rig asset. If more than one asset node exists, an exception will be raised.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Network node name (str) that represents the entire asset.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.get_top_level_mover"> +<code class="descname">get_top_level_mover</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#get_top_level_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.get_top_level_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets the top-most global mover of a module.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<em>pymel.core.PyNode</em>) – PyNode of the mover group for the module.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns the name of the top-most global joint mover of the module.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.mirror_top_mover_grp"> +<code class="descname">mirror_top_mover_grp</code><span class="sig-paren">(</span><em>source_inst</em>, <em>mirrored_inst</em>, <em>mirror_attr='scaleX'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#mirror_top_mover_grp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.mirror_top_mover_grp" title="Permalink to this definition">¶</a></dt> +<dd><p>Because the top mover group of a component is constrained in all attributes, special consideration needs to be made +when initially creating a mirror of a component so that any values that have been added to the top mover group by +its parent mover get mirrored over to the newly mirrored instance. In this case, it’s a fairly brute force approach +where a locator is created at the source group’s location, then grouped and scaled across the world origin. The +mirrored group is then snapped to that locator.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>source_inst</strong> – instance of class that has created a mirror of itself.</li> +<li><strong>mirrored_inst</strong> – instance of the mirrored class.</li> +<li><strong>mirror_attr</strong> – which attribute to scale when mirroring the group.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.pin_all_components"> +<code class="descname">pin_all_components</code><span class="sig-paren">(</span><em>pin=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#pin_all_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.pin_all_components" title="Permalink to this definition">¶</a></dt> +<dd><p>Pins all components in place, so that their parents do not affect them.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pin</strong> – Whether or not to pin or unpin.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.return_all_components"> +<code class="descname">return_all_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#return_all_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.return_all_components" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns all network nodes belonging to components.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list (str) of all rig module network node names.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.setup_global_scale"> +<code class="descname">setup_global_scale</code><span class="sig-paren">(</span><em>mover</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#setup_global_scale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.setup_global_scale" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets up an aliasAttr so that only uniform scale is possible.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mover</strong> (<em>str</em>) – Name of the node to setup the uniform scale.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.unconstrain_joints_to_movers"> +<code class="descname">unconstrain_joints_to_movers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#unconstrain_joints_to_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.unconstrain_joints_to_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Removes constraints on all deformation joints from their respective mover.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.validate_asset_name"> +<code class="descname">validate_asset_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#validate_asset_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.validate_asset_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Ensures that the given name is a valid name for Maya. +:param str name: The name to validate. +:return: Returns True if name is valid, otherwise False.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.validate_prefix"> +<code class="descname">validate_prefix</code><span class="sig-paren">(</span><em>metanode</em>, <em>prefix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#validate_prefix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.validate_prefix" title="Permalink to this definition">¶</a></dt> +<dd><p>Ensures that the given prefix is a valid name for Maya, as well as ensuring it has a trailing underscore. +Also ensures that no other module exists with the new name, factoring in the adjusted prefix.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>metanode</strong> – The rig module’s network node name.</li> +<li><strong>prefix</strong> – The prefix to validate.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns a valid prefix as a string. If the prefix was invalid, returns False</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.component_utilities.validate_suffix"> +<code class="descname">validate_suffix</code><span class="sig-paren">(</span><em>metanode</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/component_utilities.html#validate_suffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.component_utilities.validate_suffix" title="Permalink to this definition">¶</a></dt> +<dd><p>Ensures that the given suffix is a valid name for Maya, as well as ensuring it has a leading underscore. +Also ensures that no other module exists with the new name, factoring in the adjusted suffix.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>metanode</strong> – The rig module’s network node name.</li> +<li><strong>suffix</strong> – The suffix to validate.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns a valid suffix as a string. If the suffix was invalid, returns False</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="error_utils.html" class="btn btn-neutral float-right" title="Error Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="general_utils.html" class="btn btn-neutral float-left" title="General Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/control_utilities.html b/docs/build/sections/tech_docs/utilities/control_utilities.html new file mode 100644 index 0000000..a0268d1 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/control_utilities.html @@ -0,0 +1,318 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Control Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Rigging Utilities" href="rigging_utilities.html" /> + <link rel="prev" title="Joint Mover Utilities" href="joint_mover_utils.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Control Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/control_utilities.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="control-utilities"> +<h1>Control Utilities<a class="headerlink" href="#control-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.control_utilities</p> +<span class="target" id="module-artv2.utilities.control_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module provides utilities for building and setting control shapes. There is a class that builds a simple +interface that presents some of these features, like capturing/saving new control shapes, as well as editing the +names of control shapes.</td> +</tr> +</tbody> +</table> +<p>Special thanks to Vasil Shotarov : +<a class="reference external" href="https://bindpose.com/creating-maya-control-shape-manager/">https://bindpose.com/creating-maya-control-shape-manager/</a></p> +<dl class="class"> +<dt id="artv2.utilities.control_utilities.ControlManagerUI"> +<em class="property">class </em><code class="descname">ControlManagerUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#ControlManagerUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.ControlManagerUI" title="Permalink to this definition">¶</a></dt> +<dd><p>This class provides a user interface with methods to store new control shapes and edit existing control shapes.</p> +<img alt="../../../_images/ControlShapeManager.png" src="../../../_images/ControlShapeManager.png" /> +<p>Functions:</p> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Capture</span> <span class="pre">Control</span> <span class="pre">Shape()</span></code></p> +<blockquote> +<div>This allows you to create a new control shape in Maya, and then capture that data and save it to a text file +for recreation later.</div></blockquote> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">View</span> <span class="pre">Saved</span> <span class="pre">Shape</span> <span class="pre">List()</span></code></p> +<blockquote> +<div>Opens a list widget that shows the shapes that have been saved to disk. You can also choose to preview them.</div></blockquote> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">Shapes()</span></code></p> +<blockquote> +<div>Opens a list widget that allows you to rename or delete the shapes.</div></blockquote> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.get_all_shapes"> +<code class="descname">get_all_shapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_all_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_all_shapes" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets and returns all shape files.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.get_knots"> +<code class="descname">get_knots</code><span class="sig-paren">(</span><em>crv_shape=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_knots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_knots" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets the knots for the given curve shape.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.get_shape"> +<code class="descname">get_shape</code><span class="sig-paren">(</span><em>crv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_shape" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a dictionary containing all the necessery information for rebuilding the passed in crv.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.load_all_shapes"> +<code class="descname">load_all_shapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#load_all_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.load_all_shapes" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads all shapes into memory into a dictionary and returns that dictionary.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.load_shape"> +<code class="descname">load_shape</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#load_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.load_shape" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads the data that makes up the control shape from the given file.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.set_shape"> +<code class="descname">set_shape</code><span class="sig-paren">(</span><em>crv</em>, <em>crv_shape_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#set_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.set_shape" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a new shape on the crv transform, using the properties in the crvShapeDict.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows the ControlManagerUI window.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.store_shape"> +<code class="descname">store_shape</code><span class="sig-paren">(</span><em>shape_data</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#store_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.store_shape" title="Permalink to this definition">¶</a></dt> +<dd><p>Stores the data that makes up the control shape to a file.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.control_utilities.validate_curve"> +<code class="descname">validate_curve</code><span class="sig-paren">(</span><em>crv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#validate_curve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.validate_curve" title="Permalink to this definition">¶</a></dt> +<dd><p>Checks whether the transform we are working with is actually a curve and returns it’s shapes</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="rigging_utilities.html" class="btn btn-neutral float-right" title="Rigging Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="joint_mover_utils.html" class="btn btn-neutral float-left" title="Joint Mover Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/error_utils.html b/docs/build/sections/tech_docs/utilities/error_utils.html new file mode 100644 index 0000000..fd75ce1 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/error_utils.html @@ -0,0 +1,293 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Error Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Interface Utilities" href="interface_utils.html" /> + <link rel="prev" title="Component Utilities" href="component_utils.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Error Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/error_utils.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="error-utilities"> +<h1>Error Utilities<a class="headerlink" href="#error-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.error_utilities</p> +<span class="target" id="module-artv2.utilities.error_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body"><p class="first">Jeremy Ernst</p> +</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body"><p class="first">This module contains functions for raising errors or warnings, depending on if the tools are being run in batch mode +or in testing mode, or neither (normal mode.</p> +<p class="last">There are also classes for displaying widgets showing the error or warning message.</p> +</td> +</tr> +</tbody> +</table> +<dl class="function"> +<dt id="artv2.utilities.error_utilities.inform_user"> +<code class="descname">inform_user</code><span class="sig-paren">(</span><em>message</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/error_utilities.html#inform_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.error_utilities.inform_user" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows a widget (QMessageBox) with the given message if the tools are not being run in batch or test mode.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>message</strong> – Generalized message describing the information to relay to the user.</li> +<li><strong>details</strong> – Detailed information related to the message</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.error_utilities.raise_error"> +<code class="descname">raise_error</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/error_utilities.html#raise_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.error_utilities.raise_error" title="Permalink to this definition">¶</a></dt> +<dd><p>Shows a widget (QMessageBox) with the error message if the tools are not being run in batch or test mode. Otherwise, +it will just raise a normal RuntimeError with the message.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> – Detailed message describing the error.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.error_utilities.report_issues"> +<code class="descname">report_issues</code><span class="sig-paren">(</span><em>issues</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/error_utilities.html#report_issues"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.error_utilities.report_issues" title="Permalink to this definition">¶</a></dt> +<dd><p>Reports the given dependency issues to the user.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>issues</strong> – List of strings of components who have been affected by an operation.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="interface_utils.html" class="btn btn-neutral float-right" title="Interface Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="component_utils.html" class="btn btn-neutral float-left" title="Component Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/general_utils.html b/docs/build/sections/tech_docs/utilities/general_utils.html new file mode 100644 index 0000000..d724391 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/general_utils.html @@ -0,0 +1,717 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>General Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Component Utilities" href="component_utils.html" /> + <link rel="prev" title="Utilities" href="utilities.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>General Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/general_utils.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="general-utilities"> +<h1>General Utilities<a class="headerlink" href="#general-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.general_utilities</p> +<span class="target" id="module-artv2.utilities.general_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module provides utilities usually for retrieving information, handling paths, building strings, saving and +loading data, etc.</td> +</tr> +</tbody> +</table> +<dl class="function"> +<dt id="artv2.utilities.general_utilities.convert_to_pynodes"> +<code class="descname">convert_to_pynodes</code><span class="sig-paren">(</span><em>nodes</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#convert_to_pynodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.convert_to_pynodes" title="Permalink to this definition">¶</a></dt> +<dd><p>Converts the incoming nodes to PyNodes and returns them.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nodes</strong> – String list of nodes to convert.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of PyNodes</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.create_asset"> +<code class="descname">create_asset</code><span class="sig-paren">(</span><em>asset_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#create_asset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.create_asset" title="Permalink to this definition">¶</a></dt> +<dd><p>Create a container asset with the given asset name and return the created container. +:param asset_name: Name for container. +:return: pyNode of created asset.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.create_clipboard"> +<code class="descname">create_clipboard</code><span class="sig-paren">(</span><em>name</em>, <em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#create_clipboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.create_clipboard" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a clipboard with the given name writing the given data to the clipboard.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>name</strong> – The name of the file. It will be added to the temp dir.</li> +<li><strong>data</strong> – The data to write to the file</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The clipboard file</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.create_trailing_number"> +<code class="descname">create_trailing_number</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#create_trailing_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.create_trailing_number" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a trailing number string with a padded 0 if the number is less than or equal to 9. Example 08 or 18.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – The value to crates a trailing number in string format for</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">string</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.delete_node"> +<code class="descname">delete_node</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#delete_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.delete_node" title="Permalink to this definition">¶</a></dt> +<dd><p>Deletes node, but first makes sure the node is not locked. +:param node: DAG node to delete +:type node: PyNode</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.filter_directory_contents"> +<code class="descname">filter_directory_contents</code><span class="sig-paren">(</span><em>path</em>, <em>filters</em>, <em>ext_filters</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#filter_directory_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.filter_directory_contents" title="Permalink to this definition">¶</a></dt> +<dd><p>Filter the contents from the incoming path using the provided filters and extension filters. This is only checking +for files.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>path</strong> – The path to list contents and the filter the contents.</li> +<li><strong>filters</strong> – The filters to look for before the file extension for exclusion.</li> +<li><strong>ext_filters</strong> – The file extensions to look for for exclusion.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of filtered contents.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.filter_nodes"> +<code class="descname">filter_nodes</code><span class="sig-paren">(</span><em>nodes</em>, <em>filter_by='transform'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#filter_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.filter_nodes" title="Permalink to this definition">¶</a></dt> +<dd><p>Filters the given nodes by the given type and returns the filtered nodes as a list. +:param nodes: List of nodes to filter. +:param str filter_by: Types of nodes to return. +:return: List of filtered nodes.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.frame_selected"> +<code class="descname">frame_selected</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#frame_selected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.frame_selected" title="Permalink to this definition">¶</a></dt> +<dd><p>Frame the camera up on the current selection.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.generate_prefix_suffix"> +<code class="descname">generate_prefix_suffix</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#generate_prefix_suffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.generate_prefix_suffix" title="Permalink to this definition">¶</a></dt> +<dd><p>Tries to generate a mirrored prefix or suffix given the input string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string to try and create a mirrored version.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns a string with the prefix or suffix. If a match in the dict was found, it will return a mirrored</td> +</tr> +</tbody> +</table> +<p>version. Otherwise, it simply returns the input string. For example, given a component name of clavicle_joint_l, +where the prefix is clavicle and the suffix is l, passing clavicle into this function simply retruns clavicle. +Passing l into the function will return r. So, if a component passes its prefix and suffix to this function to try +and generate a mirrored version, you would get clavicle and r.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.generate_unique_suffix"> +<code class="descname">generate_unique_suffix</code><span class="sig-paren">(</span><em>existing</em>, <em>inst</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#generate_unique_suffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.generate_unique_suffix" title="Permalink to this definition">¶</a></dt> +<dd><p>Generates a unique suffix to avoid naming conflicts when duplicating components.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>existing</strong> – Dict of existing components in the scene.</li> +<li><strong>inst</strong> – instance of component that is being duplicated.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns a string with the unique suffix.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.get_class_properties"> +<code class="descname">get_class_properties</code><span class="sig-paren">(</span><em>cls</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#get_class_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.get_class_properties" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a class, retrieve the properties of the class (as indicated by the @property decorator)</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cls</strong> – class instance</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dict of property names and values</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.get_control_shapes"> +<code class="descname">get_control_shapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#get_control_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.get_control_shapes" title="Permalink to this definition">¶</a></dt> +<dd><p>Looks in the resources directory to find the control shapes and returns the name of the files without the extension.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns a list of the names of the files without the extension.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.get_control_shapes_as_enum"> +<code class="descname">get_control_shapes_as_enum</code><span class="sig-paren">(</span><em>shapes_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#get_control_shapes_as_enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.get_control_shapes_as_enum" title="Permalink to this definition">¶</a></dt> +<dd><p>Takes in a list of control shapes (usually generated from get_control_shapes()), and builds an enum string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>shapes_list</strong> – A list of strings.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A string that is build to be used as an enum for a Maya enum attribute (ex: circle:square:cube)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.get_joints_in_hierarchy"> +<code class="descname">get_joints_in_hierarchy</code><span class="sig-paren">(</span><em>root=None</em>, <em>as_pynode=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#get_joints_in_hierarchy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.get_joints_in_hierarchy" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets the joints in a hierarchy and returns them. If a root joint is given, it will search from there. If not, +it will select everything in the scene and find the joints that way instead. +:param root: (Optional) Name of joint at the top of the hierarchy you wish to search. +:param as_pynode: Bool as whether to return the list as PyNodes or strings. +:return: Returns either a list of PyNodes or strings of the joints in the hierarchy.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.get_root_joint_of_component"> +<code class="descname">get_root_joint_of_component</code><span class="sig-paren">(</span><em>joints</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#get_root_joint_of_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.get_root_joint_of_component" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds and returns the top-most joint of a component.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>joints</strong> – List of Pynodes of joints from the component.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Pynode of top-most joint.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.import_file"> +<code class="descname">import_file</code><span class="sig-paren">(</span><em>path</em>, <em>return_nodes=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#import_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.import_file" title="Permalink to this definition">¶</a></dt> +<dd><p>Imports the given file into Maya. +:param path: Path of file to import +:param return_nodes: Whether or not to return created nodes. +:return: list of imported nodes</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.launch_web_docs"> +<code class="descname">launch_web_docs</code><span class="sig-paren">(</span><em>page</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#launch_web_docs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.launch_web_docs" title="Permalink to this definition">¶</a></dt> +<dd><p>Launches the given html file in a web browser.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>page</strong> – string file path of html file.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.load_from_file"> +<code class="descname">load_from_file</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#load_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.load_from_file" title="Permalink to this definition">¶</a></dt> +<dd><p>Loads data (using JSON) for the given file and returns the data loaded.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – The file path to load data from.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data from the file.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.parent_object"> +<code class="descname">parent_object</code><span class="sig-paren">(</span><em>child</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#parent_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.parent_object" title="Permalink to this definition">¶</a></dt> +<dd><p>Parents the child to the parent object.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>child</strong> (<em>str</em>) – Name of node to be parented.</li> +<li><strong>parent</strong> (<em>str</em>) – Name of node that will be the parent.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.path_join"> +<code class="descname">path_join</code><span class="sig-paren">(</span><em>path_base</em>, <em>path_tail</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#path_join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.path_join" title="Permalink to this definition">¶</a></dt> +<dd><p>Take the incoming path and file and use os.path.join to create a new file path. Then replace all +back slashes with forward slashes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>path_base</strong> (<em>str</em>) – First part of path to join.</li> +<li><strong>path_tail</strong> (<em>str</em>) – Second part of path to join.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Joined path with proper separators.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.path_unify"> +<code class="descname">path_unify</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#path_unify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.path_unify" title="Permalink to this definition">¶</a></dt> +<dd><p>Take the incoming path and replace back slashes with forward slashes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<em>str</em>) – Incoming path to manipulate.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Corrected path with correct separators.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.read_clipboard"> +<code class="descname">read_clipboard</code><span class="sig-paren">(</span><em>clipboard</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#read_clipboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.read_clipboard" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a clipboard file, read and return the data.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>clipboard</strong> – File path of the clipboard file.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data from file.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.rename_object"> +<code class="descname">rename_object</code><span class="sig-paren">(</span><em>pynode</em>, <em>new_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#rename_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.rename_object" title="Permalink to this definition">¶</a></dt> +<dd><p>Renames the incoming PyNode with the given new name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>pynode</strong> (<em>pymel.core.PyNode</em>) – PyNode that represents the object to rename.</li> +<li><strong>new_name</strong> (<em>str</em>) – The new name for the node.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.retrieve_clipboard"> +<code class="descname">retrieve_clipboard</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#retrieve_clipboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.retrieve_clipboard" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the file path to the clipboard with the given name</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – the name of the clipboard file</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The full file path to the clipboard</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.return_settings"> +<code class="descname">return_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#return_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.return_settings" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns ARTv2 settings for the paths to various needed directories.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Array of path names to directories needed by the tools.</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str, []</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.save_to_file"> +<code class="descname">save_to_file</code><span class="sig-paren">(</span><em>path</em>, <em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#save_to_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.save_to_file" title="Permalink to this definition">¶</a></dt> +<dd><p>Dumps the given data (using JSON) to the given path.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>path</strong> – Path to write data to on disk.</li> +<li><strong>data</strong> – Data to dump to file.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.set_attribute"> +<code class="descname">set_attribute</code><span class="sig-paren">(</span><em>node</em>, <em>attr</em>, <em>value</em>, <em>attr_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#set_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.set_attribute" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets an attribute on the given node to the given value. Ensures node and attribute is unlocked before doing so, and +re-locks them after.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>node</strong> (<em>pm.PyNode</em>) – Node to set attribute on.</li> +<li><strong>attr</strong> (<em>str</em>) – Attribute on node to set.</li> +<li><strong>value</strong> (<em>float</em><em>, </em><em>int</em><em>, </em><em>bool</em><em>, </em><em>string</em>) – Value to set attribute to.</li> +<li><strong>attr_type</strong> (<em>str</em>) – Whether or not a special type needs to be defined (string, bool, etc)</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.strip_name"> +<code class="descname">strip_name</code><span class="sig-paren">(</span><em>name_to_strip</em>, <em>prefix</em>, <em>base_name</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#strip_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.strip_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Strip a name down to whatever is left after removing the prefix, base name, and suffix.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>name_to_strip</strong> (<em>str</em>) – The name to tokenize.</li> +<li><strong>prefix</strong> (<em>str</em>) – The prefix to remove from the name.</li> +<li><strong>base_name</strong> (<em>str</em><em>, </em><em>None</em>) – The base name of the component to remove from the name.</li> +<li><strong>suffix</strong> (<em>str</em>) – The suffix to remove from the name.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The name with the prefix, suffix, and base name removed.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.general_utilities.validate_integer"> +<code class="descname">validate_integer</code><span class="sig-paren">(</span><em>value</em>, <em>int_min</em>, <em>int_max</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/general_utilities.html#validate_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.general_utilities.validate_integer" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a value, validate that it is a whole number that is greater than or equal to the minimum and less than or +equal to the maximum given values.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>value</strong> – The value to check</li> +<li><strong>int_min</strong> – The minimum the value can be</li> +<li><strong>int_max</strong> – The maximum the value can be</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">(bool) True if value is meets conditions. False otherwise.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="component_utils.html" class="btn btn-neutral float-right" title="Component Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="utilities.html" class="btn btn-neutral float-left" title="Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/interface_utils.html b/docs/build/sections/tech_docs/utilities/interface_utils.html new file mode 100644 index 0000000..7196333 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/interface_utils.html @@ -0,0 +1,407 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Interface Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Joint Mover Utilities" href="joint_mover_utils.html" /> + <link rel="prev" title="Error Utilities" href="error_utils.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Interface Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/interface_utils.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="interface-utilities"> +<h1>Interface Utilities<a class="headerlink" href="#interface-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.interface_utilities</p> +<span class="target" id="module-artv2.utilities.interface_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module provides utilities for general QT functions and classes to be used as widgets or templates.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.ARTv2Dialog"> +<em class="property">class </em><code class="descname">ARTv2Dialog</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>window_title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Dialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Dialog" title="Permalink to this definition">¶</a></dt> +<dd><p>Abstract class that adds some extra default functionality for things like grabbing settings, dealing with +different screen resolutions, styling the UI, and saving screen position. This class is not meant to be +instantiated on its own.</p> +</dd></dl> + +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.ARTv2Message"> +<em class="property">class </em><code class="descname">ARTv2Message</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>title</em>, <em>critical=False</em>, <em>warning=False</em>, <em>info=False</em>, <em>question=False</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Message" title="Permalink to this definition">¶</a></dt> +<dd><p>Abstract class that adds extra functionality onto QMessageBox. Depending on the message type (warning, error, etc), +different buttons and icons will be shown. This class is not meant to be instantiated on its own.</p> +</dd></dl> + +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.ARTv2Window"> +<em class="property">class </em><code class="descname">ARTv2Window</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>window_title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window" title="Permalink to this definition">¶</a></dt> +<dd><p>Abstract class that adds some extra default functionality for things like grabbing settings, dealing with +different screen resolutions, styling the UI, and saving screen position. This class is not meant to be +instantiated on its own.</p> +<dl class="method"> +<dt id="artv2.utilities.interface_utilities.ARTv2Window.closeEvent"> +<code class="descname">closeEvent</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window.closeEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window.closeEvent" title="Permalink to this definition">¶</a></dt> +<dd><p>Override QMainWindow’s close event to remember window position.</p> +</dd></dl> + +<dl class="staticmethod"> +<dt id="artv2.utilities.interface_utilities.ARTv2Window.launch_help_doc"> +<em class="property">static </em><code class="descname">launch_help_doc</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window.launch_help_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window.launch_help_doc" title="Permalink to this definition">¶</a></dt> +<dd><p>Launches a html page from the artv2 help documents.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – The path of the html file to launch.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.ConfirmWidget"> +<em class="property">class </em><code class="descname">ConfirmWidget</code><span class="sig-paren">(</span><em>message</em>, <em>details</em>, <em>title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ConfirmWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ConfirmWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>Simple class that displays a QMessageBox widget with a question, a question icon, and Yes or Cancel buttons. +Takes in a string message to display, a string for any detailed text to display, and a string for the title.</p> +</dd></dl> + +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.ErrorWidget"> +<em class="property">class </em><code class="descname">ErrorWidget</code><span class="sig-paren">(</span><em>message</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ErrorWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ErrorWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>Simple class that displays a QMessageBox widget with an error message, and error icon, and a simple “OK” button. +Takes in a string message to display.</p> +<img alt="../../../_images/errorWidget.png" src="../../../_images/errorWidget.png" /> +</dd></dl> + +<dl class="class"> +<dt id="artv2.utilities.interface_utilities.InfoWidget"> +<em class="property">class </em><code class="descname">InfoWidget</code><span class="sig-paren">(</span><em>message</em>, <em>details</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#InfoWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.InfoWidget" title="Permalink to this definition">¶</a></dt> +<dd><p>Simple class that displays a QMessageBox widget with an error message, and error icon, and a simple “OK” button. +This class takes in required arguments: A string message, and a string for details. The details string could be +empty if not required.</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="n">ui_utils</span><span class="o">.</span><span class="n">InfoWidget</span><span class="p">(</span><span class="s2">"this is an info widget"</span><span class="p">,</span> <span class="s2">"these are some details</span><span class="se">\n</span><span class="s2">as are these"</span><span class="p">)</span> +</pre></div> +</div> +<img alt="../../../_images/infoWidget.png" src="../../../_images/infoWidget.png" /> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.clear_layout"> +<code class="descname">clear_layout</code><span class="sig-paren">(</span><em>layout</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#clear_layout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.clear_layout" title="Permalink to this definition">¶</a></dt> +<dd><p>Clears the given layout of all child widgets.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.create_style_sheet"> +<code class="descname">create_style_sheet</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#create_style_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.create_style_sheet" title="Permalink to this definition">¶</a></dt> +<dd><p>Take in a read stylesheet, and replace any urls with actual file paths, then return the altered data.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.filter_list"> +<code class="descname">filter_list</code><span class="sig-paren">(</span><em>list_widget</em>, <em>search_widget</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#filter_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.filter_list" title="Permalink to this definition">¶</a></dt> +<dd><p>Filters the list widget by the search term in the given search widget.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>list_widget</strong> – QListWidget widget to filter items in.</li> +<li><strong>search_widget</strong> – QLineEdit widget to grab text from for search term.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.get_items"> +<code class="descname">get_items</code><span class="sig-paren">(</span><em>list_widget</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_items" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a list widget, get and return the text and pointer to the list widget item in a dict.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list_widget</strong> – List widget to query items from.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns a dict of the listWidgetItems’ text and pointer to the items.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.get_maya_dpi"> +<code class="descname">get_maya_dpi</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_maya_dpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_maya_dpi" title="Permalink to this definition">¶</a></dt> +<dd><p>Gets the DPI setting value in Maya and returns the multiplier.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.get_maya_window"> +<code class="descname">get_maya_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_maya_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_maya_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Return Maya’s main window as a QWidget</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.get_style_sheet"> +<code class="descname">get_style_sheet</code><span class="sig-paren">(</span><em>file_path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_style_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_style_sheet" title="Permalink to this definition">¶</a></dt> +<dd><p>Read the style sheet data, and then replace any urls with proper file paths on the user’s drive.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.scale_by_dpi"> +<code class="descname">scale_by_dpi</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#scale_by_dpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.scale_by_dpi" title="Permalink to this definition">¶</a></dt> +<dd><p>Scales the given value by the dpi multiplier.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.search_list_widget"> +<code class="descname">search_list_widget</code><span class="sig-paren">(</span><em>search_field</em>, <em>list_widget</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#search_list_widget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.search_list_widget" title="Permalink to this definition">¶</a></dt> +<dd><p>Searches the given list_widget for items with the search term in the given search_field. Items that do not match are +hidden in the list.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>search_field</strong> – The QLineEdit to grab the search term from</li> +<li><strong>list_widget</strong> – the QListWidget to manipulate</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.interface_utilities.toggle_group"> +<code class="descname">toggle_group</code><span class="sig-paren">(</span><em>ctrl</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#toggle_group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.toggle_group" title="Permalink to this definition">¶</a></dt> +<dd><p>Sets the given ctrl (groupbox) height based on the check state.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="joint_mover_utils.html" class="btn btn-neutral float-right" title="Joint Mover Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="error_utils.html" class="btn btn-neutral float-left" title="Error Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/joint_mover_utils.html b/docs/build/sections/tech_docs/utilities/joint_mover_utils.html new file mode 100644 index 0000000..43bafbe --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/joint_mover_utils.html @@ -0,0 +1,562 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Joint Mover Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Control Utilities" href="control_utilities.html" /> + <link rel="prev" title="Interface Utilities" href="interface_utils.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Joint Mover Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/joint_mover_utils.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="joint-mover-utilities"> +<h1>Joint Mover Utilities<a class="headerlink" href="#joint-mover-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.joint_mover_utilities</p> +<span class="target" id="module-artv2.utilities.joint_mover_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains helper functions for dealing with joint movers and creating joint movers. The class +JointMoverUtils, is a UI with methods to aid in joint mover creation, such as marking up joints with parameters that +get used when auto-generating the mover controls.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="artv2.utilities.joint_mover_utilities.JointMoverUtils"> +<em class="property">class </em><code class="descname">JointMoverUtils</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#JointMoverUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.JointMoverUtils" title="Permalink to this definition">¶</a></dt> +<dd><p>This class provides a user interface with methods to aid in joint mover file creation.</p> +<img alt="../../../_images/JointMoverUtils.png" src="../../../_images/JointMoverUtils.png" /> +<p>Functions:</p> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Markup</span> <span class="pre">Joints()</span></code></p> +<blockquote> +<div>Marks joints up with attributes that will be used when the JointMover class builds the controls on top of the +joints. These attributes tell the JointMover class which control shape to use, how big the control is, +what the offset is, if the joint should aim at the child, and if the joint is a twist joint.</div></blockquote> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Create</span> <span class="pre">Preview</span> <span class="pre">Movers()</span></code></p> +<blockquote> +<div>Creates joint mover controls for the selected joints using the markup data on the joints (such as control +size, control shape, and control offset).</div></blockquote> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Delete</span> <span class="pre">Preview</span> <span class="pre">Movers()</span></code></p> +<blockquote> +<div><p>Deletes the preview movers.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Don’t leave preview movers in your scene!</p> +</div> +</div></blockquote> +<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Remove</span> <span class="pre">All</span> <span class="pre">Markups()</span></code></p> +<blockquote> +<div>Removes two attributes which populate their enums at the time of markup: aimJoint and controlType. By removing +these, you can then re-markup the joints, and only those two attributes will be added, with updated enums. For +example, if a new control shape is added, that shape will not appear in the enum attribute until you remove and +re-markup.</div></blockquote> +<dl class="staticmethod"> +<dt id="artv2.utilities.joint_mover_utilities.JointMoverUtils.remove_markups"> +<em class="property">static </em><code class="descname">remove_markups</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#JointMoverUtils.remove_markups"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.JointMoverUtils.remove_markups" title="Permalink to this definition">¶</a></dt> +<dd><p>Removes the aimJoint and controlType attributes from the joints so they can be re-added with updated +information.</p> +</dd></dl> + +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.create_mover"> +<code class="descname">create_mover</code><span class="sig-paren">(</span><em>shape_data</em>, <em>jnt</em>, <em>key='mover'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#create_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.create_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates the joint mover control for the given joint, using the given file path for which shape to use.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>shape_data</strong> (<em>str list/dict</em>) – The shape data that makes up the control shape (knots, points, etc)</li> +<li><strong>jnt</strong> (<em>PyNode</em>) – The joint to create the mover for.</li> +<li><strong>key</strong> (<em>str</em>) – Whether to create a global mover (key=”mover”) or an offset mover (key=”mover_offset”)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns the created mover group and mover control nodes.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[], PyNode</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.create_mover_containers"> +<code class="descname">create_mover_containers</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#create_mover_containers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.create_mover_containers" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates containers for the various nodes that get created when building the joint mover. This includes an overall +container for the entire asset, an overall container for this component, and then containers for the mover +controls themselves and the utility nodes that get created when hooking up the joints to the offset movers.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) – The unique name of the component.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns the created PyNode containers.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.create_movers_from_joints"> +<code class="descname">create_movers_from_joints</code><span class="sig-paren">(</span><em>name</em>, <em>joint_hierarchy_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#create_movers_from_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.create_movers_from_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a joint hierarchy that has had the joints marked up, create joint mover controls for each joint based on +those mark-up parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>name</strong> (<em>str</em>) – Unique name of the component.</li> +<li><strong>joint_hierarchy_root</strong> – The top of the skeletal hierarchy that we want to create joint movers from.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Returns a dictionary of PyNodes where the keys are the joint PyNodes, and the values of each are the +mover nodes created for that joint.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.drive_joints_with_movers"> +<code class="descname">drive_joints_with_movers</code><span class="sig-paren">(</span><em>mover_data</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#drive_joints_with_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.drive_joints_with_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Hook up the joints so that they are driven by the offset mover that was created from said joint.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>mover_data</strong> – The dictionary of PyNodes that has the joint as the key, and the created movers as the value.</li> +<li><strong>name</strong> – The unique name of the component.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.drive_joints_with_offsets"> +<code class="descname">drive_joints_with_offsets</code><span class="sig-paren">(</span><em>mover</em>, <em>jnt</em>, <em>main_asset</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#drive_joints_with_offsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.drive_joints_with_offsets" title="Permalink to this definition">¶</a></dt> +<dd><p>Takes the given joint mover control and the given joint, and hooks them up so the mover drives the joint’s +translation and rotation.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>mover</strong> (<em>PyNode</em>) – Joint mover offset control transform.</li> +<li><strong>jnt</strong> (<em>PyNode</em>) – The joint to drive translation and rotations on.</li> +<li><strong>main_asset</strong> (<em>PyNode</em>) – The container to add the created utility nodes to.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.get_enum_joints"> +<code class="descname">get_enum_joints</code><span class="sig-paren">(</span><em>current_joint</em>, <em>root</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#get_enum_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.get_enum_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Create an enum string with all the joints in the component hierarchy excluding the given current joint.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>current_joint</strong> – The current joint which is getting the enum attribute.</li> +<li><strong>root</strong> – The root joint of the component hierarchy</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">an enum string for Maya’s addAttr (“red:green:blue”)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.mark_joint_movers"> +<code class="descname">mark_joint_movers</code><span class="sig-paren">(</span><em>mover_data</em>, <em>name</em>, <em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#mark_joint_movers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.mark_joint_movers" title="Permalink to this definition">¶</a></dt> +<dd><p>Marks the joint mover controls with metadata attributes. For example, is the given node a mover control, +or just a buffer group? What is the mover type? Which component does this mover belong to?</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>mover_data</strong> – The joint mover nodes (PyNodes) that have been created.</li> +<li><strong>name</strong> (<em>str</em>) – The component’s unique name.</li> +<li><strong>prefix</strong> (<em>str</em>) – The component’s prefix.</li> +<li><strong>suffix</strong> (<em>str</em>) – The component’s suffix.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.markup_joints"> +<code class="descname">markup_joints</code><span class="sig-paren">(</span><em>joints=None</em>, <em>root_joint=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#markup_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.markup_joints" title="Permalink to this definition">¶</a></dt> +<dd><blockquote> +<div><p>Finds joints in the file, and marks them up with attributes that will be used when building the joint mover +controls. These attributes are things like: the control shape to build, the size of the control, the +offset to apply to the control, whether the joint is a twist joint, etc.</p> +<p>Below, you will find a glossary of the attributes and what their intended use is.</p> +<dl class="glossary docutils"> +</dl> +</div></blockquote> +<p><strong>Can Aim</strong></p> +<blockquote> +<div>Whether this joint should aim at another joint when aim mode is turned on.</div></blockquote> +<p><strong>Aim Joint</strong></p> +<blockquote> +<div>Which joint this joint should aim at when aim mode is turned on. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Aim Axis</strong></p> +<blockquote> +<div>Which axis represents the aim axis. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Invert Aim Axis</strong></p> +<blockquote> +<div>If the aim axis should be inverted. (If your aim axis is set to X, but needs to be -X, this would be True) +(This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Up Axis</strong></p> +<blockquote> +<div>The axis of the joint that is closes to the world up axis. (This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Maintain Offset</strong></p> +<blockquote> +<div>This will probably not ever need to be used, but in the case of some special circumstance, this will create the +aim constraint while maintaining offsets. +(This is ignored if Can Aim is False)</div></blockquote> +<p><strong>Twist Joint</strong></p> +<blockquote> +<div>Whether the joint is to be setup as a twist joint. A twist joint gets no global mover control. Instead it +gets an offset mover that is only unlocked along the length axis, and is automatically driven to keep equal +spacing between the start joint and end joint (calf and foot for example).</div></blockquote> +<p><strong>Control Type</strong></p> +<blockquote> +<div>The shape that the joint mover control should have. This list is populated by the files located in +/resources/control_shapes.</div></blockquote> +<p><strong>Control Size</strong></p> +<blockquote> +<div>The scale factor to create the control at. If you use the “Create Preview Movers” button in the markup tool, +you can then set this value in order to see how the control will be built and at what size.</div></blockquote> +<p><strong>Control Offset X, Y, Z</strong></p> +<blockquote> +<div><p>When creating the control, the rotational offset to apply on creation.</p> +<img alt="../../../_images/joint_mover_markup_offset.gif" src="../../../_images/joint_mover_markup_offset.gif" /> +</div></blockquote> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.setup_cv_scaling"> +<code class="descname">setup_cv_scaling</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#setup_cv_scaling"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.setup_cv_scaling" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a setup where the current CV positions of the given node are multiplied by a value, which results in +changing its total size.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<em>PyNode</em>) – The transform node of the control</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of PyNodes that are the created multiplyDivide nodes.</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">[], PyNodes</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.setup_mover"> +<code class="descname">setup_mover</code><span class="sig-paren">(</span><em>jnt</em>, <em>shape_data</em>, <em>scale_factor</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#setup_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.setup_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a normal joint mover control setup for the given joint. Normal means that the joint receives a global +mover and an offset mover with buffer groups above each.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>jnt</strong> (<em>PyNode</em>) – The PyNode of the joint to create the setup.</li> +<li><strong>shape_data</strong> (<em>str list/dict</em>) – The data that makes up the control shape (knots, points, etc)</li> +<li><strong>scale_factor</strong> (<em>float</em>) – The amount to scale the control by.</li> +<li><strong>container</strong> (<em>PyNode</em>) – The container (PyNode) to add the created nodes to.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns a list of PyNodes where the first element is the joint PyNode, and the second element is a list +of the created mover nodes.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[], PyNode</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.setup_twist_mover"> +<code class="descname">setup_twist_mover</code><span class="sig-paren">(</span><em>jnt</em>, <em>control_path</em>, <em>scale_factor</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#setup_twist_mover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.setup_twist_mover" title="Permalink to this definition">¶</a></dt> +<dd><p>Creates a twist joint mover control setup for the given joint. A twist joint setup is no global mover, +and instead, a group that is driven by constraints to keep the twist joint along the X axis of the parent. Every +channel on the offset control except for TranslateX is locked as well, to keep the twist joint aligned properly.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>jnt</strong> (<em>PyNode</em>) – The PyNode of the joint to create the setup.</li> +<li><strong>control_path</strong> (<em>str</em>) – The path to the control shape file.</li> +<li><strong>scale_factor</strong> (<em>float</em>) – The amount to scale the control by.</li> +<li><strong>container</strong> (<em>PyNode</em>) – The container (PyNode) to add the created nodes to.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns a list of PyNodes where the first element is the joint PyNode, and the second element is a list +of the created mover nodes.</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[], PyNode</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.joint_mover_utilities.show_window"> +<code class="descname">show_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/joint_mover_utilities.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.joint_mover_utilities.show_window" title="Permalink to this definition">¶</a></dt> +<dd><p>Show the JointMoverUtils tool.</p> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="control_utilities.html" class="btn btn-neutral float-right" title="Control Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="interface_utils.html" class="btn btn-neutral float-left" title="Interface Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/rigging_utilities.html b/docs/build/sections/tech_docs/utilities/rigging_utilities.html new file mode 100644 index 0000000..6bf2e81 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/rigging_utilities.html @@ -0,0 +1,330 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Rigging Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Rigging Tools" href="../rigging_tools/rigging_tools.html" /> + <link rel="prev" title="Control Utilities" href="control_utilities.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li><a href="utilities.html">Utilities</a> »</li> + + <li>Rigging Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/rigging_utilities.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="rigging-utilities"> +<h1>Rigging Utilities<a class="headerlink" href="#rigging-utilities" title="Permalink to this headline">¶</a></h1> +<p>artv2.utilities.rigging_utilities</p> +<span class="target" id="module-artv2.utilities.rigging_utilities"></span><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td> +</tr> +<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module contains utilities for working with joints.</td> +</tr> +</tbody> +</table> +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.attr_is_settable"> +<code class="descname">attr_is_settable</code><span class="sig-paren">(</span><em>attribute</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#attr_is_settable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.attr_is_settable" title="Permalink to this definition">¶</a></dt> +<dd><p>Determines in the pymel Attribute object can be set (It may have keyframes, but cannot be connected or constrained).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>attribute</strong> – pymel.core.general.Attribute()</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">bool, True if attribute is settable, False if not.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.build_skeleton"> +<code class="descname">build_skeleton</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#build_skeleton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.build_skeleton" title="Permalink to this definition">¶</a></dt> +<dd><p>Builds a deformation skeleton based on the joint mover guide joints. +:return: root joint of newly created skeleton.</p> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.divide_joint"> +<code class="descname">divide_joint</code><span class="sig-paren">(</span><em>number</em>, <em>joint</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#divide_joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.divide_joint" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a joint, divide the segment below that joint by the given number.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>number</strong> – Number of divisions to divide a joint segment.</li> +<li><strong>joint</strong> – The top end joint of the joint segment to divide.</li> +<li><strong>name</strong> (<em>str</em>) – The base name of the component.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.remove_joints"> +<code class="descname">remove_joints</code><span class="sig-paren">(</span><em>number</em>, <em>joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#remove_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.remove_joints" title="Permalink to this definition">¶</a></dt> +<dd><p>Given a joint, remove the given number of joints above that joint.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>number</strong> – The number of parents to remove.</li> +<li><strong>joint</strong> – The joint to remove parents from.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.reset_joint_to_initial"> +<code class="descname">reset_joint_to_initial</code><span class="sig-paren">(</span><em>joint</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#reset_joint_to_initial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.reset_joint_to_initial" title="Permalink to this definition">¶</a></dt> +<dd><p>Resets the given joint to its initial creation position and orientation (defined by the rigging guide file).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>joint</strong> – The joint to reset position and orientation on.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="artv2.utilities.rigging_utilities.toggle_local_axis"> +<code class="descname">toggle_local_axis</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/rigging_utilities.html#toggle_local_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.rigging_utilities.toggle_local_axis" title="Permalink to this definition">¶</a></dt> +<dd><p>Toggles the visibility of the local rotation axis of all driven component joints with the given state.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> – Whether or not the local rotation axis should be visible (bool)</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../rigging_tools/rigging_tools.html" class="btn btn-neutral float-right" title="Rigging Tools" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="control_utilities.html" class="btn btn-neutral float-left" title="Control Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file diff --git a/docs/build/sections/tech_docs/utilities/utilities.html b/docs/build/sections/tech_docs/utilities/utilities.html new file mode 100644 index 0000000..ab528c3 --- /dev/null +++ b/docs/build/sections/tech_docs/utilities/utilities.html @@ -0,0 +1,240 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Utilities — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="General Utilities" href="general_utils.html" /> + <link rel="prev" title="Creating Your Own Component" href="../components/creating_custom_component.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"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<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="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li> +<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Utilities</a><ul> +<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li> +</ul> +</li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html">Docs</a> »</li> + + <li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li> + + <li>Utilities</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/sections/tech_docs/utilities/utilities.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="utilities"> +<h1>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="general_utils.html">General Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="component_utils.html">Component Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="error_utils.html">Error Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="general_utils.html" class="btn btn-neutral float-right" title="General Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../components/creating_custom_component.html" class="btn btn-neutral float-left" title="Creating Your Own Component" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file |