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