67ceeb39954e561f27191d75b8ca9f41aa717f06
[blender-staging.git] / release / scripts / modules / rigify / stretch.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
24
25 METARIG_NAMES = tuple()
26 RIG_TYPE = "stretch"
27
28 # TODO
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('Bone')
35 #    bone.head[:] = 0.0000, 0.0000, 0.0000
36 #    bone.tail[:] = 0.0000, 0.0000, 1.0000
37 #    bone.roll = 0.0000
38 #    bone.use_connect = False
39 #
40 #    bpy.ops.object.mode_set(mode='OBJECT')
41 #    pbone = obj.pose.bones['Bone']
42 #    pbone['type'] = 'copy'
43
44 bool_map = {0: False, 1: True,
45             0.0: False, 1.0: True,
46             "false": False, "true": True,
47             "False": False, "True": True,
48             "no": False, "yes": True,
49             "No": False, "Yes": True}
50
51
52 def metarig_definition(obj, orig_bone_name):
53     return (orig_bone_name,)
54
55
56 def main(obj, bone_definition, base_names, options):
57     """ A stretchy bone from one bone to another.
58         Deformation only (no controls).
59     """
60     # Verify required parameter
61     if "to" not in options:
62         raise RigifyError("'%s' rig type requires a 'to' parameter (bone: %s)" % (RIG_TYPE, base_names[bone_definition[0]]))
63     if type(options["to"]) is not str:
64         raise RigifyError("'%s' rig type 'to' parameter must be a string (bone: %s)" % (RIG_TYPE, base_names[bone_definition[0]]))
65     if ("ORG-" + options["to"]) not in obj.data.bones:
66         raise RigifyError("'%s' rig type 'to' parameter must name a bone in the metarig (bone: %s)" % (RIG_TYPE, base_names[bone_definition[0]]))
67
68     preserve_volume = None
69     # Check optional parameter
70     if "preserve_volume" in options:
71         try:
72             preserve_volume = bool_map[options["preserve_volume"]]
73         except KeyError:
74             preserve_volume = False
75
76     eb = obj.data.edit_bones
77     bb = obj.data.bones
78     pb = obj.pose.bones
79
80     bpy.ops.object.mode_set(mode='EDIT')
81     arm = obj.data
82
83     mbone1 = bone_definition[0]
84     mbone2 = "ORG-" + options["to"]
85
86     bone_e = copy_bone_simple(obj.data, mbone1, "DEF-%s" % base_names[bone_definition[0]])
87     bone_e.use_connect = False
88     bone_e.parent = eb[mbone1]
89     bone_e.tail = eb[mbone2].head
90     bone = bone_e.name
91
92
93     bpy.ops.object.mode_set(mode='OBJECT')
94
95     # Constraints
96     con = pb[bone].constraints.new('DAMPED_TRACK')
97     con.target = obj
98     con.subtarget = mbone2
99
100     con = pb[bone].constraints.new('STRETCH_TO')
101     con.target = obj
102     con.subtarget = mbone2
103     con.original_length = bb[bone].length
104     if preserve_volume:
105         con.volume = 'VOLUME_XZX'
106     else:
107         con.volume = 'NO_VOLUME'
108
109     return tuple()