autorigging front end, access in pose mode armature panel (at the bottom)
[blender.git] / release / scripts / ui / properties_data_armature_rigify.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21
22 narrowui = 180
23
24
25 class PoseTemplateSettings(bpy.types.IDPropertyGroup):
26     pass
27
28
29 class PoseTemplate(bpy.types.IDPropertyGroup):
30     pass
31
32 PoseTemplate.StringProperty(attr="name",
33                 name="Name of the slave",
34                 description="",
35                 maxlen=64,
36                 default="")
37
38
39 PoseTemplateSettings.CollectionProperty(attr="templates", type=PoseTemplate, name="Templates", description="")
40 PoseTemplateSettings.IntProperty(attr="active_template_index",
41                 name="Index of the active slave",
42                 description="",
43                 default=-1,
44                 min=-1,
45                 max=65535)
46
47 PoseTemplateSettings.BoolProperty(attr="generate_def_rig",
48                 name="Create Deform Rig",
49                 description="Create a copy of the metarig, constrainted by the generated rig",
50                 default=False)
51
52 bpy.types.Scene.PointerProperty(attr="pose_templates", type=PoseTemplateSettings, name="Network Render", description="Network Render Settings")
53
54
55 def metarig_templates():
56     import rigify
57     return rigify.get_submodule_types()
58
59
60 class DATA_PT_template(bpy.types.Panel):
61     bl_label = "Meta-Rig Templates"
62     bl_space_type = 'PROPERTIES'
63     bl_region_type = 'WINDOW'
64     bl_context = "data"
65     bl_default_closed = True
66
67     templates = []
68
69     def poll(self, context):
70         obj = context.object
71         if obj:
72             return (obj.mode in ('POSE', 'OBJECT'))
73         return False
74
75     def draw(self, context):
76         layout = self.layout
77         try:
78             active_type = context.active_pose_bone["type"]
79         except:
80             active_type = None
81
82         scene = context.scene
83         pose_templates = scene.pose_templates
84
85         if pose_templates.active_template_index == -1:
86             pose_templates.active_template_index = 0
87
88         if not self.templates:
89             self.templates[:] = metarig_templates()
90
91         while(len(pose_templates.templates) < len(self.templates)):
92             pose_templates.templates.add()
93         while(len(pose_templates.templates) > len(self.templates)):
94             pose_templates.templates.remove(0)
95
96         for i, template_name in enumerate(self.templates):
97             template = pose_templates.templates[i]
98             if active_type == template_name:
99                 template.name = "<%s>" % template_name.replace("_", " ")
100             else:
101                 template.name = " %s " % template_name.replace("_", " ")
102
103         row = layout.row()
104         row.operator("pose.metarig_generate", text="Generate")
105         row.operator("pose.metarig_validate", text="Check")
106         row.operator("pose.metarig_graph", text="Graph")
107         row = layout.row()
108         row.prop(pose_templates, "generate_def_rig")
109
110         row = layout.row()
111         col = row.column()
112         col.template_list(pose_templates, "templates", pose_templates, "active_template_index", rows=1)
113
114         subrow = col.split(percentage=0.5, align=True)
115         subsubrow = subrow.row(align=True)
116         subsubrow.operator("pose.metarig_assign", text="Assign")
117         subsubrow.operator("pose.metarig_clear", text="Clear")
118
119         subsubrow = subrow.split(percentage=0.8)
120         subsubrow.operator("pose.metarig_sample_add", text="Sample").metarig_type = self.templates[pose_templates.active_template_index]
121         subsubrow.operator("pose.metarig_sample_add", text="All").metarig_type = "" # self.templates[pose_templates.active_template_index]
122
123         sub = row.column(align=True)
124         sub.operator("pose.metarig_reload", icon="FILE_REFRESH", text="")
125
126
127 # operators
128 from bpy.props import StringProperty
129
130
131 class Reload(bpy.types.Operator):
132     '''Re-Scan the metarig package directory for scripts'''
133
134     bl_idname = "pose.metarig_reload"
135     bl_label = "Re-Scan the list of metarig types"
136
137     def execute(self, context):
138         DATA_PT_template.templates[:] = metarig_templates()
139         return ('FINISHED',)
140
141
142 def rigify_report_exception(operator, exception):
143     import traceback
144     import sys
145     import os
146     # find the module name where the error happened
147     # hint, this is the metarig type!
148     exceptionType, exceptionValue, exceptionTraceback = sys.exc_info()
149     fn = traceback.extract_tb(exceptionTraceback)[-1][0]
150     fn = os.path.basename(fn)
151     fn = os.path.splitext(fn)[0]
152     message = []
153     if fn.startswith("__"):
154         message.append("Incorrect armature...")
155     else:
156         message.append("Incorrect armature for type '%s'" % fn)
157     message.append(exception.message)
158
159     message.reverse() # XXX - stupid! menu's are upside down!
160
161     operator.report(set(['INFO']), '\n'.join(message))
162
163
164 class Generate(bpy.types.Operator):
165     '''Generates a metarig from the active armature'''
166
167     bl_idname = "pose.metarig_generate"
168     bl_label = "Generate Metarig"
169
170     def execute(self, context):
171         import rigify
172         reload(rigify)
173
174         meta_def = context.scene.pose_templates.generate_def_rig
175
176         try:
177             rigify.generate_rig(context, context.object, META_DEF=meta_def)
178         except rigify.RigifyError as rig_exception:
179             rigify_report_exception(self, rig_exception)
180
181         return ('FINISHED',)
182
183
184 class Validate(bpy.types.Operator):
185     '''Validate a metarig from the active armature'''
186
187     bl_idname = "pose.metarig_validate"
188     bl_label = "Validate Metarig"
189
190     def execute(self, context):
191         import rigify
192         reload(rigify)
193         try:
194             rigify.validate_rig(context, context.object)
195         except rigify.RigifyError as rig_exception:
196             rigify_report_exception(self, rig_exception)
197         return ('FINISHED',)
198
199
200 class Sample(bpy.types.Operator):
201     '''Create a sample metarig to be modified before generating the final rig.'''
202
203     bl_idname = "pose.metarig_sample_add"
204     bl_label = "Re-Scan Metarig Scripts"
205
206     metarig_type = StringProperty(name="Type", description="Name of the rig type to generate a sample of, a blank string for all", maxlen=128, default="")
207
208     def execute(self, context):
209         import rigify
210         reload(rigify)
211         final = (self.properties.metarig_type == "")
212         objects = rigify.generate_test(context, metarig_type=self.properties.metarig_type, GENERATE_FINAL=final)
213
214         if len(objects) > 1:
215             for i, (obj_meta, obj_gen) in enumerate(objects):
216                 obj_meta.location.x = i * 1.0
217                 if obj_gen:
218                     obj_gen.location.x = i * 1.0
219
220         return ('FINISHED',)
221
222
223 class Graph(bpy.types.Operator):
224     '''Create a graph from the active armature through graphviz'''
225
226     bl_idname = "pose.metarig_graph"
227     bl_label = "Pose Graph"
228
229     def execute(self, context):
230         import os
231         import graphviz_export
232         import bpy
233         reload(graphviz_export)
234         obj = bpy.context.object
235         path = os.path.splitext(bpy.data.filename)[0] + "-" + bpy.utils.clean_name(obj.name)
236         path_dot = path + ".dot"
237         path_png = path + ".png"
238         saved = graphviz_export.graph_armature(bpy.context.object, path_dot, CONSTRAINTS=False, DRIVERS=False)
239
240         if saved:
241             # if we seriously want this working everywhere we'll need some new approach
242             #os.system("dot -Tpng %s > %s; gnome-open %s &" % (path_dot, path_png, path_png))
243             os.system("python /b/xdot.py '%s' &" % path_dot)
244             
245
246         return ('FINISHED',)
247
248
249 class AsScript(bpy.types.Operator):
250     '''Write the edit armature out as a python script'''
251
252     bl_idname = "pose.metarig_to_script"
253     bl_label = "Write Metarig to Script"
254     bl_register = True
255     bl_undo = True
256
257     path = StringProperty(name="File Path", description="File path used for exporting the Armature file", maxlen=1024, default="")
258
259     def execute(self, context):
260         import rigify_utils
261         reload(rigify_utils)
262         obj = context.object
263         code = rigify_utils.write_meta_rig(obj)
264         path = self.properties.path
265         file = open(path, "w")
266         file.write(code)
267         file.close()
268
269         return ('FINISHED',)
270
271     def invoke(self, context, event):
272         import os
273         obj = context.object
274         self.properties.path = os.path.splitext(bpy.data.filename)[0] + "-" + bpy.utils.clean_name(obj.name) + ".py"
275         wm = context.manager
276         wm.add_fileselect(self)
277         return ('RUNNING_MODAL',)
278
279
280 # operators that use the GUI
281 class ActiveAssign(bpy.types.Operator):
282     '''Assign to the active posebone'''
283
284     bl_idname = "pose.metarig_assign"
285     bl_label = "Assign to the active posebone"
286
287     def poll(self, context):
288         bone = context.active_pose_bone
289         return bool(bone and bone.id_data.mode == 'POSE')
290
291     def execute(self, context):
292         scene = context.scene
293         pose_templates = scene.pose_templates
294         template_name = DATA_PT_template.templates[pose_templates.active_template_index]
295         context.active_pose_bone["type"] = template_name
296         return ('FINISHED',)
297
298
299 class ActiveClear(bpy.types.Operator):
300     '''Clear type from the active posebone'''
301
302     bl_idname = "pose.metarig_clear"
303     bl_label = "Metarig Clear Type"
304
305     def poll(self, context):
306         bone = context.active_pose_bone
307         return bool(bone and bone.id_data.mode == 'POSE')
308
309     def execute(self, context):
310         scene = context.scene
311         del context.active_pose_bone["type"]
312         return ('FINISHED',)
313
314
315 import space_info
316 import dynamic_menu
317
318
319 class INFO_MT_armature_metarig_add(dynamic_menu.DynMenu):
320     bl_idname = "INFO_MT_armature_metarig_add"
321     bl_label = "Meta-Rig"
322
323     def draw(self, context):
324         import rigify
325
326         layout = self.layout
327         layout.operator_context = 'INVOKE_REGION_WIN'
328
329         for submodule_type in rigify.get_submodule_types():
330             text = bpy.utils.display_name(submodule_type)
331             layout.operator("pose.metarig_sample_add", text=text, icon='OUTLINER_OB_ARMATURE').metarig_type = submodule_type
332
333 bpy.types.register(DATA_PT_template)
334
335 bpy.types.register(PoseTemplateSettings)
336 bpy.types.register(PoseTemplate)
337
338 bpy.ops.add(Reload)
339 bpy.ops.add(Generate)
340 bpy.ops.add(Validate)
341 bpy.ops.add(Sample)
342 bpy.ops.add(Graph)
343 bpy.ops.add(AsScript)
344
345 bpy.ops.add(ActiveAssign)
346 bpy.ops.add(ActiveClear)
347
348
349 bpy.types.register(INFO_MT_armature_metarig_add)
350
351 menu_func = (lambda self, context: self.layout.menu("INFO_MT_armature_metarig_add", icon='OUTLINER_OB_ARMATURE'))
352 menu_item = dynamic_menu.add(bpy.types.INFO_MT_armature_add, menu_func)