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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
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>
|