Merge with trunk, revision 28528 - 28976.
[blender-staging.git] / release / scripts / modules / rigify / finger_curl.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
21 import bpy
22 from rigify import RigifyError
23 from rigify_utils import copy_bone_simple, get_side_name
24 from rna_prop_ui import rna_idprop_ui_prop_get
25
26 METARIG_NAMES = "finger_01", "finger_02", "finger_03"
27
28
29 def metarig_template():
30     # generated by rigify.write_meta_rig
31     bpy.ops.object.mode_set(mode='EDIT')
32     obj = bpy.context.active_object
33     arm = obj.data
34     bone = arm.edit_bones.new('finger.01')
35     bone.head[:] = 0.0000, 0.0000, 0.0000
36     bone.tail[:] = 0.0353, -0.0184, -0.0053
37     bone.roll = -2.8722
38     bone.connected = False
39     bone = arm.edit_bones.new('finger.02')
40     bone.head[:] = 0.0353, -0.0184, -0.0053
41     bone.tail[:] = 0.0702, -0.0364, -0.0146
42     bone.roll = -2.7099
43     bone.connected = True
44     bone.parent = arm.edit_bones['finger.01']
45     bone = arm.edit_bones.new('finger.03')
46     bone.head[:] = 0.0702, -0.0364, -0.0146
47     bone.tail[:] = 0.0903, -0.0461, -0.0298
48     bone.roll = -2.1709
49     bone.connected = True
50     bone.parent = arm.edit_bones['finger.02']
51
52     bpy.ops.object.mode_set(mode='OBJECT')
53     pbone = obj.pose.bones['finger.01']
54     pbone['type'] = 'finger_curl'
55
56
57 def metarig_definition(obj, orig_bone_name):
58     '''
59     The bone given is the first in a chain
60     Expects a chain with at least 1 child of the same base name.
61     eg.
62         finger_01 -> finger_02
63     '''
64
65     orig_bone = obj.data.bones[orig_bone_name]
66
67     bone_definition = [orig_bone.name]
68     
69     bone_definition.extend([child.name for child in orig_bone.children_recursive_basename])
70     
71     if len(bone_definition) < 2:
72         raise RigifyError("expected the chain to have at least 1 child from bone '%s' without the same base name" % orig_bone_name)
73     
74     return bone_definition
75
76
77 def deform(obj, definitions, base_names, options):
78     """ Creates the deform rig.
79     """
80     bpy.ops.object.mode_set(mode='EDIT')
81
82     three_digits = True if len(definitions) > 2 else False
83
84     # Create base digit bones: two bones, each half of the base digit.
85     f1a = copy_bone_simple(obj.data, definitions[0], "DEF-%s.01" % base_names[definitions[0]], parent=True)
86     f1b = copy_bone_simple(obj.data, definitions[0], "DEF-%s.02" % base_names[definitions[0]], parent=True)
87     f1a.connected = False
88     f1b.connected = False
89     f1b.parent = f1a
90     center = f1a.center
91     f1a.tail = center
92     f1b.head = center
93
94     # Create the other deform bones.
95     f2 = copy_bone_simple(obj.data, definitions[1], "DEF-%s" % base_names[definitions[1]], parent=True)
96     if three_digits:
97         f3 = copy_bone_simple(obj.data, definitions[2], "DEF-%s" % base_names[definitions[2]], parent=True)
98
99     # Store names before leaving edit mode
100     f1a_name = f1a.name
101     f1b_name = f1b.name
102     f2_name = f2.name
103     if three_digits:
104         f3_name = f3.name
105
106     # Leave edit mode
107     bpy.ops.object.mode_set(mode='OBJECT')
108
109     # Get the pose bones
110     f1a = obj.pose.bones[f1a_name]
111     f1b = obj.pose.bones[f1b_name]
112     f2 = obj.pose.bones[f2_name]
113     if three_digits:
114         f3 = obj.pose.bones[f3_name]
115
116     # Constrain the base digit's bones
117     con = f1a.constraints.new('DAMPED_TRACK')
118     con.name = "trackto"
119     con.target = obj
120     con.subtarget = definitions[1]
121
122     con = f1a.constraints.new('COPY_SCALE')
123     con.name = "copy_scale"
124     con.target = obj
125     con.subtarget = definitions[0]
126
127     con = f1b.constraints.new('COPY_ROTATION')
128     con.name = "copy_rot"
129     con.target = obj
130     con.subtarget = definitions[0]
131
132     # Constrain the other digit's bones
133     con = f2.constraints.new('COPY_TRANSFORMS')
134     con.name = "copy_transforms"
135     con.target = obj
136     con.subtarget = definitions[1]
137
138     if three_digits:
139         con = f3.constraints.new('COPY_TRANSFORMS')
140         con.name = "copy_transforms"
141         con.target = obj
142         con.subtarget = definitions[2]
143
144
145 def main(obj, bone_definition, base_names, options):
146     # *** EDITMODE
147     bpy.ops.object.mode_set(mode='EDIT')
148     
149     three_digits = True if len(bone_definition) > 2 else False
150
151     # get assosiated data
152     arm = obj.data
153     bb = obj.data.bones
154     eb = obj.data.edit_bones
155     pb = obj.pose.bones
156
157     org_f1 = bone_definition[0] # Original finger bone 01
158     org_f2 = bone_definition[1] # Original finger bone 02
159     if three_digits:
160         org_f3 = bone_definition[2] # Original finger bone 03
161
162     # Check options
163     if "bend_ratio" in options:
164         bend_ratio = options["bend_ratio"]
165     else:
166         bend_ratio = 0.4
167
168     yes = [1, 1.0, True, "True", "true", "Yes", "yes"]
169     make_hinge = False
170     if ("hinge" in options) and (eb[org_f1].parent is not None):
171         if options["hinge"] in yes:
172             make_hinge = True
173
174
175     # Needed if its a new armature with no keys
176     obj.animation_data_create()
177
178     # Create the control bone
179     base_name = base_names[bone_definition[0]].split(".", 1)[0]
180     if three_digits:
181         tot_len = eb[org_f1].length + eb[org_f2].length + eb[org_f3].length
182     else:
183         tot_len = eb[org_f1].length + eb[org_f2].length
184     control = copy_bone_simple(arm, bone_definition[0], base_name + get_side_name(base_names[bone_definition[0]]), parent=True).name
185     eb[control].connected = eb[org_f1].connected
186     eb[control].parent = eb[org_f1].parent
187     eb[control].length = tot_len
188
189     # Create secondary control bones
190     f1 = copy_bone_simple(arm, bone_definition[0], base_names[bone_definition[0]]).name
191     f2 = copy_bone_simple(arm, bone_definition[1], base_names[bone_definition[1]]).name
192     if three_digits:
193         f3 = copy_bone_simple(arm, bone_definition[2], base_names[bone_definition[2]]).name
194
195     # Create driver bones
196     df1 = copy_bone_simple(arm, bone_definition[0], "MCH-" + base_names[bone_definition[0]]).name
197     eb[df1].length /= 2
198     df2 = copy_bone_simple(arm, bone_definition[1], "MCH-" + base_names[bone_definition[1]]).name
199     eb[df2].length /= 2
200     if three_digits:
201         df3 = copy_bone_simple(arm, bone_definition[2], "MCH-" + base_names[bone_definition[2]]).name
202         eb[df3].length /= 2
203
204     # Set parents of the bones, interleaving the driver bones with the secondary control bones
205     if three_digits:
206         eb[f3].connected = False
207         eb[df3].connected = False
208     eb[f2].connected = False
209     eb[df2].connected = False
210     eb[f1].connected = False
211     eb[df1].connected = eb[org_f1].connected
212
213     if three_digits:
214         eb[f3].parent = eb[df3]
215         eb[df3].parent = eb[f2]
216     eb[f2].parent = eb[df2]
217     eb[df2].parent = eb[f1]
218     eb[f1].parent = eb[df1]
219     eb[df1].parent = eb[org_f1].parent
220
221     # Set up bones for hinge
222     if make_hinge:
223         socket = copy_bone_simple(arm, org_f1, "MCH-socket_"+control, parent=True).name
224         hinge = copy_bone_simple(arm, eb[org_f1].parent.name, "MCH-hinge_"+control).name
225
226         eb[control].connected = False
227         eb[control].parent = eb[hinge]
228
229     # Create the deform rig while we're still in edit mode
230     deform(obj, bone_definition, base_names, options)
231
232
233     # *** POSEMODE
234     bpy.ops.object.mode_set(mode='OBJECT')
235
236     # Set rotation modes and axis locks
237     pb[control].rotation_mode = obj.pose.bones[bone_definition[0]].rotation_mode
238     pb[control].lock_location = True, True, True
239     pb[control].lock_scale = True, False, True
240     pb[f1].rotation_mode = 'YZX'
241     pb[f2].rotation_mode = 'YZX'
242     if three_digits:
243         pb[f3].rotation_mode = 'YZX'
244     pb[f1].lock_location = True, True, True
245     pb[f2].lock_location = True, True, True
246     if three_digits:
247         pb[f3].lock_location = True, True, True
248     pb[df2].rotation_mode = 'YZX'
249     if three_digits:
250         pb[df3].rotation_mode = 'YZX'
251
252     # Add the bend_ratio property to the control bone
253     pb[control]["bend_ratio"] = bend_ratio
254     prop = rna_idprop_ui_prop_get(pb[control], "bend_ratio", create=True)
255     prop["soft_min"] = 0.0
256     prop["soft_max"] = 1.0
257
258     # Add hinge property to the control bone
259     if make_hinge:
260         pb[control]["hinge"] = 0.0
261         prop = rna_idprop_ui_prop_get(pb[control], "hinge", create=True)
262         prop["soft_min"] = 0.0
263         prop["soft_max"] = 1.0
264
265     # Constraints
266     con = pb[df1].constraints.new('COPY_LOCATION')
267     con.target = obj
268     con.subtarget = control
269
270     con = pb[df1].constraints.new('COPY_ROTATION')
271     con.target = obj
272     con.subtarget = control
273
274     con = pb[org_f1].constraints.new('COPY_TRANSFORMS')
275     con.target = obj
276     con.subtarget = f1
277
278     con = pb[org_f2].constraints.new('COPY_TRANSFORMS')
279     con.target = obj
280     con.subtarget = f2
281
282     if three_digits:
283         con = pb[org_f3].constraints.new('COPY_TRANSFORMS')
284         con.target = obj
285         con.subtarget = f3
286
287     if make_hinge:
288         con = pb[hinge].constraints.new('COPY_TRANSFORMS')
289         con.target = obj
290         con.subtarget = bb[org_f1].parent.name
291
292         hinge_driver_path = pb[control].path_from_id() + '["hinge"]'
293
294         fcurve = con.driver_add("influence")
295         driver = fcurve.driver
296         var = driver.variables.new()
297         driver.type = 'AVERAGE'
298         var.name = "var"
299         var.targets[0].id_type = 'OBJECT'
300         var.targets[0].id = obj
301         var.targets[0].data_path = hinge_driver_path
302
303         mod = fcurve.modifiers[0]
304         mod.poly_order = 1
305         mod.coefficients[0] = 1.0
306         mod.coefficients[1] = -1.0
307
308         con = pb[control].constraints.new('COPY_LOCATION')
309         con.target = obj
310         con.subtarget = socket
311
312     # Create the drivers for the driver bones (control bone scale rotates driver bones)
313     controller_path = pb[control].path_from_id() # 'pose.bones["%s"]' % control_bone_name
314
315     if three_digits:
316         finger_digits = [df2, df3]
317     else:
318         finger_digits = [df2]
319
320     i = 0
321     for bone in finger_digits:
322
323         # XXX - todo, any number
324         if i == 2:
325             break
326
327         pbone = pb[bone]
328
329         pbone.rotation_mode = 'YZX'
330         fcurve_driver = pbone.driver_add("rotation_euler", 0)
331
332         #obj.driver_add('pose.bones["%s"].scale', 1)
333         #obj.animation_data.drivers[-1] # XXX, WATCH THIS
334         driver = fcurve_driver.driver
335
336         # scale target
337         var = driver.variables.new()
338         var.name = "scale"
339         var.targets[0].id_type = 'OBJECT'
340         var.targets[0].id = obj
341         var.targets[0].data_path = controller_path + '.scale[1]'
342
343         # bend target
344         var = driver.variables.new()
345         var.name = "br"
346         var.targets[0].id_type = 'OBJECT'
347         var.targets[0].id = obj
348         var.targets[0].data_path = controller_path + '["bend_ratio"]'
349
350         # XXX - todo, any number
351         if three_digits:
352             if i == 0:
353                 driver.expression = '(-scale+1.0)*pi*2.0*(1.0-br)'
354             elif i == 1:
355                 driver.expression = '(-scale+1.0)*pi*2.0*br'
356         else:
357             driver.expression = driver.expression = '(-scale+1.0)*pi*2.0'
358
359         i += 1
360
361     # Last step setup layers
362     if "ex_layer" in options:
363         layer = [n==options["ex_layer"] for n in range(0,32)]
364     else:
365         layer = list(arm.bones[bone_definition[0]].layer)
366     #for bone_name in [f1, f2, f3]:
367     #    arm.bones[bone_name].layer = layer
368     arm.bones[f1].layer = layer
369     arm.bones[f2].layer = layer
370     if three_digits:
371         arm.bones[f3].layer = layer
372
373     layer = list(arm.bones[bone_definition[0]].layer)
374     bb[control].layer = layer
375
376     # no blending the result of this
377     return None
378