docs/build/sections/tech_docs/components/pose.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
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>