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
|
<!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</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="ARTv2 2.0.1 documentation" href="../index.html"/>
<link rel="up" title="Module code" href="index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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" style="background-color: #343131">
<a href="http://www.jeremyernst.com">
<img src="../_static/lsst-logo-dark.svg" class="logo" />
<span class="project-title">ARTv2</span>
</a>
</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">ARTv2 Technical Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" 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="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="dd-masthead">
<h1 class="dd-title">ARTv2</h1>
<ul class="dd-authors">
</ul>
<p>Latest Revision: <a href="#change-record"></a></p>
</div>
<div itemprop="articleBody">
<h1>Source code for artv2</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">maya</span> <span class="k">import</span> <span class="n">cmds</span><span class="p">,</span> <span class="n">mel</span><span class="p">,</span> <span class="n">OpenMayaMPx</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">PySide</span> <span class="k">import</span> <span class="n">QtCore</span>
<span class="kn">from</span> <span class="nn">PySide</span> <span class="k">import</span> <span class="n">QtGui</span> <span class="k">as</span> <span class="n">QtWidgets</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">PySide2</span> <span class="k">import</span> <span class="n">QtCore</span>
<span class="kn">from</span> <span class="nn">PySide2</span> <span class="k">import</span> <span class="n">QtWidgets</span>
<span class="n">SETTINGS</span> <span class="o">=</span> <span class="n">QtCore</span><span class="o">.</span><span class="n">QSettings</span><span class="p">(</span><span class="s2">"Jeremy Ernst"</span><span class="p">,</span> <span class="s2">"artv2"</span><span class="p">)</span>
<span class="n">TOOLS_PATH</span> <span class="o">=</span> <span class="n">SETTINGS</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="s2">"tools_path"</span><span class="p">)</span>
<span class="n">SCRIPTS_PATH</span> <span class="o">=</span> <span class="n">SETTINGS</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="s2">"script_path"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_create_artv2_menu</span><span class="p">():</span>
<span class="sd">""" Creates a menu on Maya's main menu bar for accessing various tools and features within artv2."""</span>
<span class="n">maya_window</span> <span class="o">=</span> <span class="n">mel</span><span class="o">.</span><span class="n">eval</span><span class="p">(</span><span class="s1">'$temp1=$gMainWindow'</span><span class="p">)</span>
<span class="n">artv2_menu</span> <span class="o">=</span> <span class="n">cmds</span><span class="o">.</span><span class="n">menu</span><span class="p">(</span><span class="s2">"artv2_custom_menu"</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"ART v2"</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">maya_window</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Animation Rigging Toolkit 2.0"</span><span class="p">,</span> <span class="n">bld</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">enable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">divider</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dividerLabel</span><span class="o">=</span><span class="s2">"Rigging:"</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Rig Creator"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">create_new_rig</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Edit Rig"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">edit_existing_rig</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">divider</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dividerLabel</span><span class="o">=</span><span class="s2">"Animation:"</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Add Rig For Animation"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">add_rig_for_animation</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Animation Tools"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_animation_tools</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">divider</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dividerLabel</span><span class="o">=</span><span class="s2">"Misc:"</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Settings"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_settings_and_preferences</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Hotkey Editor"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_hotkey_editor</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Pick-Walking Setup"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_pickwalk_tool</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">divider</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dividerLabel</span><span class="o">=</span><span class="s2">"Help:"</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Technical Documentation"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_help_documentation</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Check For Updates"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">check_for_updates</span><span class="p">)</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">menuItem</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">artv2_menu</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">"Report an Issue"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="n">launch_issue_reporter</span><span class="p">)</span>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="create_new_rig"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.create_new_rig">[docs]</a><span class="k">def</span> <span class="nf">create_new_rig</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_rig_creator module, which aids and assists in creation of a rig."""</span>
<span class="kn">import</span> <span class="nn">artv2_rigging_tools.art_rig_creator</span> <span class="k">as</span> <span class="nn">art_rig_creator</span>
<span class="n">reload</span><span class="p">(</span><span class="n">art_rig_creator</span><span class="p">)</span>
<span class="n">art_rig_creator</span><span class="o">.</span><span class="n">run</span><span class="p">()</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="edit_existing_rig"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.edit_existing_rig">[docs]</a><span class="k">def</span> <span class="nf">edit_existing_rig</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_add_edit_rig_ui module, which in this case, opens the rig file for editing."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">edit_existing_rig</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="add_rig_for_animation"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.add_rig_for_animation">[docs]</a><span class="k">def</span> <span class="nf">add_rig_for_animation</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_add_edit_rig_ui module, which in this case, references in the rig file for animation."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">add_rig_for_animation</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_animation_tools"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_animation_tools">[docs]</a><span class="k">def</span> <span class="nf">launch_animation_tools</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_animation_tools_ui tool, which houses the control picker and the animation tools"""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_animation_tools</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_settings_and_preferences"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_settings_and_preferences">[docs]</a><span class="k">def</span> <span class="nf">launch_settings_and_preferences</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Launches the art_settings module, which allows the user to change the tools directory, the scripts directory,</span>
<span class="sd"> the icons directory, and the projects directory locations.</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_settings_and_preferences</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_hotkey_editor"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_hotkey_editor">[docs]</a><span class="k">def</span> <span class="nf">launch_hotkey_editor</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Launches the art_hotkey_editor module, which allows the user to bind keys to certain actions specific</span>
<span class="sd"> to the animation and rigging tools.</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_hotkey_editor</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_pickwalk_tool"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_pickwalk_tool">[docs]</a><span class="k">def</span> <span class="nf">launch_pickwalk_tool</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_setup_pickwalk module, which allows the user to setup custom pick-walking for the rig."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_pickwalk_tool</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="check_for_updates"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.check_for_updates">[docs]</a><span class="k">def</span> <span class="nf">check_for_updates</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_updater module, which will check for updates from the github repository."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">check_for_updates</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_issue_reporter"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_issue_reporter">[docs]</a><span class="k">def</span> <span class="nf">launch_issue_reporter</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Launches the art_issue_reporter module, which gives an interface for posting issues to github."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_issue_reporter</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<div class="viewcode-block" id="launch_help_documentation"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.launch_help_documentation">[docs]</a><span class="k">def</span> <span class="nf">launch_help_documentation</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">""" Loads the url for the online help documentation."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> not yet implemented."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">launch_help_documentation</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span></div>
<span class="c1"># noinspection PyUnusedLocal</span>
<span class="k">def</span> <span class="nf">_remove_custom_menu</span><span class="p">():</span>
<span class="sd">""" Removes the ARTv2 menu from Maya's main menu bar."""</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">deleteUI</span><span class="p">(</span><span class="s2">"artv2_custom_menu"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_install_tools</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Presents a QMessageBox prompting the user to locate the ARTv2 directory so Maya is aware of where the</span>
<span class="sd"> tools are located.</span>
<span class="sd"> """</span>
<span class="n">message_box</span> <span class="o">=</span> <span class="n">QtWidgets</span><span class="o">.</span><span class="n">QMessageBox</span><span class="p">()</span>
<span class="n">message_box</span><span class="o">.</span><span class="n">setText</span><span class="p">(</span><span class="s2">"Error: Could not locate </span><span class="se">\"</span><span class="s2">ARTv2</span><span class="se">\"</span><span class="s2"> directory.</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"Please locate the folder using the </span><span class="se">\"</span><span class="s2">Browse</span><span class="se">\"</span><span class="s2"> button."</span><span class="p">)</span>
<span class="n">message_box</span><span class="o">.</span><span class="n">setIcon</span><span class="p">(</span><span class="n">QtWidgets</span><span class="o">.</span><span class="n">QMessageBox</span><span class="o">.</span><span class="n">Warning</span><span class="p">)</span>
<span class="n">message_box</span><span class="o">.</span><span class="n">addButton</span><span class="p">(</span><span class="s2">"Cancel"</span><span class="p">,</span> <span class="n">QtWidgets</span><span class="o">.</span><span class="n">QMessageBox</span><span class="o">.</span><span class="n">RejectRole</span><span class="p">)</span>
<span class="n">message_box</span><span class="o">.</span><span class="n">addButton</span><span class="p">(</span><span class="s2">"Browse"</span><span class="p">,</span> <span class="n">QtWidgets</span><span class="o">.</span><span class="n">QMessageBox</span><span class="o">.</span><span class="n">ActionRole</span><span class="p">)</span>
<span class="k">if</span> <span class="n">message_box</span><span class="o">.</span><span class="n">exec_</span><span class="p">():</span>
<span class="n">_browse</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_browse</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Opens a file dialog for the user to locate the ARTv2 directory. Once the directory is confirmed, QSettings are set</span>
<span class="sd"> to record the different file paths for the base tools directory, and the icons, artv2_source, and projects directory.</span>
<span class="sd"> """</span>
<span class="n">artv2_directory</span> <span class="o">=</span> <span class="n">cmds</span><span class="o">.</span><span class="n">fileDialog2</span><span class="p">(</span><span class="n">dialogStyle</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">fileMode</span><span class="o">=</span><span class="mi">3</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">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">artv2_directory</span><span class="p">)</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"ARTv2"</span><span class="p">):</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Selected directory is not valid. Please locate the ARTv2 directory."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_browse</span><span class="p">()</span>
<span class="n">SETTINGS</span><span class="o">.</span><span class="n">setValue</span><span class="p">(</span><span class="s2">"tools_path"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">artv2_directory</span><span class="p">))</span>
<span class="n">SETTINGS</span><span class="o">.</span><span class="n">setValue</span><span class="p">(</span><span class="s2">"script_path"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">artv2_directory</span> <span class="o">+</span> <span class="s2">"/artv2_source"</span><span class="p">))</span>
<span class="n">SETTINGS</span><span class="o">.</span><span class="n">setValue</span><span class="p">(</span><span class="s2">"icon_path"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">artv2_directory</span> <span class="o">+</span> <span class="s2">"/resources/icons"</span><span class="p">))</span>
<span class="n">SETTINGS</span><span class="o">.</span><span class="n">setValue</span><span class="p">(</span><span class="s2">"project_path"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">artv2_directory</span> <span class="o">+</span> <span class="s2">"/projects"</span><span class="p">))</span>
<span class="k">global</span> <span class="n">TOOLS_PATH</span><span class="p">,</span> <span class="n">SCRIPTS_PATH</span>
<span class="n">TOOLS_PATH</span> <span class="o">=</span> <span class="n">SETTINGS</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="s2">"tools_path"</span><span class="p">)</span>
<span class="n">SCRIPTS_PATH</span> <span class="o">=</span> <span class="n">SETTINGS</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="s2">"script_path"</span><span class="p">)</span>
<span class="n">_setup_tools</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_setup_tools</span><span class="p">():</span>
<span class="sd">""" Adds the necessary paths to sys.path if the QSettings value for the tools_path exists."""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">TOOLS_PATH</span><span class="p">:</span>
<span class="n">_install_tools</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">TOOLS_PATH</span><span class="p">):</span>
<span class="n">_install_tools</span><span class="p">()</span>
<span class="k">return</span> <span class="c1"># Early return.</span>
<span class="n">paths_to_add</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">_build_sys_path</span><span class="p">,</span> <span class="p">[</span><span class="s2">""</span><span class="p">,</span> <span class="s2">"artv2_utilities"</span><span class="p">,</span> <span class="s2">"artv2_rigging_tools"</span><span class="p">,</span> <span class="s2">"artv2_rig_modules"</span><span class="p">,</span>
<span class="s2">"third_party"</span><span class="p">])</span>
<span class="nb">map</span><span class="p">(</span><span class="n">_add_system_paths</span><span class="p">,</span> <span class="n">paths_to_add</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_build_sys_path</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="sd">""" Construct a new path, appending the scripts directory with its passed-in sub-directories."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">SCRIPTS_PATH</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_add_system_paths</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="sd">""" Add the incoming path to sys.path."""</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">))</span>
<span class="c1"># noinspection PyPep8Naming</span>
<div class="viewcode-block" id="initializePlugin"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.initializePlugin">[docs]</a><span class="k">def</span> <span class="nf">initializePlugin</span><span class="p">(</span><span class="n">mobject</span><span class="p">):</span>
<span class="sd">""" Boiler-plate function needed by Maya to initialize plugin."""</span>
<span class="n">mplugin</span> <span class="o">=</span> <span class="n">OpenMayaMPx</span><span class="o">.</span><span class="n">MFnPlugin</span><span class="p">(</span><span class="n">mobject</span><span class="p">,</span> <span class="s2">"Jeremy Ernst"</span><span class="p">,</span> <span class="s2">"1.0"</span><span class="p">)</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">mplugin</span><span class="o">.</span><span class="n">registerUI</span><span class="p">(</span><span class="n">_create_artv2_menu</span><span class="p">,</span> <span class="n">_remove_custom_menu</span><span class="p">)</span>
<span class="n">_setup_tools</span><span class="p">()</span>
<span class="n">cmds</span><span class="o">.</span><span class="n">help</span><span class="p">(</span><span class="n">popupMode</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">status</span></div>
<span class="c1"># noinspection PyPep8Naming</span>
<div class="viewcode-block" id="uninitializePlugin"><a class="viewcode-back" href="../td_artv2_plugin.html#artv2.uninitializePlugin">[docs]</a><span class="k">def</span> <span class="nf">uninitializePlugin</span><span class="p">(</span><span class="n">mobject</span><span class="p">):</span>
<span class="sd">""" Boiler-plate function needed by Maya to uninitialize plugin."""</span>
<span class="n">OpenMayaMPx</span><span class="o">.</span><span class="n">MFnPlugin</span><span class="p">(</span><span class="n">mobject</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/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'2.0.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|