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
|
<!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>artv2_utilities.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" />
</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>
<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"><a class="reference internal" href="../../technical_documentation.html">Technical Documentation</a></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="../index.html">Module code</a> »</li>
<li>artv2_utilities.component_utilities</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for artv2_utilities.component_utilities</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="sd">"""</span>
<span class="sd">This module contains functions for returning information specific to components or functions that operate specifically</span>
<span class="sd">on components.</span>
<span class="sd">Functions</span>
<span class="sd">---------</span>
<span class="sd">- :func:`check_for_children <artv2_utilities.component_utilities.check_for_children>`</span>
<span class="sd">- :func:`find_associated_mover_from_joint <artv2_utilities.component_utilities.find_associated_mover_from_joint>`</span>
<span class="sd">- :func:`get_all_created_joints <artv2_utilities.component_utilities.get_all_created_joints>`</span>
<span class="sd">- :func:`get_all_rig_asset_nodes <artv2_utilities.component_utilities.get_all_rig_asset_nodes>`</span>
<span class="sd">- :func:`get_component_instance <artv2_utilities.component_utilities.get_component_instance>`</span>
<span class="sd">- :func:`get_rig_asset_node <artv2_utilities.component_utilities.get_rig_asset_node>`</span>
<span class="sd">- :func:`get_top_level_mover <artv2_utilities.component_utilities.get_top_level_mover>`</span>
<span class="sd">- :func:`return_all_components <artv2_utilities.component_utilities.return_all_components>`</span>
<span class="sd">- :func:`setup_global_scale <artv2_utilities.component_utilities.setup_global_scale>`</span>
<span class="sd">- :func:`validate_asset_name <artv2_utilities.component_utilities.validate_asset_name>`</span>
<span class="sd">- :func:`validate_prefix <artv2_utilities.component_utilities.validate_prefix>`</span>
<span class="sd">- :func:`validate_suffix <artv2_utilities.component_utilities.validate_suffix>`</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">pymel.core</span> <span class="k">as</span> <span class="nn">pm</span>
<span class="kn">import</span> <span class="nn">error_utilities</span> <span class="k">as</span> <span class="nn">errors</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="get_rig_asset_node"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.get_rig_asset_node">[docs]</a><span class="k">def</span> <span class="nf">get_rig_asset_node</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Returns the network node for the entire rig asset. If more than one asset node exists, an exception will be raised.</span>
<span class="sd"> :return: Network node name (str) that represents the entire asset.</span>
<span class="sd"> """</span>
<span class="n">metanodes</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">ls</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"network"</span><span class="p">)</span>
<span class="n">character_nodes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">metanode</span> <span class="ow">in</span> <span class="n">metanodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">metanode</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"components"</span><span class="p">):</span>
<span class="n">character_nodes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">metanode</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">character_nodes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="n">character_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">character_nodes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">StandardError</span><span class="p">(</span><span class="s2">"No character nodes exist."</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">StandardError</span><span class="p">(</span><span class="s2">"More than one character node exists in the scene."</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="get_all_rig_asset_nodes"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.get_all_rig_asset_nodes">[docs]</a><span class="k">def</span> <span class="nf">get_all_rig_asset_nodes</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Returns all rig asset (character) nodes.</span>
<span class="sd"> :return: A list (str) of all rig asset network node names.</span>
<span class="sd"> """</span>
<span class="n">metanodes</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">ls</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"network"</span><span class="p">)</span>
<span class="n">character_nodes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">metanode</span> <span class="ow">in</span> <span class="n">metanodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">metanode</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"components"</span><span class="p">):</span>
<span class="n">character_nodes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">metanode</span><span class="p">)</span>
<span class="k">return</span> <span class="n">character_nodes</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="return_all_components"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.return_all_components">[docs]</a><span class="k">def</span> <span class="nf">return_all_components</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Returns all network nodes belonging to components.</span>
<span class="sd"> :return: A list (str) of all rig module network node names.</span>
<span class="sd"> """</span>
<span class="n">metanodes</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">ls</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"network"</span><span class="p">)</span>
<span class="n">components</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">metanode</span> <span class="ow">in</span> <span class="n">metanodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">metanode</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"asset"</span><span class="p">):</span>
<span class="k">if</span> <span class="n">metanode</span><span class="o">.</span><span class="n">asset</span><span class="o">.</span><span class="n">connections</span><span class="p">()</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">components</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">metanode</span><span class="p">)</span>
<span class="k">return</span> <span class="n">components</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="get_top_level_mover"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.get_top_level_mover">[docs]</a><span class="k">def</span> <span class="nf">get_top_level_mover</span><span class="p">(</span><span class="n">node</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the top-most global mover of a module.</span>
<span class="sd"> :param node: PyNode of the mover group for the module.</span>
<span class="sd"> :type node: pymel.core.PyNode</span>
<span class="sd"> :return: Returns the name of the top-most global joint mover of the module.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">childAtIndex</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="find_associated_mover_from_joint"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.find_associated_mover_from_joint">[docs]</a><span class="k">def</span> <span class="nf">find_associated_mover_from_joint</span><span class="p">(</span><span class="n">joint_name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the name of the joint mover (global, but offset if global doesn't exist) that corresponds to the given name.</span>
<span class="sd"> :param joint_name: The name of the joint whose corresponding mover to search for.</span>
<span class="sd"> :type joint_name: str</span>
<span class="sd"> :return: The name of the joint mover that corresponds to the joint name.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="n">network_nodes</span> <span class="o">=</span> <span class="n">return_all_components</span><span class="p">()</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">network_nodes</span><span class="p">:</span>
<span class="n">module_inst</span> <span class="o">=</span> <span class="n">get_component_instance</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
<span class="n">movers</span> <span class="o">=</span> <span class="n">module_inst</span><span class="o">.</span><span class="n">joint_mover</span><span class="o">.</span><span class="n">get_movers</span><span class="p">()</span>
<span class="n">offset_movers</span> <span class="o">=</span> <span class="n">movers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"offset"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">offset</span> <span class="ow">in</span> <span class="n">offset_movers</span><span class="p">:</span>
<span class="n">mover_joint</span> <span class="o">=</span> <span class="n">offset</span><span class="o">.</span><span class="n">created_joint</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="k">if</span> <span class="n">mover_joint</span> <span class="o">==</span> <span class="n">joint_name</span><span class="p">:</span>
<span class="k">del</span> <span class="n">module_inst</span>
<span class="k">if</span> <span class="n">pm</span><span class="o">.</span><span class="n">objExists</span><span class="p">(</span><span class="n">offset</span><span class="o">.</span><span class="n">name</span><span class="p">()</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s2">"_offset"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]):</span>
<span class="k">return</span> <span class="n">pm</span><span class="o">.</span><span class="n">PyNode</span><span class="p">(</span><span class="n">offset</span><span class="o">.</span><span class="n">name</span><span class="p">()</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s2">"_offset"</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">offset</span>
<span class="k">del</span> <span class="n">module_inst</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="get_all_created_joints"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.get_all_created_joints">[docs]</a><span class="k">def</span> <span class="nf">get_all_created_joints</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Get all created joints from all components.</span>
<span class="sd"> :return: Returns a list of all joints that components will or have created.</span>
<span class="sd"> :rtype: str, []</span>
<span class="sd"> """</span>
<span class="n">joints</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">network_nodes</span> <span class="o">=</span> <span class="n">return_all_components</span><span class="p">()</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">network_nodes</span><span class="p">:</span>
<span class="n">inst</span> <span class="o">=</span> <span class="n">get_component_instance</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
<span class="n">joints</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">inst</span><span class="o">.</span><span class="n">joint_mover</span><span class="o">.</span><span class="n">get_created_joints</span><span class="p">())</span>
<span class="k">del</span> <span class="n">inst</span>
<span class="k">return</span> <span class="n">joints</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="check_for_children"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.check_for_children">[docs]</a><span class="k">def</span> <span class="nf">check_for_children</span><span class="p">(</span><span class="n">joint</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if the given joint has any child components that are using it as their parent.</span>
<span class="sd"> :param joint: Name of joint to check.</span>
<span class="sd"> :type joint: str</span>
<span class="sd"> :return: Returns a list of components that were children of the joint.</span>
<span class="sd"> :rtype: str, []</span>
<span class="sd"> """</span>
<span class="n">child_components</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">components</span> <span class="o">=</span> <span class="n">return_all_components</span><span class="p">()</span>
<span class="k">for</span> <span class="n">component</span> <span class="ow">in</span> <span class="n">components</span><span class="p">:</span>
<span class="k">if</span> <span class="n">component</span><span class="o">.</span><span class="n">parentComponentBone</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="o">==</span> <span class="n">joint</span><span class="p">:</span>
<span class="n">child_components</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
<span class="k">return</span> <span class="n">child_components</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="validate_prefix"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.validate_prefix">[docs]</a><span class="k">def</span> <span class="nf">validate_prefix</span><span class="p">(</span><span class="n">metanode</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Ensures that the given prefix is a valid name for Maya, as well as ensuring it has a trailing underscore.</span>
<span class="sd"> Also ensures that no other module exists with the new name, factoring in the adjusted prefix.</span>
<span class="sd"> :param metanode: The rig module's network node name.</span>
<span class="sd"> :param prefix: The prefix to validate.</span>
<span class="sd"> :return: Returns a valid prefix as a string. If the prefix was invalid, returns False</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">prefix</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">prefix</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"_"</span><span class="p">):</span>
<span class="n">prefix</span> <span class="o">+=</span> <span class="s2">"_"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'^\d'</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name cannot start with digits!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'\W'</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name has non-alphanumeric characters!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">metanode</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">old_prefix</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">prefix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">base_name</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">baseName</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">suffix</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">suffix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">components</span> <span class="o">=</span> <span class="n">return_all_components</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">prefix</span> <span class="o">==</span> <span class="n">old_prefix</span><span class="p">:</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">components</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="o">.</span><span class="n">prefix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="o">==</span> <span class="n">prefix</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="o">.</span><span class="n">componentName</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="o">==</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">base_name</span> <span class="o">+</span> <span class="n">suffix</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span> <span class="o">!=</span> <span class="n">metanode</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"A module with this name already exists!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">prefix</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="validate_suffix"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.validate_suffix">[docs]</a><span class="k">def</span> <span class="nf">validate_suffix</span><span class="p">(</span><span class="n">metanode</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Ensures that the given suffix is a valid name for Maya, as well as ensuring it has a leading underscore.</span>
<span class="sd"> Also ensures that no other module exists with the new name, factoring in the adjusted suffix.</span>
<span class="sd"> :param metanode: The rig module's network node name.</span>
<span class="sd"> :param suffix: The suffix to validate.</span>
<span class="sd"> :return: Returns a valid suffix as a string. If the suffix was invalid, returns False</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">suffix</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">suffix</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">suffix</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"_"</span><span class="p">):</span>
<span class="n">suffix</span> <span class="o">=</span> <span class="s2">"_"</span> <span class="o">+</span> <span class="n">suffix</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">suffix</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'^\d'</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name cannot start with digits!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'\W'</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name has non-alphanumeric characters!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">metanode</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">old_suffix</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">suffix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">base_name</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">baseName</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="n">metanode</span><span class="o">.</span><span class="n">prefix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">components</span> <span class="o">=</span> <span class="n">return_all_components</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">suffix</span> <span class="o">==</span> <span class="n">old_suffix</span><span class="p">:</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">components</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="o">.</span><span class="n">suffix</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="o">==</span> <span class="n">suffix</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="o">.</span><span class="n">componentName</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="o">==</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">base_name</span> <span class="o">+</span> <span class="n">suffix</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span> <span class="o">!=</span> <span class="n">metanode</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"A module with this name already exists!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">suffix</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="validate_asset_name"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.validate_asset_name">[docs]</a><span class="k">def</span> <span class="nf">validate_asset_name</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Ensures that the given name is a valid name for Maya.</span>
<span class="sd"> :param str name: The name to validate.</span>
<span class="sd"> :return: Returns True if name is valid, otherwise False.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'^\d'</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name cannot start with digits!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'\W'</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">raise_error</span><span class="p">(</span><span class="s2">"Name has non-alphanumeric characters!"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="setup_global_scale"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.setup_global_scale">[docs]</a><span class="k">def</span> <span class="nf">setup_global_scale</span><span class="p">(</span><span class="n">mover</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets up an aliasAttr so that only uniform scale is possible.</span>
<span class="sd"> :param mover: Name of the node to setup the uniform scale.</span>
<span class="sd"> :type mover: str</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">mover</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"globalScale"</span><span class="p">):</span>
<span class="n">pm</span><span class="o">.</span><span class="n">aliasAttr</span><span class="p">(</span><span class="s2">"globalScale"</span><span class="p">,</span> <span class="n">mover</span><span class="o">.</span><span class="n">scaleZ</span><span class="p">)</span>
<span class="n">mover</span><span class="o">.</span><span class="n">globalScale</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">mover</span><span class="o">.</span><span class="n">scaleX</span><span class="p">)</span>
<span class="n">mover</span><span class="o">.</span><span class="n">globalScale</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">mover</span><span class="o">.</span><span class="n">scaleY</span><span class="p">)</span>
<span class="n">mover</span><span class="o">.</span><span class="n">scaleX</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">keyable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">mover</span><span class="o">.</span><span class="n">scaleY</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">keyable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_module_instance"><a class="viewcode-back" href="../../sections/tech_docs/utilities/component_utils.html#artv2_utilities.component_utilities.get_module_instance">[docs]</a><span class="k">def</span> <span class="nf">get_component_instance</span><span class="p">(</span><span class="n">network_node</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given a network node for a module, create an instance of the module and return it.</span>
<span class="sd"> :param network_node: The name of the network node to gather the necessary information from to create an inst.</span>
<span class="sd"> :type network_node: str</span>
<span class="sd"> :return: Module instance</span>
<span class="sd"> :rtype: class.instance</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">network_node</span><span class="o">.</span><span class="n">modulePath</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">class_name</span> <span class="o">=</span> <span class="n">network_node</span><span class="o">.</span><span class="n">className</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">module_name</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s2">"."</span><span class="p">)[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">mod</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">[</span><span class="n">module_name</span><span class="p">])</span>
<span class="n">module_class</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">class_name</span><span class="p">)</span>
<span class="n">module_inst</span> <span class="o">=</span> <span class="n">module_class</span><span class="p">(</span><span class="n">network_node</span><span class="o">=</span><span class="n">network_node</span><span class="p">)</span>
<span class="k">return</span> <span class="n">module_inst</span></div>
</pre></div>
</div>
</div>
<footer>
<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>
|