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