0503efb16619b3607b8998d81ba2c07042f0aa3d
[blender.git] / source / blender / blenkernel / BKE_animsys.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_ANIMSYS_H__
21 #define __BKE_ANIMSYS_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 struct AnimData;
28 struct ChannelDriver;
29 struct Depsgraph;
30 struct FCurve;
31 struct ID;
32 struct KS_Path;
33 struct KeyingSet;
34 struct ListBase;
35 struct Main;
36 struct NlaKeyframingContext;
37 struct PathResolvedRNA;
38 struct PointerRNA;
39 struct PropertyRNA;
40 struct ReportList;
41 struct Scene;
42 struct bAction;
43 struct bActionGroup;
44 struct bContext;
45
46 /* ************************************* */
47 /* AnimData API */
48
49 /* Check if the given ID-block can have AnimData */
50 bool id_type_can_have_animdata(const short id_type);
51 bool id_can_have_animdata(const struct ID *id);
52
53 /* Get AnimData from the given ID-block */
54 struct AnimData *BKE_animdata_from_id(struct ID *id);
55
56 /* Add AnimData to the given ID-block */
57 struct AnimData *BKE_animdata_add_id(struct ID *id);
58
59 /* Set active action used by AnimData from the given ID-block */
60 bool BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
61
62 /* Free AnimData */
63 void BKE_animdata_free(struct ID *id, const bool do_id_user);
64
65 /* Copy AnimData */
66 struct AnimData *BKE_animdata_copy(struct Main *bmain, struct AnimData *adt, const int flag);
67
68 /* Copy AnimData */
69 bool BKE_animdata_copy_id(struct Main *bmain,
70                           struct ID *id_to,
71                           struct ID *id_from,
72                           const int flag);
73
74 /* Copy AnimData Actions */
75 void BKE_animdata_copy_id_action(struct Main *bmain, struct ID *id, const bool set_newid);
76
77 /* Merge copies of data from source AnimData block */
78 typedef enum eAnimData_MergeCopy_Modes {
79   /* Keep destination action */
80   ADT_MERGECOPY_KEEP_DST = 0,
81
82   /* Use src action (make a new copy) */
83   ADT_MERGECOPY_SRC_COPY = 1,
84
85   /* Use src action (but just reference the existing version) */
86   ADT_MERGECOPY_SRC_REF = 2,
87 } eAnimData_MergeCopy_Modes;
88
89 void BKE_animdata_merge_copy(struct Main *bmain,
90                              struct ID *dst_id,
91                              struct ID *src_id,
92                              eAnimData_MergeCopy_Modes action_mode,
93                              bool fix_drivers);
94
95 /* ************************************* */
96 /* KeyingSets API */
97
98 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
99 struct KeyingSet *BKE_keyingset_add(
100     struct ListBase *list, const char idname[], const char name[], short flag, short keyingflag);
101
102 /* Add a path to a KeyingSet */
103 struct KS_Path *BKE_keyingset_add_path(struct KeyingSet *ks,
104                                        struct ID *id,
105                                        const char group_name[],
106                                        const char rna_path[],
107                                        int array_index,
108                                        short flag,
109                                        short groupmode);
110
111 /* Find the destination matching the criteria given */
112 struct KS_Path *BKE_keyingset_find_path(struct KeyingSet *ks,
113                                         struct ID *id,
114                                         const char group_name[],
115                                         const char rna_path[],
116                                         int array_index,
117                                         int group_mode);
118
119 /* Copy all KeyingSets in the given list */
120 void BKE_keyingsets_copy(struct ListBase *newlist, const struct ListBase *list);
121
122 /* Free the given Keying Set path */
123 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
124
125 /* Free data for KeyingSet but not set itself */
126 void BKE_keyingset_free(struct KeyingSet *ks);
127
128 /* Free all the KeyingSets in the given list */
129 void BKE_keyingsets_free(struct ListBase *list);
130
131 /* ************************************* */
132 /* Path Fixing API */
133
134 /* Get a "fixed" version of the given path (oldPath) */
135 char *BKE_animsys_fix_rna_path_rename(struct ID *owner_id,
136                                       char *old_path,
137                                       const char *prefix,
138                                       const char *oldName,
139                                       const char *newName,
140                                       int oldSubscript,
141                                       int newSubscript,
142                                       bool verify_paths);
143
144 /* Fix all the paths for the given ID + Action */
145 void BKE_action_fix_paths_rename(struct ID *owner_id,
146                                  struct bAction *act,
147                                  const char *prefix,
148                                  const char *oldName,
149                                  const char *newName,
150                                  int oldSubscript,
151                                  int newSubscript,
152                                  bool verify_paths);
153
154 /* Fix all the paths for the given ID+AnimData */
155 void BKE_animdata_fix_paths_rename(struct ID *owner_id,
156                                    struct AnimData *adt,
157                                    struct ID *ref_id,
158                                    const char *prefix,
159                                    const char *oldName,
160                                    const char *newName,
161                                    int oldSubscript,
162                                    int newSubscript,
163                                    bool verify_paths);
164
165 /* Fix all the paths for the entire database... */
166 void BKE_animdata_fix_paths_rename_all(struct ID *ref_id,
167                                        const char *prefix,
168                                        const char *oldName,
169                                        const char *newName);
170
171 /* Fix the path after removing elements that are not ID (e.g., node).
172  * Returen truth if any animation data was affected. */
173 bool BKE_animdata_fix_paths_remove(struct ID *id, const char *path);
174
175 /* -------------------------------------- */
176
177 /* Move animation data from src to destination if it's paths are based on basepaths */
178 void BKE_animdata_separate_by_basepath(struct Main *bmain,
179                                        struct ID *srcID,
180                                        struct ID *dstID,
181                                        struct ListBase *basepaths);
182
183 /* Move F-Curves from src to destination if it's path is based on basepath */
184 void action_move_fcurves_by_basepath(struct bAction *srcAct,
185                                      struct bAction *dstAct,
186                                      const char basepath[]);
187
188 char *BKE_animdata_driver_path_hack(struct bContext *C,
189                                     struct PointerRNA *ptr,
190                                     struct PropertyRNA *prop,
191                                     char *base_path);
192
193 /* ************************************* */
194 /* Batch AnimData API */
195
196 /* Define for callback looper used in BKE_animdata_main_cb */
197 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
198
199 /* Define for callback looper used in BKE_fcurves_main_cb */
200 typedef void (*ID_FCurve_Edit_Callback)(struct ID *id, struct FCurve *fcu, void *user_data);
201
202 /* Loop over all datablocks applying callback */
203 void BKE_animdata_main_cb(struct Main *bmain, ID_AnimData_Edit_Callback func, void *user_data);
204
205 /* Loop over all datablocks applying callback to all its F-Curves */
206 void BKE_fcurves_main_cb(struct Main *bmain, ID_FCurve_Edit_Callback func, void *user_data);
207
208 /* Look over all f-curves of a given ID. */
209 void BKE_fcurves_id_cb(struct ID *id, ID_FCurve_Edit_Callback func, void *user_data);
210
211 /* ************************************* */
212 // TODO: overrides, remapping, and path-finding api's
213
214 /* ------------ NLA Keyframing --------------- */
215
216 typedef struct NlaKeyframingContext NlaKeyframingContext;
217
218 struct NlaKeyframingContext *BKE_animsys_get_nla_keyframing_context(struct ListBase *cache,
219                                                                     struct Depsgraph *depsgraph,
220                                                                     struct PointerRNA *ptr,
221                                                                     struct AnimData *adt,
222                                                                     float ctime);
223 bool BKE_animsys_nla_remap_keyframe_values(struct NlaKeyframingContext *context,
224                                            struct PointerRNA *prop_ptr,
225                                            struct PropertyRNA *prop,
226                                            float *values,
227                                            int count,
228                                            int index,
229                                            bool *r_force_all);
230 void BKE_animsys_free_nla_keyframing_context_cache(struct ListBase *cache);
231
232 /* ************************************* */
233 /* Evaluation API */
234
235 /* ------------- Main API -------------------- */
236 /* In general, these ones should be called to do all animation evaluation */
237
238 /* Flags for recalc parameter, indicating which part to recalculate. */
239 typedef enum eAnimData_Recalc {
240   ADT_RECALC_DRIVERS = (1 << 0),
241   ADT_RECALC_ANIM = (1 << 1),
242   ADT_RECALC_ALL = (ADT_RECALC_DRIVERS | ADT_RECALC_ANIM),
243 } eAnimData_Recalc;
244
245 /* Evaluation loop for evaluating animation data  */
246 void BKE_animsys_evaluate_animdata(struct Depsgraph *depsgraph,
247                                    struct Scene *scene,
248                                    struct ID *id,
249                                    struct AnimData *adt,
250                                    float ctime,
251                                    short recalc);
252
253 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
254 void BKE_animsys_evaluate_all_animation(struct Main *main,
255                                         struct Depsgraph *depsgraph,
256                                         struct Scene *scene,
257                                         float ctime);
258
259 /* TODO(sergey): This is mainly a temp public function. */
260 bool BKE_animsys_execute_fcurve(struct PointerRNA *ptr, struct FCurve *fcu, float curval);
261
262 /* ------------ Specialized API --------------- */
263 /* There are a few special tools which require these following functions. They are NOT to be used
264  * for standard animation evaluation UNDER ANY CIRCUMSTANCES!
265  *
266  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but
267  *      Particles/Sequencer performing funky time manipulation is not ok.
268  */
269
270 /* Evaluate Action (F-Curve Bag) */
271 void animsys_evaluate_action(struct Depsgraph *depsgraph,
272                              struct PointerRNA *ptr,
273                              struct bAction *act,
274                              float ctime);
275
276 /* Evaluate Action Group */
277 void animsys_evaluate_action_group(struct PointerRNA *ptr,
278                                    struct bAction *act,
279                                    struct bActionGroup *agrp,
280                                    float ctime);
281
282 /* ************************************* */
283
284 /* ------------ Evaluation API --------------- */
285
286 struct Depsgraph;
287
288 void BKE_animsys_eval_animdata(struct Depsgraph *depsgraph, struct ID *id);
289 void BKE_animsys_eval_driver(struct Depsgraph *depsgraph,
290                              struct ID *id,
291                              int driver_index,
292                              struct ChannelDriver *driver_orig);
293
294 void BKE_animsys_update_driver_array(struct ID *id);
295
296 /* ************************************* */
297
298 #endif /* __BKE_ANIMSYS_H__*/