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
|
<!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="Utilities" href="utilities.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 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="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"><a class="reference internal" href="joint_mover_utils.html">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>Component Utilities</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/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><em>Code author: Jeremy Ernst</em></p>
<span class="target" id="module-artv2_utilities.component_utilities"></span><p>This module contains functions for returning information specific to components or functions that operate specifically
on components.</p>
<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.component_utilities.check_for_children" title="artv2_utilities.component_utilities.check_for_children"><code class="xref py py-func docutils literal notranslate"><span class="pre">check_for_children</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.find_associated_mover_from_joint" title="artv2_utilities.component_utilities.find_associated_mover_from_joint"><code class="xref py py-func docutils literal notranslate"><span class="pre">find_associated_mover_from_joint</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.get_all_created_joints" title="artv2_utilities.component_utilities.get_all_created_joints"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_all_created_joints</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.get_all_rig_asset_nodes" title="artv2_utilities.component_utilities.get_all_rig_asset_nodes"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_all_rig_asset_nodes</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.get_module_instance" title="artv2_utilities.component_utilities.get_component_instance"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_component_instance</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.get_rig_asset_node" title="artv2_utilities.component_utilities.get_rig_asset_node"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_rig_asset_node</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.get_top_level_mover" title="artv2_utilities.component_utilities.get_top_level_mover"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_top_level_mover</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.return_all_components" title="artv2_utilities.component_utilities.return_all_components"><code class="xref py py-func docutils literal notranslate"><span class="pre">return_all_components</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.setup_global_scale" title="artv2_utilities.component_utilities.setup_global_scale"><code class="xref py py-func docutils literal notranslate"><span class="pre">setup_global_scale</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.validate_asset_name" title="artv2_utilities.component_utilities.validate_asset_name"><code class="xref py py-func docutils literal notranslate"><span class="pre">validate_asset_name</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.validate_prefix" title="artv2_utilities.component_utilities.validate_prefix"><code class="xref py py-func docutils literal notranslate"><span class="pre">validate_prefix</span></code></a></li>
<li><a class="reference internal" href="#artv2_utilities.component_utilities.validate_suffix" title="artv2_utilities.component_utilities.validate_suffix"><code class="xref py py-func docutils literal notranslate"><span class="pre">validate_suffix</span></code></a></li>
</ul>
<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.find_associated_mover_from_joint">
<code class="descname">find_associated_mover_from_joint</code><span class="sig-paren">(</span><em>joint_name</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"><strong>joint_name</strong> (<em>str</em>) – The name of the joint whose corresponding mover to search for.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of the joint mover that corresponds to the joint name.</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.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_module_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_module_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2_utilities.component_utilities.get_module_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>str</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_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.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.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>
</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="utilities.html" class="btn btn-neutral float-left" title="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>
|