- include example input rigs for each autorig type, running metarig_template() in...
[blender.git] / release / scripts / modules / rigify / neck.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 import bpy
20 from rigify import bone_class_instance, copy_bone_simple
21 from rna_prop_ui import rna_idprop_ui_prop_get
22
23
24 def metarig_template():
25     bpy.ops.object.mode_set(mode='EDIT')
26     obj = bpy.context.object
27     arm = obj.data
28     bone = arm.edit_bones.new('body')
29     bone.head[:] = -0.0000, -0.2771, -1.3345
30     bone.tail[:] = -0.0000, -0.1708, -0.3984
31     bone.roll = 0.0000
32     bone.connected = False
33     bone = arm.edit_bones.new('head')
34     bone.head[:] = -0.0000, -0.1708, -0.1984
35     bone.tail[:] = 0.0000, -0.1708, 1.6016
36     bone.roll = -0.0000
37     bone.connected = False
38     bone.parent = arm.edit_bones['body']
39     bone = arm.edit_bones.new('neck.01')
40     bone.head[:] = 0.0000, -0.1708, -0.1984
41     bone.tail[:] = -0.0000, -0.0994, 0.1470
42     bone.roll = -0.0000
43     bone.connected = False
44     bone.parent = arm.edit_bones['head']
45     bone = arm.edit_bones.new('neck.02')
46     bone.head[:] = -0.0000, -0.0994, 0.1470
47     bone.tail[:] = 0.0000, -0.2428, 0.5162
48     bone.roll = -0.0000
49     bone.connected = True
50     bone.parent = arm.edit_bones['neck.01']
51     bone = arm.edit_bones.new('neck.03')
52     bone.head[:] = 0.0000, -0.2428, 0.5162
53     bone.tail[:] = 0.0000, -0.4190, 0.8722
54     bone.roll = -0.0000
55     bone.connected = True
56     bone.parent = arm.edit_bones['neck.02']
57     bone = arm.edit_bones.new('neck.04')
58     bone.head[:] = 0.0000, -0.4190, 0.8722
59     bone.tail[:] = 0.0000, -0.5111, 1.1956
60     bone.roll = 0.0000
61     bone.connected = True
62     bone.parent = arm.edit_bones['neck.03']
63     bone = arm.edit_bones.new('neck.05')
64     bone.head[:] = 0.0000, -0.5111, 1.1956
65     bone.tail[:] = 0.0000, -0.5391, 1.6081
66     bone.roll = 0.0000
67     bone.connected = True
68     bone.parent = arm.edit_bones['neck.04']
69
70     bpy.ops.object.mode_set(mode='OBJECT')
71     pbone = obj.pose.bones['head']
72     pbone['type'] = 'neck'
73
74
75 def main(obj, orig_bone_name):
76     from Mathutils import Vector
77     
78     arm = obj.data
79
80     # Initialize container classes for convenience
81     mt = bone_class_instance(obj, ["body", "head"]) # meta
82     mt.head = orig_bone_name
83     mt.update()
84     mt.body = mt.head_e.parent.name
85     mt.update()
86
87     # child chain of the 'head'
88     children = mt.head_e.children
89     if len(children) != 1:
90         print("expected the head to have only 1 child.")
91
92     child = children[0]
93     neck_chain = [child] + child.children_recursive_basename
94     neck_chain = [child.name for child in neck_chain]
95     
96     mt_chain = bone_class_instance(obj, [("neck_%.2d" % (i + 1)) for i in range(len(neck_chain))]) # 99 bones enough eh?
97     for i, child_name in enumerate(neck_chain):
98         setattr(mt_chain, ("neck_%.2d" % (i + 1)), child_name)
99     mt_chain.update()
100
101     neck_chain_basename = mt_chain.neck_01_e.basename
102     neck_chain_segment_length = mt_chain.neck_01_e.length
103     
104     ex = bone_class_instance(obj, ["body", "head", "head_hinge","neck_socket"]) # hinge & extras
105     
106     # Add the head hinge at the bodys location, becomes the parent of the original head
107     
108     
109     # Copy the head bone and offset
110     ex.head_e = copy_bone_simple(arm, mt.head, "MCH_%s" % mt.head, parent=True)
111     ex.head = ex.head_e.name
112     # offset
113     head_length = ex.head_e.length
114     ex.head_e.head.y += head_length / 2.0
115     ex.head_e.tail.y += head_length / 2.0
116     
117     # Yes, use the body bone but call it a head hinge
118     ex.head_hinge_e = copy_bone_simple(arm, mt.body, "MCH_%s_hinge" % mt.head, parent=True)
119     ex.head_hinge = ex.head_hinge_e.name
120     ex.head_hinge_e.head.y += head_length / 4.0
121     ex.head_hinge_e.tail.y += head_length / 4.0
122
123     # reparent the head, assume its not connected
124     mt.head_e.parent = ex.head_hinge_e
125     
126     # Insert the neck socket, the head copys this loation
127     ex.neck_socket_e = arm.edit_bones.new("MCH-%s_socked" % neck_chain_basename)
128     ex.neck_socket = ex.neck_socket_e.name
129     ex.neck_socket_e.parent = mt.body_e
130     ex.neck_socket_e.head = mt.head_e.head
131     ex.neck_socket_e.tail = mt.head_e.head - Vector(0.0, neck_chain_segment_length / 2.0, 0.0)
132     ex.neck_socket_e.roll = 0.0
133     
134     # offset the head, not really needed since it has a copyloc constraint
135     mt.head_e.head.y += head_length / 4.0
136     mt.head_e.tail.y += head_length / 4.0
137
138     for i in range(len(neck_chain)):
139         neck_e = getattr(mt_chain, "neck_%.2d_e" % (i + 1))
140         
141         # dont store parent names, re-reference as each chain bones parent.
142         neck_e_parent = arm.edit_bones.new("MCH-rot_%s" % neck_e.name)
143         neck_e_parent.head = neck_e.head
144         neck_e_parent.tail = neck_e.head + Vector(0.0, 0.0, neck_chain_segment_length / 2.0)
145         neck_e_parent.roll = 0.0
146         
147         orig_parent = neck_e.parent
148         neck_e.connected = False
149         neck_e.parent = neck_e_parent
150         neck_e_parent.connected = False
151         
152         if i == 0:
153             neck_e_parent.parent = mt.body_e
154         else:
155             neck_e_parent.parent = orig_parent
156     
157     
158     bpy.ops.object.mode_set(mode='OBJECT')
159     
160     mt.update()
161     mt_chain.update()
162     ex.update()
163     
164     # Simple one off constraints, no drivers
165     con = mt.head_p.constraints.new('COPY_LOCATION')
166     con.target = obj
167     con.subtarget = ex.neck_socket
168     
169     con = ex.head_p.constraints.new('COPY_ROTATION')
170     con.target = obj
171     con.subtarget = mt.head
172     
173     # driven hinge
174     prop = rna_idprop_ui_prop_get(mt.head_p, "hinge", create=True)
175     mt.head_p["hinge"] = 0.0
176     prop["soft_min"] = 0.0
177     prop["soft_max"] = 1.0
178     
179     con = ex.head_hinge_p.constraints.new('COPY_ROTATION')
180     con.name = "hinge"
181     con.target = obj
182     con.subtarget = mt.body
183     
184     # add driver
185     hinge_driver_path = mt.head_p.path_to_id() + '["hinge"]'
186     
187     fcurve = con.driver_add("influence", 0)
188     driver = fcurve.driver
189     tar = driver.targets.new()
190     driver.type = 'AVERAGE'
191     tar.name = "var"
192     tar.id_type = 'OBJECT'
193     tar.id = obj
194     tar.rna_path = hinge_driver_path
195     
196     #mod = fcurve_driver.modifiers.new('GENERATOR')
197     mod = fcurve.modifiers[0]
198     mod.poly_order = 1
199     mod.coefficients[0] = 1.0
200     mod.coefficients[1] = -1.0
201     
202     head_driver_path = mt.head_p.path_to_id()
203     
204     # b01/max(0.001,b01+b02+b03+b04+b05)
205     target_names = [("b%.2d" % (i + 1)) for i in range(len(neck_chain))]
206     expression_suffix = "/max(0.001,%s)" % "+".join(target_names)
207     
208     
209     for i in range(len(neck_chain)):
210         neck_p = getattr(mt_chain, "neck_%.2d_p" % (i + 1))
211         neck_p.lock_location = True, True, True
212         neck_p.lock_location = True, True, True
213         neck_p.lock_rotations_4d = True
214         
215         # Add bend prop
216         prop_name = "bend_%.2d" % (i + 1)
217         prop = rna_idprop_ui_prop_get(mt.head_p, prop_name, create=True)
218         mt.head_p[prop_name] = 1.0
219         prop["soft_min"] = 0.0
220         prop["soft_max"] = 1.0
221         
222         # add parent constraint
223         neck_p_parent = neck_p.parent
224         
225         # add constraint
226         con = neck_p_parent.constraints.new('COPY_ROTATION')
227         con.name = "Copy Rotation"
228         con.target = obj
229         con.subtarget = ex.head
230         con.owner_space = 'LOCAL'
231         con.target_space = 'LOCAL'
232         
233         fcurve = con.driver_add("influence", 0)
234         driver = fcurve.driver
235         driver.type = 'SCRIPTED'
236         # b01/max(0.001,b01+b02+b03+b04+b05)
237         driver.expression = target_names[i] + expression_suffix
238         fcurve.modifiers.remove(0) # grr dont need a modifier
239
240         for j in range(len(neck_chain)):
241             tar = driver.targets.new()
242             tar.name = target_names[j]
243             tar.id_type = 'OBJECT'
244             tar.id = obj
245             tar.rna_path = head_driver_path + ('["bend_%.2d"]' % (j + 1))