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
|
<!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="Root Component" href="root_component.html" />
<link rel="prev" title="Creating Your Own Component" href="creating_custom_component.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"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Component Base Class</a></li>
<li class="toctree-l3"><a class="reference internal" href="root_component.html">Root Component</a></li>
<li class="toctree-l3"><a class="reference internal" href="biped_leg_component.html">Bipedal Leg Component</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</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>Component Base Class</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/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_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><span class="sig-paren">)</span><a class="reference internal" href="_modules/artv2_components/base_component.html#ART_Component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2_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>The string nice name of the component (as it will appear in UIs)</td>
</tr>
<tr class="row-odd"><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-even"><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-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>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_component.ART_Component._add_metadata">
<code class="descname">_add_metadata</code><span class="sig-paren">(</span><em>network_node</em>, <em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/artv2_components/base_component.html#ART_Component._add_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2_components.base_component.ART_Component._add_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Method for adding metadata attributes to the network node that are important for the component. The ones created
by the base class are necessary for all components.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>network_node</strong> (<em>PyNode</em>) – component’s network node name to add attributes to.</li>
<li><strong>prefix</strong> (<em>str</em>) – the component’s (optional) prefix.</li>
<li><strong>suffix</strong> (<em>str</em>) – the component’s (optional) suffix.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="artv2_components.base_component.ART_Component._create_component">
<code class="descname">_create_component</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/artv2_components/base_component.html#ART_Component._create_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2_components.base_component.ART_Component._create_component" title="Permalink to this definition">¶</a></dt>
<dd><p>Method for adding the component to the Maya scene. Calls on various functions to accomplish.</p>
</dd></dl>
<dl class="method">
<dt id="artv2_components.base_component.ART_Component._create_network_node">
<code class="descname">_create_network_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/artv2_components/base_component.html#ART_Component._create_network_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2_components.base_component.ART_Component._create_network_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates the metanode that will store metadata for the component.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the metanode.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">PyNode</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="root_component.html" class="btn btn-neutral float-right" title="Root Component" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="creating_custom_component.html" class="btn btn-neutral float-left" title="Creating Your Own Component" 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>
|