Cleanup: comment line length (editors)
[blender.git] / source / blender / blenkernel / BKE_animsys.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * Contributor(s): Joshua Leung (original author)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_ANIMSYS_H__
27 #define __BKE_ANIMSYS_H__
28
29 /** \file BKE_animsys.h
30  *  \ingroup bke
31  *  \author Joshua Leung
32  */
33
34 struct ID;
35 struct ListBase;
36 struct Main;
37 struct AnimData;
38 struct FCurve;
39 struct KeyingSet;
40 struct KS_Path;
41 struct PathResolvedRNA;
42 struct bContext;
43
44 struct PointerRNA;
45 struct PropertyRNA;
46 struct ReportList;
47 struct bAction;
48 struct bActionGroup;
49 struct AnimMapper;
50
51 /* ************************************* */
52 /* AnimData API */
53
54 /* Check if the given ID-block can have AnimData */
55 bool id_type_can_have_animdata(const short id_type);
56 bool id_can_have_animdata(const struct ID *id);
57
58 /* Get AnimData from the given ID-block */
59 struct AnimData *BKE_animdata_from_id(struct ID *id);
60
61 /* Add AnimData to the given ID-block */
62 struct AnimData *BKE_animdata_add_id(struct ID *id);
63
64 /* Set active action used by AnimData from the given ID-block */
65 bool BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
66
67 /* Free AnimData */
68 void BKE_animdata_free(struct ID *id, const bool do_id_user);
69
70 /* Copy AnimData */
71 struct AnimData *BKE_animdata_copy(struct Main *bmain, struct AnimData *adt, const bool do_action);
72
73 /* Copy AnimData */
74 bool BKE_animdata_copy_id(struct Main *bmain, struct ID *id_to, struct ID *id_from, const bool do_action);
75
76 /* Copy AnimData Actions */
77 void BKE_animdata_copy_id_action(struct Main *bmain, struct ID *id, const bool set_newid);
78
79 /* Merge copies of data from source AnimData block */
80 typedef enum eAnimData_MergeCopy_Modes {
81         /* Keep destination action */
82         ADT_MERGECOPY_KEEP_DST = 0,
83
84         /* Use src action (make a new copy) */
85         ADT_MERGECOPY_SRC_COPY = 1,
86
87         /* Use src action (but just reference the existing version) */
88         ADT_MERGECOPY_SRC_REF  = 2
89 } eAnimData_MergeCopy_Modes;
90
91 void BKE_animdata_merge_copy(
92         struct Main *bmain, struct ID *dst_id, struct ID *src_id,
93         eAnimData_MergeCopy_Modes action_mode, 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(struct ListBase *list, const char idname[], const char name[], short flag, short keyingflag);
100
101 /* Add a path to a KeyingSet */
102 struct KS_Path *BKE_keyingset_add_path(struct KeyingSet *ks, struct ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode);
103
104 /* Find the destination matching the criteria given */
105 struct KS_Path *BKE_keyingset_find_path(struct KeyingSet *ks, struct ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode);
106
107 /* Copy all KeyingSets in the given list */
108 void BKE_keyingsets_copy(struct ListBase *newlist, const struct ListBase *list);
109
110 /* Free the given Keying Set path */
111 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
112
113 /* Free data for KeyingSet but not set itself */
114 void BKE_keyingset_free(struct KeyingSet *ks);
115
116 /* Free all the KeyingSets in the given list */
117 void BKE_keyingsets_free(struct ListBase *list);
118
119 /* ************************************* */
120 /* Path Fixing API */
121
122 /* Get a "fixed" version of the given path (oldPath) */
123 char *BKE_animsys_fix_rna_path_rename(ID *owner_id, char *old_path, const char *prefix, const char *oldName,
124                                       const char *newName, int oldSubscript, int newSubscript, bool verify_paths);
125
126 /* Fix all the paths for the given ID + Action */
127 void BKE_action_fix_paths_rename(struct ID *owner_id, struct bAction *act, const char *prefix, const char *oldName,
128                                  const char *newName, int oldSubscript, int newSubscript, bool verify_paths);
129
130 /* Fix all the paths for the given ID+AnimData */
131 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, struct ID *ref_id, const char *prefix,
132                                    const char *oldName, const char *newName, int oldSubscript, int newSubscript,
133                                    bool verify_paths);
134
135 /* Fix all the paths for the entire database... */
136 void BKE_animdata_fix_paths_rename_all(ID *ref_id, const char *prefix, const char *oldName, const char *newName);
137
138 /* Fix the path after removing elements that are not ID (e.g., node) */
139 void BKE_animdata_fix_paths_remove(struct ID *id, const char *path);
140
141 /* -------------------------------------- */
142
143 /* Move animation data from src to destination if it's paths are based on basepaths */
144 void BKE_animdata_separate_by_basepath(
145         struct Main *bmain, struct ID *srcID, struct ID *dstID, struct ListBase *basepaths);
146
147 /* Move F-Curves from src to destination if it's path is based on basepath */
148 void action_move_fcurves_by_basepath(struct bAction *srcAct, struct bAction *dstAct, const char basepath[]);
149
150 char *BKE_animdata_driver_path_hack(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop,
151                                     char *base_path);
152
153 /* ************************************* */
154 /* Batch AnimData API */
155
156 /* Define for callback looper used in BKE_animdata_main_cb */
157 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
158
159 /* Define for callback looper used in BKE_fcurves_main_cb */
160 typedef void (*ID_FCurve_Edit_Callback)(struct ID *id, struct FCurve *fcu, void *user_data);
161
162
163 /* Loop over all datablocks applying callback */
164 void BKE_animdata_main_cb(struct Main *bmain, ID_AnimData_Edit_Callback func, void *user_data);
165
166 /* Loop over all datablocks applying callback to all its F-Curves */
167 void BKE_fcurves_main_cb(struct Main *bmain, ID_FCurve_Edit_Callback func, void *user_data);
168
169 /* ************************************* */
170 // TODO: overrides, remapping, and path-finding api's
171
172 /* ************************************* */
173 /* Evaluation API */
174
175 /* ------------- Main API -------------------- */
176 /* In general, these ones should be called to do all animation evaluation */
177
178 /* Evaluation loop for evaluating animation data  */
179 void BKE_animsys_evaluate_animdata(struct Scene *scene, struct ID *id, struct AnimData *adt, float ctime, short recalc);
180
181 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
182 void BKE_animsys_evaluate_all_animation(struct Main *main, struct Scene *scene, float ctime);
183
184 /* TODO(sergey): This is mainly a temp public function. */
185 struct FCurve;
186 bool BKE_animsys_execute_fcurve(struct PointerRNA *ptr, struct AnimMapper *remap, struct FCurve *fcu, float curval);
187
188 /* ------------ Specialized API --------------- */
189 /* There are a few special tools which require these following functions. They are NOT to be used
190  * for standard animation evaluation UNDER ANY CIRCUMSTANCES!
191  *
192  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but
193  *      Particles/Sequencer performing funky time manipulation is not ok.
194  */
195
196 /* Evaluate Action (F-Curve Bag) */
197 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
198
199 /* Evaluate Action Group */
200 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
201
202 /* ************************************* */
203
204 /* ------------ Evaluation API --------------- */
205
206 struct EvaluationContext;
207
208 void BKE_animsys_eval_animdata(struct EvaluationContext *eval_ctx, struct ID *id);
209 void BKE_animsys_eval_driver(struct EvaluationContext *eval_ctx, struct ID *id, struct FCurve *fcurve);
210
211 /* ************************************* */
212
213 #endif /* __BKE_ANIMSYS_H__*/