Merge branch 'master' into blender2.8
[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 KeyingSet;
39 struct KS_Path;
40 struct PathResolvedRNA;
41 struct bContext;
42
43 struct PointerRNA;
44 struct PropertyRNA;
45 struct ReportList;
46 struct bAction;
47 struct bActionGroup;
48 struct AnimMapper;
49
50 /* ************************************* */
51 /* AnimData API */
52
53 /* Check if the given ID-block can have AnimData */
54 bool id_type_can_have_animdata(const short id_type);
55 bool id_can_have_animdata(const struct ID *id);
56
57 /* Get AnimData from the given ID-block */
58 struct AnimData *BKE_animdata_from_id(struct ID *id);
59
60 /* Add AnimData to the given ID-block */
61 struct AnimData *BKE_animdata_add_id(struct ID *id);
62
63 /* Set active action used by AnimData from the given ID-block */
64 bool BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
65
66 /* Free AnimData */
67 void BKE_animdata_free(struct ID *id, const bool do_id_user);
68
69 /* Copy AnimData */
70 struct AnimData *BKE_animdata_copy(struct Main *bmain, struct AnimData *adt, const bool do_action);
71
72 /* Copy AnimData */
73 bool BKE_animdata_copy_id(struct Main *bmain, struct ID *id_to, struct ID *id_from, const bool do_action);
74
75 /* Copy AnimData Actions */
76 void BKE_animdata_copy_id_action(struct ID *id, const bool set_newid);
77
78 /* Merge copies of data from source AnimData block */
79 typedef enum eAnimData_MergeCopy_Modes {
80         /* Keep destination action */
81         ADT_MERGECOPY_KEEP_DST = 0,
82         
83         /* Use src action (make a new copy) */
84         ADT_MERGECOPY_SRC_COPY = 1,
85         
86         /* Use src action (but just reference the existing version) */
87         ADT_MERGECOPY_SRC_REF  = 2
88 } eAnimData_MergeCopy_Modes;
89
90 void BKE_animdata_merge_copy(struct ID *dst_id, struct ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers);
91
92 /* ************************************* */
93 /* KeyingSets API */
94
95 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
96 struct KeyingSet *BKE_keyingset_add(struct ListBase *list, const char idname[], const char name[], short flag, short keyingflag);
97
98 /* Add a path to a KeyingSet */
99 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);
100
101 /* Find the destination matching the criteria given */
102 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);
103
104 /* Copy all KeyingSets in the given list */
105 void BKE_keyingsets_copy(struct ListBase *newlist, const struct ListBase *list);
106
107 /* Free the given Keying Set path */
108 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
109
110 /* Free data for KeyingSet but not set itself */
111 void BKE_keyingset_free(struct KeyingSet *ks);
112
113 /* Free all the KeyingSets in the given list */
114 void BKE_keyingsets_free(struct ListBase *list);
115
116 /* ************************************* */
117 /* Path Fixing API */
118
119 /* Get a "fixed" version of the given path (oldPath) */
120 char *BKE_animsys_fix_rna_path_rename(ID *owner_id, char *old_path, const char *prefix, const char *oldName,
121                                       const char *newName, int oldSubscript, int newSubscript, bool verify_paths);
122
123 /* Fix all the paths for the given ID + Action */
124 void BKE_action_fix_paths_rename(struct ID *owner_id, struct bAction *act, const char *prefix, const char *oldName,
125                                  const char *newName, int oldSubscript, int newSubscript, bool verify_paths);
126
127 /* Fix all the paths for the given ID+AnimData */
128 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, struct ID *ref_id, const char *prefix,
129                                    const char *oldName, const char *newName, int oldSubscript, int newSubscript,
130                                    bool verify_paths);
131
132 /* Fix all the paths for the entire database... */
133 void BKE_animdata_fix_paths_rename_all(ID *ref_id, const char *prefix, const char *oldName, const char *newName);
134
135 /* Fix the path after removing elements that are not ID (e.g., node) */
136 void BKE_animdata_fix_paths_remove(struct ID *id, const char *path);
137
138 /* -------------------------------------- */
139
140 /* Move animation data from src to destination if it's paths are based on basepaths */
141 void BKE_animdata_separate_by_basepath(struct ID *srcID, struct ID *dstID, struct ListBase *basepaths);
142
143 /* Move F-Curves from src to destination if it's path is based on basepath */
144 void action_move_fcurves_by_basepath(struct bAction *srcAct, struct bAction *dstAct, const char basepath[]);
145
146 char *BKE_animdata_driver_path_hack(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop,
147                                     char *base_path);
148
149 /* ************************************* */
150 /* Gwn_Batch AnimData API */
151
152 /* Define for callback looper used in BKE_animdata_main_cb */
153 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
154
155 /* Define for callback looper used in BKE_fcurves_main_cb */
156 typedef void (*ID_FCurve_Edit_Callback)(struct ID *id, struct FCurve *fcu, void *user_data);
157
158
159 /* Loop over all datablocks applying callback */
160 void BKE_animdata_main_cb(struct Main *bmain, ID_AnimData_Edit_Callback func, void *user_data);
161
162 /* Loop over all datablocks applying callback to all its F-Curves */
163 void BKE_fcurves_main_cb(struct Main *bmain, ID_FCurve_Edit_Callback func, void *user_data);
164
165 /* ************************************* */
166 // TODO: overrides, remapping, and path-finding api's
167
168 /* ************************************* */
169 /* Evaluation API */
170
171 /* ------------- Main API -------------------- */
172 /* In general, these ones should be called to do all animation evaluation */
173
174 /* Evaluation loop for evaluating animation data  */
175 void BKE_animsys_evaluate_animdata(struct Scene *scene, struct ID *id, struct AnimData *adt, float ctime, short recalc);
176
177 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
178 void BKE_animsys_evaluate_all_animation(struct Main *main, struct Scene *scene, float ctime);
179
180 /* TODO(sergey): This is mainly a temp public function. */
181 struct FCurve;
182 bool BKE_animsys_execute_fcurve(struct PointerRNA *ptr, struct AnimMapper *remap, struct FCurve *fcu, float curval);
183
184 /* ------------ Specialized API --------------- */
185 /* There are a few special tools which require these following functions. They are NOT to be used
186  * for standard animation evaluation UNDER ANY CIRCUMSTANCES! 
187  *
188  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but 
189  *          Particles/Sequencer performing funky time manipulation is not ok.
190  */
191
192 /* Evaluate Action (F-Curve Bag) */
193 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
194
195 /* Evaluate Action Group */
196 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
197
198 /* ************************************* */
199
200 /* ------------ Evaluation API --------------- */
201
202 struct EvaluationContext;
203
204 void BKE_animsys_eval_animdata(const struct EvaluationContext *eval_ctx, struct ID *id);
205 void BKE_animsys_eval_driver(const struct EvaluationContext *eval_ctx, struct ID *id, struct FCurve *fcurve);
206
207 /* ************************************* */
208
209 #endif /* __BKE_ANIMSYS_H__*/