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