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