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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
|
<!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_components.joint_mover — 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_components.joint_mover</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_components.joint_mover</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="sd">"""</span>
<span class="sd">This module contains a class that represents a joint mover object. A joint mover object is meant to be instantiated in</span>
<span class="sd">the __init__ of the base_component class. Nothing should inherit from the JointMover class.</span>
<span class="sd">The main methods a JointMover handles are: adding the joint mover file, renaming movers, setting up the hierarchy,</span>
<span class="sd">locking or unlocking movers, and retrieving mover-related data.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">os</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">artv2_utilities.general_utilities</span> <span class="k">as</span> <span class="nn">utils</span>
<span class="kn">import</span> <span class="nn">artv2_utilities.component_utilities</span> <span class="k">as</span> <span class="nn">component_utils</span>
<span class="kn">import</span> <span class="nn">artv2_utilities.error_utilities</span> <span class="k">as</span> <span class="nn">errors</span>
<span class="kn">import</span> <span class="nn">artv2_utilities.joint_mover_utilities</span> <span class="k">as</span> <span class="nn">dev_utils</span>
<span class="kn">from</span> <span class="nn">aim_helper</span> <span class="k">import</span> <span class="n">AimHelper</span>
<div class="viewcode-block" id="JointMover"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover">[docs]</a><span class="k">class</span> <span class="nc">JointMover</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Class for creating and working with a joint mover rig, which is a simplified rig used to aid in the creation of a</span>
<span class="sd"> skeleton, keeping it clean and consistent.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">metanode</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param path: Path to joint mover file.</span>
<span class="sd"> :param metanode: This is the network node from a component, like a leg or torso. It contains all of the</span>
<span class="sd"> metadata</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_metanode</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">PyNode</span><span class="p">(</span><span class="n">metanode</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aim_helper</span> <span class="o">=</span> <span class="n">AimHelper</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_metanode</span><span class="p">)</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.add_joint_mover"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.add_joint_mover">[docs]</a> <span class="k">def</span> <span class="nf">add_joint_mover</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds the joint mover maya ascii file to the maya scene.</span>
<span class="sd"> """</span>
<span class="n">tools_directory</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">return_settings</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">joint_mover_path</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">path_join</span><span class="p">(</span><span class="n">tools_directory</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">joint_mover_path</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">"The specified joint mover file does not exist: </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">joint_mover_path</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">nodes</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">import_file</span><span class="p">(</span><span class="n">joint_mover_path</span><span class="p">,</span> <span class="n">return_nodes</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">joints</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">filter_nodes</span><span class="p">(</span><span class="n">nodes</span><span class="p">,</span> <span class="n">filter_by</span><span class="o">=</span><span class="s2">"joint"</span><span class="p">)</span>
<span class="n">root_joint</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">get_root_joint_of_component</span><span class="p">(</span><span class="n">joints</span><span class="p">)</span>
<span class="k">for</span> <span class="n">joint</span> <span class="ow">in</span> <span class="n">utils</span><span class="o">.</span><span class="n">convert_to_pynodes</span><span class="p">(</span><span class="n">joints</span><span class="p">):</span>
<span class="n">joint</span><span class="o">.</span><span class="n">overrideEnabled</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="n">joint</span><span class="o">.</span><span class="n">overrideDisplayType</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">create_joint_mover_controls</span><span class="p">(</span><span class="n">root_joint</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.create_joint_mover_controls"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.create_joint_mover_controls">[docs]</a> <span class="k">def</span> <span class="nf">create_joint_mover_controls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">root_joint</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates the joint mover controls on the joints that come in from the ascii file.</span>
<span class="sd"> :param root_joint: Root joint of the hierarchy from the joint mover ascii file.</span>
<span class="sd"> """</span>
<span class="n">created_movers</span> <span class="o">=</span> <span class="n">dev_utils</span><span class="o">.</span><span class="n">create_movers_from_joints</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metanode</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="n">root_joint</span><span class="p">)</span>
<span class="n">dev_utils</span><span class="o">.</span><span class="n">mark_joint_movers</span><span class="p">(</span><span class="n">created_movers</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</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="n">dev_utils</span><span class="o">.</span><span class="n">drive_joints_with_movers</span><span class="p">(</span><span class="n">created_movers</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</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="bp">self</span><span class="o">.</span><span class="n">_connect_movers_to_metanode</span><span class="p">(</span><span class="n">created_movers</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rename_movers</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
<span class="n">movers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_movers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="p">[</span><span class="n">movers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"global"</span><span class="p">),</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">mover</span> <span class="ow">in</span> <span class="n">each</span><span class="p">:</span>
<span class="n">component_utils</span><span class="o">.</span><span class="n">setup_global_scale</span><span class="p">(</span><span class="n">mover</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock_joint_movers</span><span class="p">(</span><span class="n">lock_children</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">containers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_containers</span><span class="p">()</span>
<span class="n">pm</span><span class="o">.</span><span class="n">lockNode</span><span class="p">(</span><span class="n">containers</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">lock</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">lockUnpublished</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">pm</span><span class="o">.</span><span class="n">lockNode</span><span class="p">(</span><span class="n">containers</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">lock</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">lockUnpublished</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">pm</span><span class="o">.</span><span class="n">lockNode</span><span class="p">(</span><span class="n">containers</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">lock</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">lockUnpublished</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">pynode</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">PyNode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">mover_grp</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">mover</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">get_top_level_mover</span><span class="p">(</span><span class="n">pynode</span><span class="p">)</span>
<span class="n">pm</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">mover</span><span class="o">.</span><span class="n">fullPath</span><span class="p">())</span>
<span class="n">pm</span><span class="o">.</span><span class="n">setToolTo</span><span class="p">(</span><span class="s2">"moveSuperContext"</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.get_containers"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.get_containers">[docs]</a> <span class="k">def</span> <span class="nf">get_containers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get and return the containers that our joint mover controls and utility nodes are contained in.</span>
<span class="sd"> :return: PyNodes of containers that our joint mover controls and utility nodes reside in.</span>
<span class="sd"> """</span>
<span class="n">guide_container</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">container</span><span class="p">(</span><span class="n">q</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">findContainer</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">return_top_mover_grp</span><span class="p">()])</span>
<span class="n">top_container</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">container</span><span class="p">(</span><span class="n">q</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">findContainer</span><span class="o">=</span><span class="p">[</span><span class="n">guide_container</span><span class="p">])</span>
<span class="n">utils_container</span> <span class="o">=</span> <span class="n">top_container</span><span class="o">.</span><span class="n">utils_container</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="p">[</span><span class="n">top_container</span><span class="p">,</span> <span class="n">guide_container</span><span class="p">,</span> <span class="n">utils_container</span><span class="p">]</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.get_created_joints"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.get_created_joints">[docs]</a> <span class="k">def</span> <span class="nf">get_created_joints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Finds and returns the joints created by this JointMover.</span>
<span class="sd"> :return: string array of joint names</span>
<span class="sd"> """</span>
<span class="n">movers</span> <span class="o">=</span> <span class="bp">self</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="n">joints</span> <span class="o">=</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="k">if</span> <span class="n">offset</span><span class="o">.</span><span class="n">build_joint</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">joints</span><span class="o">.</span><span class="n">append</span><span class="p">(</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">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="JointMover.get_driven_joints"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.get_driven_joints">[docs]</a> <span class="k">def</span> <span class="nf">get_driven_joints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the joint mover joints currently driven by the movers (these are not the same as the created joints).</span>
<span class="sd"> :return: List of PyNodes representing the joint mover joints.</span>
<span class="sd"> """</span>
<span class="n">movers</span> <span class="o">=</span> <span class="bp">self</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="n">joints</span> <span class="o">=</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">joints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">offset</span><span class="o">.</span><span class="n">connected_joint</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">])</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="JointMover.get_mover_values"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.get_mover_values">[docs]</a> <span class="k">def</span> <span class="nf">get_mover_values</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get the translation, rotation, and scale values of the joint mover controls.</span>
<span class="sd"> :return: Returns a dictionary of the joint mover transformation values. The dictionary is returned as: key =</span>
<span class="sd"> mover name, value = dictionary of attributes as keys, and their values as the values. For example:</span>
<span class="sd"> {calf_mover: {translateX: 5.00, translateY: 0.00, translateZ: 10.00}}</span>
<span class="sd"> """</span>
<span class="n">mover_values</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">mover_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_movers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">mover_type</span> <span class="ow">in</span> <span class="n">mover_data</span><span class="p">:</span>
<span class="n">movers</span> <span class="o">=</span> <span class="n">mover_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">mover_type</span><span class="p">)</span>
<span class="k">for</span> <span class="n">mover</span> <span class="ow">in</span> <span class="n">movers</span><span class="p">:</span>
<span class="n">attrs</span> <span class="o">=</span> <span class="n">mover</span><span class="o">.</span><span class="n">listAttr</span><span class="p">(</span><span class="n">keyable</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">attr_data</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">attrs</span><span class="p">:</span>
<span class="n">attr_data</span><span class="p">[</span><span class="n">attr</span><span class="o">.</span><span class="n">attrName</span><span class="p">()]</span> <span class="o">=</span> <span class="n">attr</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">mover_values</span><span class="p">[</span><span class="n">mover</span><span class="o">.</span><span class="n">name</span><span class="p">()]</span> <span class="o">=</span> <span class="n">attr_data</span>
<span class="k">return</span> <span class="n">mover_values</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.get_movers"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.get_movers">[docs]</a> <span class="k">def</span> <span class="nf">get_movers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Finds and returns the joint mover control objects created by the JointMover.</span>
<span class="sd"> :return: Dictionary of joint movers with the keys: global and offset.</span>
<span class="sd"> """</span>
<span class="n">global_movers</span><span class="p">,</span> <span class="n">offset_movers</span><span class="p">,</span> <span class="n">geo_movers</span><span class="p">,</span> <span class="n">lra_movers</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[],</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="p">[[</span><span class="s2">"global_movers"</span><span class="p">,</span> <span class="n">global_movers</span><span class="p">],</span> <span class="p">[</span><span class="s2">"offset_movers"</span><span class="p">,</span> <span class="n">offset_movers</span><span class="p">]]:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">attr</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="n">connections</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">attr</span><span class="p">(</span><span class="n">attr</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">.</span><span class="n">connections</span><span class="p">()</span>
<span class="k">if</span> <span class="n">connections</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">attr</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">connections</span><span class="p">)</span>
<span class="n">movers</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"global"</span><span class="p">:</span> <span class="n">global_movers</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="n">offset_movers</span><span class="p">}</span>
<span class="k">return</span> <span class="n">movers</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.lock_joint_movers"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.lock_joint_movers">[docs]</a> <span class="k">def</span> <span class="nf">_lock_joint_movers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lock</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">lock_children</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Method for locking down the joint mover nodes so they cannot be deleted (or unlocking them).</span>
<span class="sd"> :param lock: Whether to lock or unlock the nodes.</span>
<span class="sd"> :param lock_children: Whether to lock all children of the nodes, whether they are movers or not.</span>
<span class="sd"> :type lock: bool</span>
<span class="sd"> :type lock_children: bool</span>
<span class="sd"> """</span>
<span class="n">joint_movers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_movers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">mover_type</span> <span class="ow">in</span> <span class="n">joint_movers</span><span class="p">:</span>
<span class="n">movers</span> <span class="o">=</span> <span class="n">joint_movers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">mover_type</span><span class="p">)</span>
<span class="n">container</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">container</span><span class="p">(</span><span class="n">q</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">findContainer</span><span class="o">=</span><span class="p">[</span><span class="n">mover</span> <span class="k">for</span> <span class="n">mover</span> <span class="ow">in</span> <span class="n">movers</span><span class="p">])</span>
<span class="k">if</span> <span class="n">container</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">container</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="k">for</span> <span class="n">mover</span> <span class="ow">in</span> <span class="n">movers</span><span class="p">:</span>
<span class="n">pm</span><span class="o">.</span><span class="n">lockNode</span><span class="p">(</span><span class="n">mover</span><span class="p">,</span> <span class="n">lock</span><span class="o">=</span><span class="n">lock</span><span class="p">)</span>
<span class="k">if</span> <span class="n">lock_children</span><span class="p">:</span>
<span class="n">pm</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">mover</span><span class="p">,</span> <span class="n">hi</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">children</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="n">sl</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">children</span><span class="p">:</span>
<span class="n">pm</span><span class="o">.</span><span class="n">lockNode</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">lock</span><span class="o">=</span><span class="n">lock</span><span class="p">)</span>
<span class="k">if</span> <span class="n">container</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">container</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.remove_movers"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.remove_movers">[docs]</a> <span class="k">def</span> <span class="nf">remove_movers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Remove the generated joint mover controls from the driven joints (as well as any associated containers, nodes).</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock_joint_movers</span><span class="p">(</span><span class="n">lock</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">lock_children</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">mover_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_movers</span><span class="p">()</span>
<span class="n">containers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_containers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">container</span> <span class="ow">in</span> <span class="n">containers</span><span class="p">:</span>
<span class="n">container</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">utility_nodes</span> <span class="o">=</span> <span class="n">containers</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">getNodeList</span><span class="p">()</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">utility_nodes</span><span class="p">:</span>
<span class="n">node</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
<span class="k">for</span> <span class="n">mover_type</span> <span class="ow">in</span> <span class="n">mover_data</span><span class="p">:</span>
<span class="n">movers</span> <span class="o">=</span> <span class="n">mover_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">mover_type</span><span class="p">)</span>
<span class="k">for</span> <span class="n">mover</span> <span class="ow">in</span> <span class="n">movers</span><span class="p">:</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">mover</span><span class="p">):</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">mover</span><span class="p">)</span>
<span class="n">top_grp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">return_top_mover_grp</span><span class="p">()</span>
<span class="n">top_grp</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">top_grp</span><span class="p">)</span>
<span class="n">joints</span> <span class="o">=</span> <span class="n">containers</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">getNodeList</span><span class="p">()</span>
<span class="n">containers</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">removeNode</span><span class="p">(</span><span class="n">joints</span><span class="p">)</span>
<span class="k">for</span> <span class="n">joint</span> <span class="ow">in</span> <span class="n">joints</span><span class="p">:</span>
<span class="n">original_name</span> <span class="o">=</span> <span class="n">joint</span><span class="o">.</span><span class="n">attr</span><span class="p">(</span><span class="s2">"otherType"</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">utils</span><span class="o">.</span><span class="n">rename_object</span><span class="p">(</span><span class="n">joint</span><span class="p">,</span> <span class="n">original_name</span><span class="p">)</span>
<span class="k">for</span> <span class="n">container</span> <span class="ow">in</span> <span class="n">containers</span><span class="p">:</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">container</span><span class="p">):</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">container</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.rename_movers"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.rename_movers">[docs]</a> <span class="k">def</span> <span class="nf">rename_movers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">old_prefix</span><span class="p">,</span> <span class="n">old_suffix</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Renames joint movers with the new component prefix and/or suffix.</span>
<span class="sd"> :param str old_prefix: The old prefix to search/replace</span>
<span class="sd"> :param str old_suffix: The old suffix to search/replace</span>
<span class="sd"> """</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="bp">self</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">suffix</span> <span class="o">=</span> <span class="bp">self</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">mover_grp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">mover_grp</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">pm</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">mover_grp</span><span class="p">,</span> <span class="n">hi</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">selection</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="n">sl</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">long</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">rename_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_nodes_to_rename</span><span class="p">(</span><span class="n">selection</span><span class="p">,</span> <span class="n">old_prefix</span><span class="p">,</span> <span class="n">old_suffix</span><span class="p">)</span>
<span class="n">rename_data</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">rename_nodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"created_joint"</span><span class="p">):</span>
<span class="n">original_name</span> <span class="o">=</span> <span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">]</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="n">current_name</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">strip_name</span><span class="p">(</span><span class="n">original_name</span><span class="p">,</span> <span class="n">old_prefix</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">old_suffix</span><span class="p">)</span>
<span class="n">utils</span><span class="o">.</span><span class="n">set_attribute</span><span class="p">(</span><span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">"created_joint"</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">current_name</span> <span class="o">+</span> <span class="n">suffix</span><span class="p">,</span> <span class="s2">"string"</span><span class="p">)</span>
<span class="n">rename_data</span><span class="o">.</span><span class="n">append</span><span class="p">([</span><span class="n">original_name</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">current_name</span> <span class="o">+</span> <span class="n">suffix</span><span class="p">])</span>
<span class="n">guide_joint</span> <span class="o">=</span> <span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">connected_joint</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">utils</span><span class="o">.</span><span class="n">rename_object</span><span class="p">(</span><span class="n">guide_joint</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</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="s2">"_"</span> <span class="o">+</span> <span class="n">current_name</span><span class="p">)</span>
<span class="n">utils</span><span class="o">.</span><span class="n">rename_object</span><span class="p">(</span><span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">each</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_rename_dependent_attrs</span><span class="p">(</span><span class="n">rename_data</span><span class="p">)</span>
<span class="n">pm</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">clear</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.return_top_mover_grp"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.return_top_mover_grp">[docs]</a> <span class="k">def</span> <span class="nf">return_top_mover_grp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Finds the top-most global mover group and returns it.</span>
<span class="sd"> :return: string name of the top-most global mover group.</span>
<span class="sd"> """</span>
<span class="n">top_mover_grp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">mover_grp</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">pm</span><span class="o">.</span><span class="n">objExists</span><span class="p">(</span><span class="n">top_mover_grp</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">"</span><span class="si">{0}</span><span class="s2"> does not exist! This should not be the case!"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">top_mover_grp</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">return</span> <span class="n">top_mover_grp</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.set_mover_parent"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.set_mover_parent">[docs]</a> <span class="k">def</span> <span class="nf">set_mover_parent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parents the top-most group in the joint mover file under the given parent joint's global mover.</span>
<span class="sd"> :param str parent: Name of parent joint.</span>
<span class="sd"> """</span>
<span class="n">parent_mover</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">find_associated_mover_from_joint</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
<span class="n">top_mover</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">return_top_mover_grp</span><span class="p">()</span>
<span class="n">parent_constraint</span> <span class="o">=</span> <span class="n">top_mover</span><span class="o">.</span><span class="n">translateX</span><span class="o">.</span><span class="n">connections</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"parentConstraint"</span><span class="p">,</span> <span class="n">exactType</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">scale_constraint</span> <span class="o">=</span> <span class="n">top_mover</span><span class="o">.</span><span class="n">scaleX</span><span class="o">.</span><span class="n">connections</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"scaleConstraint"</span><span class="p">,</span> <span class="n">exactType</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="n">parent_constraint</span><span class="p">:</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">parent_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="n">parent_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">parent_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">scale_constraint</span><span class="p">:</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">scale_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="n">scale_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">pm</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">scale_constraint</span><span class="p">[</span><span class="mi">0</span><span class="p">])</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">parent_mover</span><span class="p">):</span>
<span class="n">new_parent_constraint</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">parentConstraint</span><span class="p">(</span><span class="n">parent_mover</span><span class="p">,</span> <span class="n">top_mover</span><span class="p">,</span> <span class="n">mo</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">new_scale_constraint</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">scaleConstraint</span><span class="p">(</span><span class="n">parent_mover</span><span class="p">,</span> <span class="n">top_mover</span><span class="p">)</span>
<span class="n">new_parent_constraint</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span>
<span class="n">new_scale_constraint</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span>
<span class="k">else</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">"Could not parent </span><span class="si">{0}</span><span class="s2"> to </span><span class="si">{1}</span><span class="s2">. </span><span class="si">{1}</span><span class="s2"> does not exist."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">top_mover</span><span class="p">,</span> <span class="n">parent_mover</span><span class="p">))</span>
<span class="k">return</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.toggle_build_joint"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.toggle_build_joint">[docs]</a> <span class="k">def</span> <span class="nf">toggle_build_joint</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">joint</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">build</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the metadata on the joint mover controls to either build or not build the given joint.</span>
<span class="sd"> :param str joint: The joint whose build state is being toggled.</span>
<span class="sd"> :param str group: The name of the joint mover control group that includes that joint.</span>
<span class="sd"> :param bool build: Boolean value of whether to toggle the attribute on or off.</span>
<span class="sd"> """</span>
<span class="n">movers</span> <span class="o">=</span> <span class="bp">self</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="p">[</span><span class="s2">"offset"</span><span class="p">]</span>
<span class="n">alert_user</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">issues</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">check_for_children</span><span class="p">(</span><span class="n">joint</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">issues</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">message</span> <span class="o">=</span> <span class="s2">"Some components have had their parent set to the root joint due to dependencies.</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">details</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">issues</span><span class="p">:</span>
<span class="n">inst</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">get_component_instance</span><span class="p">(</span><span class="n">each</span><span class="p">)</span>
<span class="n">inst</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="s2">"root"</span>
<span class="n">details</span> <span class="o">+=</span> <span class="n">inst</span><span class="o">.</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">inst</span><span class="o">.</span><span class="n">base_name</span> <span class="o">+</span> <span class="n">inst</span><span class="o">.</span><span class="n">suffix</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">alert_user</span> <span class="o">=</span> <span class="p">[</span><span class="n">message</span><span class="p">,</span> <span class="n">details</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock_joint_movers</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="kc">True</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="k">if</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="o">==</span> <span class="n">joint</span><span class="p">:</span>
<span class="n">offset</span><span class="o">.</span><span class="n">build_joint</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">build</span><span class="p">)</span>
<span class="n">driven_jnt</span> <span class="o">=</span> <span class="n">offset</span><span class="o">.</span><span class="n">connected_joint</span><span class="o">.</span><span class="n">connections</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">utils</span><span class="o">.</span><span class="n">set_attribute</span><span class="p">(</span><span class="n">driven_jnt</span><span class="p">,</span> <span class="s2">"visibility"</span><span class="p">,</span> <span class="n">build</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">pm</span><span class="o">.</span><span class="n">objExists</span><span class="p">(</span><span class="n">group</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">"ART_Component._toggle_build_joint: </span><span class="si">{0}</span><span class="s2"> does not exist"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">group</span><span class="p">))</span>
<span class="k">return</span>
<span class="n">group</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
<span class="n">group</span><span class="o">.</span><span class="n">visibility</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">lock</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">group</span><span class="o">.</span><span class="n">visibility</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">build</span><span class="p">,</span> <span class="n">lock</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">group</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock_joint_movers</span><span class="p">(</span><span class="n">lock_children</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="n">alert_user</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">False</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">inform_user</span><span class="p">(</span><span class="o">*</span><span class="n">alert_user</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover._find_nodes_to_rename"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover._find_nodes_to_rename">[docs]</a> <span class="k">def</span> <span class="nf">_find_nodes_to_rename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">old_prefix</span><span class="p">,</span> <span class="n">old_suffix</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given a list of nodes, find only the transforms and rename them.</span>
<span class="sd"> :param nodes: A list of PyNodes</span>
<span class="sd"> :param old_prefix: The old prefix.</span>
<span class="sd"> :param old_suffix: The old suffix.</span>
<span class="sd"> :return: Return a list of nodes(PyNodes) to rename, with their new name (str): [[node1, newName], [node2,</span>
<span class="sd"> newName]]</span>
<span class="sd"> """</span>
<span class="n">unique_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metanode</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="n">base_name</span> <span class="o">=</span> <span class="bp">self</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">rename_nodes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">nodes</span><span class="p">:</span>
<span class="n">types</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">nodeType</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">(),</span> <span class="n">inherited</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"transform"</span> <span class="ow">in</span> <span class="n">types</span><span class="p">:</span>
<span class="k">if</span> <span class="n">base_name</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">():</span>
<span class="n">tail</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">strip_name</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">(),</span> <span class="n">old_prefix</span><span class="p">,</span> <span class="n">base_name</span><span class="p">,</span> <span class="n">old_suffix</span><span class="p">)</span>
<span class="n">new_name</span> <span class="o">=</span> <span class="n">unique_name</span> <span class="o">+</span> <span class="n">tail</span>
<span class="n">rename_nodes</span><span class="o">.</span><span class="n">append</span><span class="p">([</span><span class="n">node</span><span class="p">,</span> <span class="n">new_name</span><span class="p">])</span>
<span class="k">return</span> <span class="n">rename_nodes</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover._connect_movers_to_metanode"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover._connect_movers_to_metanode">[docs]</a> <span class="k">def</span> <span class="nf">_connect_movers_to_metanode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Connect the joint mover controls to the owning component's metanode.</span>
<span class="sd"> :param nodes: a list of joint mover controls (PyNodes)</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">nodes</span><span class="p">:</span>
<span class="n">mover_nodes</span> <span class="o">=</span> <span class="n">nodes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">mover_nodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"isMoverGrp"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">mover_grp</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">owning_component</span><span class="p">)</span>
<span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="s2">"isMover"</span><span class="p">):</span>
<span class="n">mover_type</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">moverType</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
<span class="n">mover_types</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"global"</span><span class="p">:</span> <span class="s2">"global_movers"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="s2">"offset_movers"</span><span class="p">}</span>
<span class="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">mover_types</span><span class="p">:</span>
<span class="k">if</span> <span class="n">mover_type</span> <span class="o">==</span> <span class="n">each</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metanode</span><span class="o">.</span><span class="n">attr</span><span class="p">(</span><span class="n">mover_types</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">each</span><span class="p">))</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">owning_component</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover.set_mover_values"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover.set_mover_values">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">set_mover_values</span><span class="p">(</span><span class="n">value_data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets values on the joint mover controls.</span>
<span class="sd"> :param value_data: The values to set on the controls. It should be formatted like the dictionary generated</span>
<span class="sd"> by the get_mover_values method.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">mover</span> <span class="ow">in</span> <span class="n">value_data</span><span class="p">:</span>
<span class="n">mover_node</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">PyNode</span><span class="p">(</span><span class="n">mover</span><span class="p">)</span>
<span class="n">attribute_data</span> <span class="o">=</span> <span class="n">value_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">mover</span><span class="p">)</span>
<span class="k">for</span> <span class="n">attribute</span> <span class="ow">in</span> <span class="n">attribute_data</span><span class="p">:</span>
<span class="n">attribute_value</span> <span class="o">=</span> <span class="n">attribute_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attribute</span><span class="p">)</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">mover_node</span><span class="p">):</span>
<span class="k">if</span> <span class="n">mover_node</span><span class="o">.</span><span class="n">hasAttr</span><span class="p">(</span><span class="n">attribute</span><span class="p">):</span>
<span class="n">mover_node</span><span class="o">.</span><span class="n">attr</span><span class="p">(</span><span class="n">attribute</span><span class="p">)</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">attribute_value</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<div class="viewcode-block" id="JointMover._rename_dependent_attrs"><a class="viewcode-back" href="../../sections/tech_docs/components/joint_mover.html#artv2_components.joint_mover.JointMover._rename_dependent_attrs">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_rename_dependent_attrs</span><span class="p">(</span><span class="n">renamed_nodes</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Renames the parentComponentBone attribute on any components that had a bone that was renamed.</span>
<span class="sd"> :param renamed_nodes: List of PyNodes and their new names. Used to check if the parentComponentBone attribute</span>
<span class="sd"> value is in that list, and if so, will then rename the attribute value for parentComponentBone.</span>
<span class="sd"> """</span>
<span class="n">components</span> <span class="o">=</span> <span class="n">component_utils</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="n">parent_joint_name</span> <span class="o">=</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="k">for</span> <span class="n">each</span> <span class="ow">in</span> <span class="n">renamed_nodes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">each</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">parent_joint_name</span><span class="p">:</span>
<span class="n">utils</span><span class="o">.</span><span class="n">set_attribute</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="s2">"parentComponentBone"</span><span class="p">,</span> <span class="n">each</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s2">"string"</span><span class="p">)</span></div>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="c1"># # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">metanode</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This property holds the metanode that is passed in from our component using the joint mover.</span>
<span class="sd"> :return: Returns the metanode from our component as a pynode.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_metanode</span>
<span class="nd">@metanode</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">metanode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_metanode</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">PyNode</span><span class="p">(</span><span class="n">new_value</span><span class="p">)</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>
|