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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
<!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="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="sections/tech_docs/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="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="general_utils.html">General 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>
</ul>
</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/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><em>Code author: Jeremy Ernst</em></p>
<span class="target" id="module-artv2_utilities.joint_mover_utilities"></span><p>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.</p>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.JointMoverUtils" title="artv2_utilities.joint_mover_utilities.JointMoverUtils"><code class="xref py py-class docutils literal notranslate"><span class="pre">JointMoverUtils</span></code></a></li>
</ul>
</div>
<div class="section" id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.create_mover" title="artv2_utilities.joint_mover_utilities.create_mover"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_mover</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.create_mover_containers" title="artv2_utilities.joint_mover_utilities.create_mover_containers"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_mover_containers</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.create_movers_from_joints" title="artv2_utilities.joint_mover_utilities.create_movers_from_joints"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_movers_from_joints</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.drive_joints_with_movers" title="artv2_utilities.joint_mover_utilities.drive_joints_with_movers"><code class="xref py py-func docutils literal notranslate"><span class="pre">drive_joints_with_movers</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.drive_joints_with_offsets" title="artv2_utilities.joint_mover_utilities.drive_joints_with_offsets"><code class="xref py py-func docutils literal notranslate"><span class="pre">drive_joints_with_offsets</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.mark_joint_movers" title="artv2_utilities.joint_mover_utilities.mark_joint_movers"><code class="xref py py-func docutils literal notranslate"><span class="pre">mark_joint_movers</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.markup_joints" title="artv2_utilities.joint_mover_utilities.markup_joints"><code class="xref py py-func docutils literal notranslate"><span class="pre">markup_joints</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.setup_cv_scaling" title="artv2_utilities.joint_mover_utilities.setup_cv_scaling"><code class="xref py py-func docutils literal notranslate"><span class="pre">setup_cv_scaling</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.setup_mover" title="artv2_utilities.joint_mover_utilities.setup_mover"><code class="xref py py-func docutils literal notranslate"><span class="pre">setup_mover</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.setup_twist_mover" title="artv2_utilities.joint_mover_utilities.setup_twist_mover"><code class="xref py py-func docutils literal notranslate"><span class="pre">setup_twist_mover</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.joint_mover_utilities.show_window" title="artv2_utilities.joint_mover_utilities.show_window"><code class="xref py py-func docutils literal notranslate"><span class="pre">show_window</span></code></a></li>
</ul>
<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>
</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>control_path</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>control_path</strong> (<em>str</em>) – The file path to the control shape to use.</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.mark_joint_movers">
<code class="descname">mark_joint_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#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>
</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><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><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>
</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>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_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>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.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>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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>
|