00ad45cf9bbbabfd1b766b04d186d4a4e4a64f01
[blender.git] / release / scripts / modules / keyingsets_utils.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 # This file defines a set of methods that are useful for various
22 # Relative Keying Set (RKS) related operations, such as: callbacks
23 # for polling, iterator callbacks, and also generate callbacks.
24 # All of these can be used in conjunction with the others.
25
26 __all__ = [
27     "path_add_property",
28     "RKS_POLL_selected_objects",
29     "RKS_POLL_selected_bones",
30     "RKS_POLL_selected_items",
31     "RKS_ITER_selected_item",
32     "RKS_GEN_available",
33     "RKS_GEN_location",
34     "RKS_GEN_rotation",
35     "RKS_GEN_scaling",
36 ]
37
38 import bpy
39
40 ###########################
41 # General Utilities
42
43
44 # Append the specified property name on the the existing path
45 def path_add_property(path, prop):
46     if len(path):
47         return path + "." + prop
48     else:
49         return prop
50
51 ###########################
52 # Poll Callbacks
53
54
55 # selected objects
56 def RKS_POLL_selected_objects(ksi, context):
57     return context.active_object or len(context.selected_objects)
58
59
60 # selected bones
61 def RKS_POLL_selected_bones(ksi, context):
62     # we must be in Pose Mode, and there must be some bones selected
63     if (context.active_object) and (context.active_object.mode == 'POSE'):
64         if context.active_pose_bone or len(context.selected_pose_bones):
65             return True
66
67     # nothing selected
68     return False
69
70
71 # selected bones or objects
72 def RKS_POLL_selected_items(ksi, context):
73     return RKS_POLL_selected_bones(ksi, context) or RKS_POLL_selected_objects(ksi, context)
74
75 ###########################
76 # Iterator Callbacks
77
78
79 # all selected objects or pose bones, depending on which we've got
80 def RKS_ITER_selected_item(ksi, context, ks):
81     if (context.active_object) and (context.active_object.mode == 'POSE'):
82         for bone in context.selected_pose_bones:
83             ksi.generate(context, ks, bone)
84     else:
85         for ob in context.selected_objects:
86             ksi.generate(context, ks, ob)
87
88 ###########################
89 # Generate Callbacks
90
91
92 # 'Available' F-Curves
93 def RKS_GEN_available(ksi, context, ks, data):
94     # try to get the animation data associated with the closest
95     # ID-block to the data (neither of which may exist/be easy to find)
96     id_block = data.id_data
97     adt = getattr(id_block, "animation_data", None)
98
99     # there must also be an active action...
100     if adt is None or adt.action is None:
101         return
102
103     # if we haven't got an ID-block as 'data', try to restrict
104     # paths added to only those which branch off from here
105     # i.e. for bones
106     if id_block != data:
107         basePath = data.path_from_id()
108     else:
109         basePath = None  # this is not needed...
110
111     # for each F-Curve, include a path to key it
112     # NOTE: we don't need to set the group settings here
113     for fcu in adt.action.fcurves:
114         if basePath:
115             if basePath in fcu.data_path:
116                 ks.paths.add(id_block, fcu.data_path, index=fcu.array_index)
117         else:
118             ks.paths.add(id_block, fcu.data_path, index=fcu.array_index)
119
120 # ------
121
122
123 # get ID block and based ID path for transform generators
124 # private function
125 def get_transform_generators_base_info(data):
126     # ID-block for the data
127     id_block = data.id_data
128
129     # get base path and grouping method/name
130     if isinstance(data, bpy.types.ID):
131         # no path in this case
132         path = ""
133
134         # data on ID-blocks directly should get grouped by the KeyingSet
135         grouping = None
136     else:
137         # get the path to the ID-block
138         path = data.path_from_id()
139
140         # try to use the name of the data element to group the F-Curve
141         # else fallback on the KeyingSet name
142         grouping = getattr(data, "name", None)
143
144     # return the ID-block and the path
145     return id_block, path, grouping
146
147
148 # Location
149 def RKS_GEN_location(ksi, context, ks, data):
150     # get id-block and path info
151     id_block, base_path, grouping = get_transform_generators_base_info(data)
152
153     # add the property name to the base path
154     path = path_add_property(base_path, "location")
155
156     # add Keying Set entry for this...
157     if grouping:
158         ks.paths.add(id_block, path, group_method='NAMED', group_name=grouping)
159     else:
160         ks.paths.add(id_block, path)
161
162
163 # Rotation
164 def RKS_GEN_rotation(ksi, context, ks, data):
165     # get id-block and path info
166     id_block, base_path, grouping = get_transform_generators_base_info(data)
167
168     # add the property name to the base path
169     #   rotation mode affects the property used
170     if data.rotation_mode == 'QUATERNION':
171         path = path_add_property(base_path, "rotation_quaternion")
172     elif data.rotation_mode == 'AXIS_ANGLE':
173         path = path_add_property(base_path, "rotation_axis_angle")
174     else:
175         path = path_add_property(base_path, "rotation_euler")
176
177     # add Keying Set entry for this...
178     if grouping:
179         ks.paths.add(id_block, path, group_method='NAMED', group_name=grouping)
180     else:
181         ks.paths.add(id_block, path)
182
183
184 # Scaling
185 def RKS_GEN_scaling(ksi, context, ks, data):
186     # get id-block and path info
187     id_block, base_path, grouping = get_transform_generators_base_info(data)
188
189     # add the property name to the base path
190     path = path_add_property(base_path, "scale")
191
192     # add Keying Set entry for this...
193     if grouping:
194         ks.paths.add(id_block, path, group_method='NAMED', group_name=grouping)
195     else:
196         ks.paths.add(id_block, path)