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
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Component Base Class — ARTv2 2.0.1 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Pose" href="pose.html" />
<link rel="prev" title="Base Classes" href="base_classes.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> ARTv2
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">Component Base Class</a></li>
<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li>
<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li>
<li class="toctree-l4"><a class="reference internal" href="aim_helper.html">Aim Helper</a></li>
<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li>
<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">ARTv2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> »</li>
<li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li>
<li><a href="components.html">Components</a> »</li>
<li><a href="base_classes.html">Base Classes</a> »</li>
<li>Component Base Class</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/sections/tech_docs/components/component_base.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="component-base-class">
<h1>Component Base Class<a class="headerlink" href="#component-base-class" title="Permalink to this headline">¶</a></h1>
<p><em>Code author: Jeremy Ernst</em></p>
<dl class="class">
<dt id="artv2.components.base_components.base_component.ART_Component">
<em class="property">class </em><code class="descname">ART_Component</code><span class="sig-paren">(</span><em>prefix=''</em>, <em>suffix=''</em>, <em>network_node=None</em>, <em>side='Left'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for defining a component (arm, leg, torso, single joint, etc) in ARTv2. All components should inherit
from this class.</p>
<p>When creating a new component, here is a list of common attributes and functions you will want or need to override.</p>
<table border="1" class="docutils">
<colgroup>
<col width="11%" />
<col width="21%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Type</th>
<th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>attribute</td>
<td>nice_name</td>
<td>(string) The nice name of the component (as it will appear in UIs)</td>
</tr>
<tr class="row-odd"><td>attribute</td>
<td>category</td>
<td>(string) The name of the category where this component will show up in the
user interface. For example: “Limbs”, “Primitives”, etc.</td>
</tr>
<tr class="row-even"><td>attribute</td>
<td>base_name</td>
<td>The string base name of the component. This is a simple string used to
identify the component type and append onto nodes created by the component.
For example, on a leg component, the base_name is simply: “leg”</td>
</tr>
<tr class="row-odd"><td>attribute</td>
<td>has_sides</td>
<td>Bool for whether or not the component supports different sides,like a leg
or arm do.</td>
</tr>
<tr class="row-even"><td>attribute</td>
<td>can_overwrite_names</td>
<td>Bool for whether or not the user can overwrite the names of the joints of
this component.</td>
</tr>
<tr class="row-odd"><td>attribute</td>
<td>joint_mover_file</td>
<td>The relative path from the ARTv2 directory to the joint mover file of the
component. For example, self.joint_mover_file =
“resources/rigging_guides/root.ma”</td>
</tr>
<tr class="row-even"><td>attribute</td>
<td>mirror_table</td>
<td>A dictionary of translate and rotate attributes with their multiplier for
mirroring values to mirrored controls.</td>
</tr>
<tr class="row-odd"><td>function</td>
<td>_add_metadata</td>
<td>This method adds attributes you want to keep track of that are unique to
your component. Make sure that you still call on the base class’s
_add_metadata method to setup the required attributes.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.change_num_joints">
<code class="descname">change_num_joints</code><span class="sig-paren">(</span><em>joints</em>, <em>offset_movers</em>, <em>state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.change_num_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.change_num_joints" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the build state (whether or not they will be created) of the given joints to the given state.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>joints</strong> – List of PyNode joints to toggle build state on</li>
<li><strong>offset_movers</strong> – List of PyNode offset movers to toggle visibility on.</li>
<li><strong>state</strong> – The build state to set.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.copy_settings">
<code class="descname">copy_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.copy_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.copy_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Copies the values of the class properties (things like number of twist joints, etc) and writes them to a temp
file.</p>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.create_mirror">
<code class="descname">create_mirror</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.create_mirror"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.create_mirror" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a mirror of the component, then mirrors its transformations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>prefix</strong> (<em>str</em>) – prefix to give the created mirrored component.</li>
<li><strong>suffix</strong> (<em>str</em>) – suffix to give the created mirrored component.</li>
<li><strong>parent</strong> (<em>str</em>) – parent joint for the created mirrored component.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Instance of the mirrored component</p>
</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>example usage:</dt>
<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span>
<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span>
<span class="n">mirror</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">create_mirror</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"r"</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="s2">"root"</span><span class="p">)</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the component from the scene.</p>
<dl class="docutils">
<dt>example usage:</dt>
<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span>
<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span>
<span class="n">leg</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.duplicate">
<code class="descname">duplicate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.duplicate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.duplicate" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a duplicate instance of self, with the same settings, parent, and transforms. A unique trailing suffix
is appended to prevent naming issues.</p>
<dl class="docutils">
<dt>example usage:</dt>
<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span>
<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span>
<span class="n">leg</span><span class="o">.</span><span class="n">duplicate</span><span class="p">()</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.paste_settings">
<code class="descname">paste_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.paste_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.paste_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves values from the temp file (if it exists) and sets any properties of the class matching those stored in
the temp file, to those values.</p>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.rename_joint">
<code class="descname">rename_joint</code><span class="sig-paren">(</span><em>new_name</em>, <em>old_name</em>, <em>offset_mover</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.rename_joint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.rename_joint" title="Permalink to this definition">¶</a></dt>
<dd><p>Renames a joint that the component creates. The component’s prefix and suffix will be maintained.
For example, if the component has a prefix of “_l”, and it will create a joint named foot, the user can rename
foot to ankle, and the new name will be l_ankle.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>new_name</strong> (<em>str</em>) – The new name of the joint</li>
<li><strong>old_name</strong> (<em>str</em>) – The old name of the joint</li>
<li><strong>offset_mover</strong> – The offset mover (PyNode) for the joint</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>example usage:</dt>
<dd><div class="first last highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">asset</span> <span class="o">=</span> <span class="n">rig_asset</span><span class="o">.</span><span class="n">ART_RigAsset</span><span class="p">()</span>
<span class="n">leg</span> <span class="o">=</span> <span class="n">leg</span><span class="o">.</span><span class="n">BipedLeg</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"l"</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">component_utils</span><span class="o">.</span><span class="n">get_joint_labels</span><span class="p">(</span><span class="n">leg</span><span class="o">.</span><span class="n">network_node</span><span class="p">)</span>
<span class="n">leg</span><span class="o">.</span><span class="n">rename_joint</span><span class="p">(</span><span class="s2">"ankle"</span><span class="p">,</span> <span class="s2">"foot"</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"foot"</span><span class="p">)[</span><span class="mi">2</span><span class="p">])</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.reset_settings">
<code class="descname">reset_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.reset_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.reset_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets all values of the class properties to the default they had at creation.</p>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.set_mirror">
<code class="descname">set_mirror</code><span class="sig-paren">(</span><em>mirror_metanode</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_mirror"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_mirror" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the mirror component if the passed in mirror component is of the same class type.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mirror_metanode</strong> – The network node for the mirror component to be set.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.set_side">
<code class="descname">set_side</code><span class="sig-paren">(</span><em>new_side</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_side"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_side" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the side of a component if that components supports setting sides. Setting a side from left to right, for
example, will change the local rotation axis to be mirrored on the joints.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>new_side</strong> – This can be any of the following: “left”, “Left”, “right”, “Right”, 0, 1</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.base_component.ART_Component.set_twist_joints">
<code class="descname">set_twist_joints</code><span class="sig-paren">(</span><em>attr</em>, <em>new_number</em>, <em>attr_min</em>, <em>attr_max</em>, <em>keyword</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/base_component.html#ART_Component.set_twist_joints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.set_twist_joints" title="Permalink to this definition">¶</a></dt>
<dd><p>Base logic for setting number of twist joints via properties in components like arm, leg.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>attr</strong> – the property name</li>
<li><strong>new_number</strong> – The new value to set the property to</li>
<li><strong>attr_min</strong> – The minimum value of allowable values</li>
<li><strong>attr_max</strong> – The maximum value of allowable values</li>
<li><strong>keyword</strong> – The keyword to search mover nodes for</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="artv2.components.base_components.base_component.ART_Component.network_node">
<code class="descname">network_node</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.network_node" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the network node that contains this component’s metadata.</p>
</dd></dl>
<dl class="attribute">
<dt id="artv2.components.base_components.base_component.ART_Component.parent">
<code class="descname">parent</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.parent" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the joint name of the parent of this component.</p>
</dd></dl>
<dl class="attribute">
<dt id="artv2.components.base_components.base_component.ART_Component.prefix">
<code class="descname">prefix</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.prefix" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the component’s prefix (optional)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s prefix.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="artv2.components.base_components.base_component.ART_Component.suffix">
<code class="descname">suffix</code><a class="headerlink" href="#artv2.components.base_components.base_component.ART_Component.suffix" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the component’s suffix (optional)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s suffix.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<div class="section" id="properties">
<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
<dl class="attribute">
<dt id="prefix">
<code class="descname">prefix</code><a class="headerlink" href="#prefix" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the component’s prefix (optional)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s prefix.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="suffix">
<code class="descname">suffix</code><a class="headerlink" href="#suffix" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the component’s suffix (optional)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the component’s suffix.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="parent">
<code class="descname">parent</code><a class="headerlink" href="#parent" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the joint name of the parent of this component.</p>
</dd></dl>
<dl class="attribute">
<dt id="network_node">
<code class="descname">network_node</code><a class="headerlink" href="#network_node" title="Permalink to this definition">¶</a></dt>
<dd><p>This property holds the network node that contains this module’s metadata.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pose.html" class="btn btn-neutral float-right" title="Pose" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="base_classes.html" class="btn btn-neutral float-left" title="Base Classes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Jeremy Ernst
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|