ac64d4369cd1bfadd3ecd2b348708a9eb1ec07c9
[blender.git] / release / scripts / modules / rigify / stretch_twist.py
1 <<<<<<< .working
2 # ##### BEGIN GPL LICENSE BLOCK #####
3 #
4 #  This program is free software; you can redistribute it and/or
5 #  modify it under the terms of the GNU General Public License
6 #  as published by the Free Software Foundation; either version 2
7 #  of the License, or (at your option) any later version.
8 #
9 #  This program is distributed in the hope that it will be useful,
10 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 #  GNU General Public License for more details.
13 #
14 #  You should have received a copy of the GNU General Public License
15 #  along with this program; if not, write to the Free Software Foundation,
16 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 #
18 # ##### END GPL LICENSE BLOCK #####
19
20 # <pep8 compliant>
21
22 import bpy
23 from rigify import RigifyError
24 from rigify_utils import copy_bone_simple
25
26 METARIG_NAMES = tuple()
27 RIG_TYPE = "stretch_twist"
28
29 # TODO
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('Bone')
36 #    bone.head[:] = 0.0000, 0.0000, 0.0000
37 #    bone.tail[:] = 0.0000, 0.0000, 1.0000
38 #    bone.roll = 0.0000
39 #    bone.connected = False
40 #
41 #    bpy.ops.object.mode_set(mode='OBJECT')
42 #    pbone = obj.pose.bones['Bone']
43 #    pbone['type'] = 'copy'
44
45 bool_map = {0:False, 1:True,
46             0.0:False, 1.0:True,
47             "false":False, "true":True,
48             "False":False, "True":True,
49             "no":False, "yes":True,
50             "No":False, "Yes":True}
51
52 def metarig_definition(obj, orig_bone_name):
53     return (orig_bone_name,)
54
55
56
57
58 def main(obj, bone_definition, base_names, options):
59     """ A dual-bone stretchy bone setup.  Each half follows the twist of the
60         bone on its side.
61         Deformation only (no controls).
62     """
63     # Verify required parameter
64     if "to" not in options:
65         raise RigifyError("'%s' rig type requires a 'to' parameter (bone: %s)" % (RIG_TYPE, base_names[0]))
66     if type(options["to"]) is not str:
67         raise RigifyError("'%s' rig type 'to' parameter must be a string (bone: %s)" % (RIG_TYPE, base_names[0]))
68     if ("ORG-" + options["to"]) not in obj.data.bones:
69         raise RigifyError("'%s' rig type 'to' parameter must name a bone in the metarig (bone: %s)" % (RIG_TYPE, base_names[0]))
70
71     preserve_volume = None
72     # Check optional parameter
73     if "preserve_volume" in options:
74         try:
75             preserve_volume = bool_map[options["preserve_volume"]]
76         except KeyError:
77             preserve_volume = False
78
79     eb = obj.data.edit_bones
80     bb = obj.data.bones
81     pb = obj.pose.bones
82
83     bpy.ops.object.mode_set(mode='EDIT')
84     arm = obj.data
85
86     mbone1 = bone_definition[0]
87     mbone2 = "ORG-" + options["to"]
88
89     bone_e = copy_bone_simple(obj.data, mbone1, "MCH-%s" % base_names[bone_definition[0]])
90     bone_e.connected = False
91     bone_e.parent = None
92     bone_e.head = (eb[mbone1].head + eb[mbone2].head) / 2
93     bone_e.tail = (bone_e.head[0], bone_e.head[1], bone_e.head[2]+0.1)
94     mid_bone = bone_e.name
95
96     bone_e = copy_bone_simple(obj.data, mbone1, "DEF-%s.01" % base_names[bone_definition[0]])
97     bone_e.connected = False
98     bone_e.parent = eb[mbone1]
99     bone_e.tail = eb[mid_bone].head
100     bone1 = bone_e.name
101
102     bone_e = copy_bone_simple(obj.data, mbone2, "DEF-%s.02" % base_names[bone_definition[0]])
103     bone_e.connected = False
104     bone_e.parent = eb[mbone2]
105     bone_e.tail = eb[mid_bone].head
106     bone2 = bone_e.name
107
108
109
110     bpy.ops.object.mode_set(mode='OBJECT')
111
112     # Constraints
113
114     # Mid bone
115     con = pb[mid_bone].constraints.new('COPY_LOCATION')
116     con.target = obj
117     con.subtarget = mbone1
118
119     con = pb[mid_bone].constraints.new('COPY_LOCATION')
120     con.target = obj
121     con.subtarget = mbone2
122     con.influence = 0.5
123
124     # Bone 1
125     con = pb[bone1].constraints.new('DAMPED_TRACK')
126     con.target = obj
127     con.subtarget = mid_bone
128
129     con = pb[bone1].constraints.new('STRETCH_TO')
130     con.target = obj
131     con.subtarget = mid_bone
132     con.original_length = bb[bone1].length
133     if preserve_volume:
134         con.volume = 'VOLUME_XZX'
135     else:
136         con.volume = 'NO_VOLUME'
137
138     # Bone 2
139     con = pb[bone2].constraints.new('DAMPED_TRACK')
140     con.target = obj
141     con.subtarget = mid_bone
142
143     con = pb[bone2].constraints.new('STRETCH_TO')
144     con.target = obj
145     con.subtarget = mid_bone
146     con.original_length = bb[bone2].length
147     if preserve_volume:
148         con.volume = 'VOLUME_XZX'
149     else:
150         con.volume = 'NO_VOLUME'
151
152     return tuple()
153
154 =======
155 # ##### BEGIN GPL LICENSE BLOCK #####
156 #
157 #  This program is free software; you can redistribute it and/or
158 #  modify it under the terms of the GNU General Public License
159 #  as published by the Free Software Foundation; either version 2
160 #  of the License, or (at your option) any later version.
161 #
162 #  This program is distributed in the hope that it will be useful,
163 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
164 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
165 #  GNU General Public License for more details.
166 #
167 #  You should have received a copy of the GNU General Public License
168 #  along with this program; if not, write to the Free Software Foundation,
169 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
170 #
171 # ##### END GPL LICENSE BLOCK #####
172
173 # <pep8 compliant>
174
175 import bpy
176 from rigify import RigifyError
177 from rigify_utils import copy_bone_simple
178
179 METARIG_NAMES = tuple()
180 RIG_TYPE = "stretch_twist"
181
182 # TODO
183 #def metarig_template():
184 #    # generated by rigify.write_meta_rig
185 #    bpy.ops.object.mode_set(mode='EDIT')
186 #    obj = bpy.context.active_object
187 #    arm = obj.data
188 #    bone = arm.edit_bones.new('Bone')
189 #    bone.head[:] = 0.0000, 0.0000, 0.0000
190 #    bone.tail[:] = 0.0000, 0.0000, 1.0000
191 #    bone.roll = 0.0000
192 #    bone.use_connect = False
193 #
194 #    bpy.ops.object.mode_set(mode='OBJECT')
195 #    pbone = obj.pose.bones['Bone']
196 #    pbone['type'] = 'copy'
197
198 bool_map = {0:False, 1:True,
199             0.0:False, 1.0:True,
200             "false":False, "true":True,
201             "False":False, "True":True,
202             "no":False, "yes":True,
203             "No":False, "Yes":True}
204
205 def metarig_definition(obj, orig_bone_name):
206     return (orig_bone_name,)
207
208
209
210
211 def main(obj, bone_definition, base_names, options):
212     """ A dual-bone stretchy bone setup.  Each half follows the twist of the
213         bone on its side.
214         Deformation only (no controls).
215     """
216     # Verify required parameter
217     if "to" not in options:
218         raise RigifyError("'%s' rig type requires a 'to' parameter (bone: %s)" % (RIG_TYPE, base_names[0]))
219     if type(options["to"]) is not str:
220         raise RigifyError("'%s' rig type 'to' parameter must be a string (bone: %s)" % (RIG_TYPE, base_names[0]))
221     if ("ORG-" + options["to"]) not in obj.data.bones:
222         raise RigifyError("'%s' rig type 'to' parameter must name a bone in the metarig (bone: %s)" % (RIG_TYPE, base_names[0]))
223
224     preserve_volume = None
225     # Check optional parameter
226     if "preserve_volume" in options:
227         try:
228             preserve_volume = bool_map[options["preserve_volume"]]
229         except KeyError:
230             preserve_volume = False
231
232     eb = obj.data.edit_bones
233     bb = obj.data.bones
234     pb = obj.pose.bones
235
236     bpy.ops.object.mode_set(mode='EDIT')
237     arm = obj.data
238
239     mbone1 = bone_definition[0]
240     mbone2 = "ORG-" + options["to"]
241
242     bone_e = copy_bone_simple(obj.data, mbone1, "MCH-%s" % base_names[bone_definition[0]])
243     bone_e.use_connect = False
244     bone_e.parent = None
245     bone_e.head = (eb[mbone1].head + eb[mbone2].head) / 2
246     bone_e.tail = (bone_e.head[0], bone_e.head[1], bone_e.head[2]+0.1)
247     mid_bone = bone_e.name
248
249     bone_e = copy_bone_simple(obj.data, mbone1, "DEF-%s.01" % base_names[bone_definition[0]])
250     bone_e.use_connect = False
251     bone_e.parent = eb[mbone1]
252     bone_e.tail = eb[mid_bone].head
253     bone1 = bone_e.name
254
255     bone_e = copy_bone_simple(obj.data, mbone2, "DEF-%s.02" % base_names[bone_definition[0]])
256     bone_e.use_connect = False
257     bone_e.parent = eb[mbone2]
258     bone_e.tail = eb[mid_bone].head
259     bone2 = bone_e.name
260
261
262
263     bpy.ops.object.mode_set(mode='OBJECT')
264
265     # Constraints
266
267     # Mid bone
268     con = pb[mid_bone].constraints.new('COPY_LOCATION')
269     con.target = obj
270     con.subtarget = mbone1
271
272     con = pb[mid_bone].constraints.new('COPY_LOCATION')
273     con.target = obj
274     con.subtarget = mbone2
275     con.influence = 0.5
276
277     # Bone 1
278     con = pb[bone1].constraints.new('DAMPED_TRACK')
279     con.target = obj
280     con.subtarget = mid_bone
281
282     con = pb[bone1].constraints.new('STRETCH_TO')
283     con.target = obj
284     con.subtarget = mid_bone
285     con.rest_length = bb[bone1].length
286     if preserve_volume:
287         con.volume = 'VOLUME_XZX'
288     else:
289         con.volume = 'NO_VOLUME'
290
291     # Bone 2
292     con = pb[bone2].constraints.new('DAMPED_TRACK')
293     con.target = obj
294     con.subtarget = mid_bone
295
296     con = pb[bone2].constraints.new('STRETCH_TO')
297     con.target = obj
298     con.subtarget = mid_bone
299     con.rest_length = bb[bone2].length
300     if preserve_volume:
301         con.volume = 'VOLUME_XZX'
302     else:
303         con.volume = 'NO_VOLUME'
304
305     return tuple()
306
307 >>>>>>> .merge-right.r31523