Disable Constraint and Keep Transform
[blender.git] / release / scripts / startup / bl_operators / constraint.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-80 compliant>
20
21 import bpy
22 from bpy.types import (
23     Operator,
24 )
25 from bpy.props import (
26     IntProperty,
27 )
28
29
30 class CONSTRAINT_OT_add_target(Operator):
31     """Add a target to the constraint"""
32     bl_idname = "constraint.add_target"
33     bl_label = "Add Target"
34     bl_options = {'UNDO', 'INTERNAL'}
35
36     def execute(self, context):
37         context.constraint.targets.new()
38         return {'FINISHED'}
39
40
41 class CONSTRAINT_OT_remove_target(Operator):
42     """Remove the target from the constraint"""
43     bl_idname = "constraint.remove_target"
44     bl_label = "Remove Target"
45     bl_options = {'UNDO', 'INTERNAL'}
46
47     index: IntProperty()
48
49     def execute(self, context):
50         tgts = context.constraint.targets
51         tgts.remove(tgts[self.index])
52         return {'FINISHED'}
53
54
55 class CONSTRAINT_OT_normalize_target_weights(Operator):
56     """Normalize weights of all target bones"""
57     bl_idname = "constraint.normalize_target_weights"
58     bl_label = "Normalize Weights"
59     bl_options = {'UNDO', 'INTERNAL'}
60
61     def execute(self, context):
62         tgts = context.constraint.targets
63         total = sum(t.weight for t in tgts)
64
65         if total > 0:
66             for t in tgts:
67                 t.weight = t.weight / total
68
69         return {'FINISHED'}
70
71
72
73 class CONSTRAINT_OT_disable_keep_transform(Operator):
74     bl_idname = "constraint.disable_keep_transform"
75     bl_label = "Disable and Keep Transform"
76     bl_description = ("Set the influence of this constraint to zero while "
77         "trying to maintain the object's transformation. Other active "
78         "constraints can still influence the final transformation")
79     bl_options = {'UNDO', 'INTERNAL'}
80
81     @classmethod
82     def poll(cls, context):
83         constraint = getattr(context, "constraint", None)
84         return constraint and constraint.influence > 0.0
85
86     def execute(self, context):
87         """Disable constraint while maintaining the visual transform."""
88
89         # This works most of the time, but when there are multiple constraints active
90         # there could still be one that overrides the visual transform.
91         #
92         # Note that executing this operator and then increasing the constraint
93         # influence may move the object; this happens when the constraint is
94         # additive rather than replacing the transform entirely.
95
96         # Get the matrix in world space.
97         is_bone_constraint = context.space_data.context == 'BONE_CONSTRAINT'
98         if is_bone_constraint:
99             armature = context.object
100             bone = context.pose_bone
101             mat = armature.matrix_world @ bone.matrix
102         else:
103             mat = context.object.matrix_world
104
105         context.constraint.influence = 0.0
106
107         # Set the matrix.
108         if is_bone_constraint:
109             bone.matrix = armature.matrix_world.inverted() @ mat
110         else:
111             context.object.matrix_world = mat
112
113         return {'FINISHED'}
114
115
116 classes = (
117     CONSTRAINT_OT_add_target,
118     CONSTRAINT_OT_remove_target,
119     CONSTRAINT_OT_normalize_target_weights,
120     CONSTRAINT_OT_disable_keep_transform,
121 )