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