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/tech_docs/components/template.html | |
| 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/tech_docs/components/template.html')
| -rw-r--r-- | docs/build/sections/tech_docs/components/template.html | 293 |
1 files changed, 293 insertions, 0 deletions
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 |