Uploading work on refactor

At this point, all components can build their skeletons. Next steps are to get components building their rigs.
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/tech_docs/components/pose.html
parent: fixed install.mel issue (diff)
download: artv2-75fa1d1810e98453960a81115d88302e276d817f.tar.xz
artv2-75fa1d1810e98453960a81115d88302e276d817f.zip
1 files changed, 302 insertions, 0 deletions
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 &mdash; 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> &raquo;</li>
+        
+          <li><a href="../../../technical_documentation.html">Technical Documentation</a> &raquo;</li>
+        
+          <li><a href="components.html">Components</a> &raquo;</li>
+        
+          <li><a href="base_classes.html">Base Classes</a> &raquo;</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 &quot;controls&quot;</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">&quot;root&quot;</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 &quot;test&quot;.</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">&quot;test&quot;</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 &quot;controls&quot;</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">&quot;root&quot;</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>
+        &copy; 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
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/tech_docs/components/pose.html
parent	fixed install.mel issue (diff)
download	artv2-75fa1d1810e98453960a81115d88302e276d817f.tar.xz artv2-75fa1d1810e98453960a81115d88302e276d817f.zip