edits to the bone copy metarig type from Cessen, pointcache warning fix
[blender.git] / release / scripts / modules / rigify / palm_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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 import bpy
22 from rigify import get_layer_dict
23 from rigify_utils import copy_bone_simple, get_side_name
24 from rna_prop_ui import rna_idprop_ui_prop_get
25
26 # not used, defined for completeness
27 METARIG_NAMES = tuple()
28
29
30 def metarig_template():
31     # generated by rigify.write_meta_rig
32     bpy.ops.object.mode_set(mode='EDIT')
33     obj = bpy.context.active_object
34     arm = obj.data
35     bone = arm.edit_bones.new('hand')
36     bone.head[:] = 0.0082, -1.2492, 0.0000
37     bone.tail[:] = 0.0423, -0.4150, 0.0000
38     bone.roll = 0.0000
39     bone.connected = False
40     bone = arm.edit_bones.new('palm.03')
41     bone.head[:] = 0.0000, 0.0000, -0.0000
42     bone.tail[:] = 0.0506, 1.2781, -0.1299
43     bone.roll = -3.1396
44     bone.connected = False
45     bone.parent = arm.edit_bones['hand']
46     bone = arm.edit_bones.new('palm.02')
47     bone.head[:] = 0.5000, -0.0000, 0.0000
48     bone.tail[:] = 0.6433, 1.2444, -0.1299
49     bone.roll = -3.1357
50     bone.connected = False
51     bone.parent = arm.edit_bones['hand']
52     bone = arm.edit_bones.new('palm.01')
53     bone.head[:] = 1.0000, 0.0000, 0.0000
54     bone.tail[:] = 1.3961, 1.0084, -0.1299
55     bone.roll = -3.1190
56     bone.connected = False
57     bone.parent = arm.edit_bones['hand']
58     bone = arm.edit_bones.new('palm.04')
59     bone.head[:] = -0.5000, 0.0000, -0.0000
60     bone.tail[:] = -0.5674, 1.2022, -0.1299
61     bone.roll = 3.1386
62     bone.connected = False
63     bone.parent = arm.edit_bones['hand']
64     bone = arm.edit_bones.new('palm.05')
65     bone.head[:] = -1.0000, 0.0000, -0.0000
66     bone.tail[:] = -1.3286, 1.0590, -0.1299
67     bone.roll = 3.1239
68     bone.connected = False
69     bone.parent = arm.edit_bones['hand']
70     bone = arm.edit_bones.new('thumb')
71     bone.head[:] = 1.3536, -0.2941, 0.0000
72     bone.tail[:] = 2.1109, 0.4807, -0.1299
73     bone.roll = -3.0929
74     bone.connected = False
75     bone.parent = arm.edit_bones['hand']
76
77     bpy.ops.object.mode_set(mode='OBJECT')
78     pbone = obj.pose.bones['palm.01']
79     pbone['type'] = 'palm_curl'
80
81
82 def metarig_definition(obj, orig_bone_name):
83     '''
84     The bone given is the first in an array of siblings with a matching basename
85     sorted with pointer first, little finger last.
86     eg.
87         [pointer, middle, ring, pinky... ] # any number of fingers
88     '''
89     arm = obj.data
90
91     palm_bone = arm.bones[orig_bone_name]
92     palm_parent = palm_bone.parent
93     palm_base = palm_bone.basename
94     bone_definition = [bone.name for bone in palm_parent.children if bone.basename == palm_base]
95     bone_definition.sort()
96     bone_definition.reverse()
97
98     return [palm_parent.name] + bone_definition
99
100
101 def main(obj, bone_definition, base_names, options):
102     arm = obj.data
103
104     children = bone_definition[1:]
105
106     # Make a copy of the pinky
107     # simply assume the pinky has the lowest name
108     pinky_ebone = arm.edit_bones[children[0]]
109     ring_ebone = arm.edit_bones[children[1]]
110
111     # FIXME, why split the second one?
112     base_name = base_names[pinky_ebone.name].rsplit('.', 2)[0]
113
114     control_ebone = copy_bone_simple(arm, pinky_ebone.name, base_name + get_side_name(base_names[pinky_ebone.name]), parent=True)
115     control_name = control_ebone.name
116
117     offset = (pinky_ebone.head - ring_ebone.head)
118
119     control_ebone.translate(offset)
120
121     bpy.ops.object.mode_set(mode='OBJECT')
122
123     arm = obj.data
124     control_pbone = obj.pose.bones[control_name]
125     pinky_pbone = obj.pose.bones[children[0]]
126
127     control_pbone.rotation_mode = 'YZX'
128     control_pbone.lock_rotation = False, True, True
129
130     driver_fcurves = pinky_pbone.driver_add("rotation_euler")
131
132
133     controller_path = control_pbone.path_to_id()
134
135     # add custom prop
136     control_pbone["spread"] = 0.0
137     prop = rna_idprop_ui_prop_get(control_pbone, "spread", create=True)
138     prop["soft_min"] = -1.0
139     prop["soft_max"] = 1.0
140
141
142     # *****
143     driver = driver_fcurves[0].driver
144     driver.type = 'AVERAGE'
145
146     tar = driver.targets.new()
147     tar.name = "x"
148     tar.id_type = 'OBJECT'
149     tar.id = obj
150     tar.data_path = controller_path + ".rotation_euler[0]"
151
152
153     # *****
154     driver = driver_fcurves[1].driver
155     driver.expression = "-x/4.0"
156
157     tar = driver.targets.new()
158     tar.name = "x"
159     tar.id_type = 'OBJECT'
160     tar.id = obj
161     tar.data_path = controller_path + ".rotation_euler[0]"
162
163
164     # *****
165     driver = driver_fcurves[2].driver
166     driver.expression = "(1.0-cos(x))-s"
167
168     for fcurve in driver_fcurves:
169         fcurve.modifiers.remove(0) # grr dont need a modifier
170
171     tar = driver.targets.new()
172     tar.name = "x"
173     tar.id_type = 'OBJECT'
174     tar.id = obj
175     tar.data_path = controller_path + ".rotation_euler[0]"
176
177     tar = driver.targets.new()
178     tar.name = "s"
179     tar.id_type = 'OBJECT'
180     tar.id = obj
181     tar.data_path = controller_path + '["spread"]'
182
183
184     for i, child_name in enumerate(children):
185         child_pbone = obj.pose.bones[child_name]
186         child_pbone.rotation_mode = 'YZX'
187
188         if child_name != children[-1] and child_name != children[0]:
189
190             # this is somewhat arbitrary but seems to look good
191             inf = i / (len(children) + 1)
192             inf = 1.0 - inf
193             inf = ((inf * inf) + inf) / 2.0
194
195             # used for X/Y constraint
196             inf_minor = inf * inf
197
198             con = child_pbone.constraints.new('COPY_ROTATION')
199             con.name = "Copy Z Rot"
200             con.target = obj
201             con.subtarget = children[0] # also pinky_pbone
202             con.owner_space = con.target_space = 'LOCAL'
203             con.use_x, con.use_y, con.use_z = False, False, True
204             con.influence = inf
205
206             con = child_pbone.constraints.new('COPY_ROTATION')
207             con.name = "Copy XY Rot"
208             con.target = obj
209             con.subtarget = children[0] # also pinky_pbone
210             con.owner_space = con.target_space = 'LOCAL'
211             con.use_x, con.use_y, con.use_z = True, True, False
212             con.influence = inf_minor
213
214
215     child_pbone = obj.pose.bones[children[-1]]
216     child_pbone.rotation_mode = 'QUATERNION'
217
218     # fix at the end since there is some trouble with tx info not being updated otherwise
219     def x_direction():
220         # NOTE: the direction of the Z rotation depends on which side the palm is on.
221         # we could do a simple side-of-x test but better to work out the direction
222         # the hand is facing.
223         from Mathutils import Vector, AngleBetweenVecs
224         from math import degrees
225         child_pbone_01 = obj.pose.bones[children[0]].bone
226         child_pbone_02 = obj.pose.bones[children[1]].bone
227
228         rel_vec = child_pbone_01.head - child_pbone_02.head
229         x_vec = child_pbone_01.matrix.rotationPart() * Vector(1.0, 0.0, 0.0)
230
231         return degrees(AngleBetweenVecs(rel_vec, x_vec)) > 90.0
232
233     if x_direction(): # flip
234         driver.expression = "-(%s)" % driver.expression
235
236
237     # last step setup layers
238     layers = get_layer_dict(options)
239     arm.bones[control_name].layer = layers["extra"]
240
241
242     # no blending the result of this
243     return None