blob: a0268d11e49a677714f660734f7af750fef87f72 (
plain) (
blame)
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
|
<!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>Control Utilities — ARTv2 2.0.1 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Rigging Utilities" href="rigging_utilities.html" />
<link rel="prev" title="Joint Mover Utilities" href="joint_mover_utils.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> ARTv2
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="interface_utils.html">Interface Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Control Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li>
</ul>
</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="utilities.html">Utilities</a> »</li>
<li>Control Utilities</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/sections/tech_docs/utilities/control_utilities.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="control-utilities">
<h1>Control Utilities<a class="headerlink" href="#control-utilities" title="Permalink to this headline">¶</a></h1>
<p>artv2.utilities.control_utilities</p>
<span class="target" id="module-artv2.utilities.control_utilities"></span><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">author:</th><td class="field-body">Jeremy Ernst</td>
</tr>
<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module provides utilities for building and setting control shapes. There is a class that builds a simple
interface that presents some of these features, like capturing/saving new control shapes, as well as editing the
names of control shapes.</td>
</tr>
</tbody>
</table>
<p>Special thanks to Vasil Shotarov :
<a class="reference external" href="https://bindpose.com/creating-maya-control-shape-manager/">https://bindpose.com/creating-maya-control-shape-manager/</a></p>
<dl class="class">
<dt id="artv2.utilities.control_utilities.ControlManagerUI">
<em class="property">class </em><code class="descname">ControlManagerUI</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#ControlManagerUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.ControlManagerUI" title="Permalink to this definition">¶</a></dt>
<dd><p>This class provides a user interface with methods to store new control shapes and edit existing control shapes.</p>
<img alt="../../../_images/ControlShapeManager.png" src="../../../_images/ControlShapeManager.png" />
<p>Functions:</p>
<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Capture</span> <span class="pre">Control</span> <span class="pre">Shape()</span></code></p>
<blockquote>
<div>This allows you to create a new control shape in Maya, and then capture that data and save it to a text file
for recreation later.</div></blockquote>
<p><code class="xref py py-func docutils literal notranslate"><span class="pre">View</span> <span class="pre">Saved</span> <span class="pre">Shape</span> <span class="pre">List()</span></code></p>
<blockquote>
<div>Opens a list widget that shows the shapes that have been saved to disk. You can also choose to preview them.</div></blockquote>
<p><code class="xref py py-func docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">Shapes()</span></code></p>
<blockquote>
<div>Opens a list widget that allows you to rename or delete the shapes.</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.get_all_shapes">
<code class="descname">get_all_shapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_all_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_all_shapes" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets and returns all shape files.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.get_knots">
<code class="descname">get_knots</code><span class="sig-paren">(</span><em>crv_shape=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_knots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_knots" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the knots for the given curve shape.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.get_shape">
<code class="descname">get_shape</code><span class="sig-paren">(</span><em>crv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#get_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.get_shape" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary containing all the necessery information for rebuilding the passed in crv.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.load_all_shapes">
<code class="descname">load_all_shapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#load_all_shapes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.load_all_shapes" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads all shapes into memory into a dictionary and returns that dictionary.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.load_shape">
<code class="descname">load_shape</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#load_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.load_shape" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the data that makes up the control shape from the given file.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.set_shape">
<code class="descname">set_shape</code><span class="sig-paren">(</span><em>crv</em>, <em>crv_shape_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#set_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.set_shape" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new shape on the crv transform, using the properties in the crvShapeDict.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.show_window">
<code class="descname">show_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#show_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.show_window" title="Permalink to this definition">¶</a></dt>
<dd><p>Shows the ControlManagerUI window.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.store_shape">
<code class="descname">store_shape</code><span class="sig-paren">(</span><em>shape_data</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#store_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.store_shape" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores the data that makes up the control shape to a file.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.control_utilities.validate_curve">
<code class="descname">validate_curve</code><span class="sig-paren">(</span><em>crv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/control_utilities.html#validate_curve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.control_utilities.validate_curve" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether the transform we are working with is actually a curve and returns it’s shapes</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="rigging_utilities.html" class="btn btn-neutral float-right" title="Rigging Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="joint_mover_utils.html" class="btn btn-neutral float-left" title="Joint Mover Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Jeremy Ernst
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|