Merge with trunk up to r38584.
[blender.git] / source / blender / blenkernel / BKE_animsys.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * Contributor(s): Joshua Leung (original author)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_ANIM_SYS_H
29 #define BKE_ANIM_SYS_H
30
31 /** \file BKE_animsys.h
32  *  \ingroup bke
33  *  \author Joshua Leung
34  */
35
36 struct ID;
37 struct ListBase;
38 struct Main;
39 struct AnimData;
40 struct KeyingSet;
41 struct KS_Path;
42
43 struct PointerRNA;
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 short id_type_can_have_animdata(struct ID *id);
54
55 /* Get AnimData from the given ID-block */
56 struct AnimData *BKE_animdata_from_id(struct ID *id);
57
58 /* Add AnimData to the given ID-block */
59 struct AnimData *BKE_id_add_animdata(struct ID *id);
60
61 /* Set active action used by AnimData from the given ID-block */
62 short BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
63
64 /* Free AnimData */
65 void BKE_free_animdata(struct ID *id);
66
67 /* Copy AnimData */
68 struct AnimData *BKE_copy_animdata(struct AnimData *adt, const short do_action);
69
70 /* Copy AnimData */
71 int BKE_copy_animdata_id(struct ID *id_to, struct ID *id_from, const short do_action);
72
73 /* Copy AnimData Actions */
74 void BKE_copy_animdata_id_action(struct ID *id);
75
76 /* Make Local */
77 void BKE_animdata_make_local(struct AnimData *adt);
78
79 /* Re-Assign ID's */
80 void BKE_relink_animdata(struct AnimData *adt);
81
82 /* ************************************* */
83 /* KeyingSets API */
84
85 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
86 struct KeyingSet *BKE_keyingset_add(struct ListBase *list, const char name[], short flag, short keyingflag);
87
88 /* Add a path to a KeyingSet */
89 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);
90
91 /* Find the destination matching the criteria given */
92 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);
93
94 /* Copy all KeyingSets in the given list */
95 void BKE_keyingsets_copy(struct ListBase *newlist, struct ListBase *list);
96
97 /* Free the given Keying Set path */
98 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
99
100 /* Free data for KeyingSet but not set itself */
101 void BKE_keyingset_free(struct KeyingSet *ks);
102
103 /* Free all the KeyingSets in the given list */
104 void BKE_keyingsets_free(struct ListBase *list);
105
106 /* ************************************* */
107 /* Path Fixing API */
108
109 /* Fix all the paths for the given ID+AnimData */
110 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, const char *prefix, char *oldName, char *newName, int oldSubscript, int newSubscript, int verify_paths);
111
112 /* Fix all the paths for the entire database... */
113 void BKE_all_animdata_fix_paths_rename(char *prefix, char *oldName, char *newName);
114
115 /* -------------------------------------- */
116
117 /* Move animation data from src to destination if it's paths are based on basepaths */
118 void BKE_animdata_separate_by_basepath(struct ID *srcID, struct ID *dstID, struct ListBase *basepaths);
119
120 /* Move F-Curves from src to destination if it's path is based on basepath */
121 void action_move_fcurves_by_basepath(struct bAction *srcAct, struct bAction *dstAct, const char basepath[]);
122
123 /* ************************************* */
124 /* Batch AnimData API */
125
126 /* Define for callback looper used in BKE_animdata_main_cb */
127 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
128
129
130 /* Loop over all datablocks applying callback */
131 void BKE_animdata_main_cb(struct Main *main, ID_AnimData_Edit_Callback func, void *user_data);
132
133 /* ************************************* */
134 // TODO: overrides, remapping, and path-finding api's
135
136 /* ************************************* */
137 /* Evaluation API */
138
139 /* ------------- Main API -------------------- */
140 /* In general, these ones should be called to do all animation evaluation */
141
142 /* Evaluation loop for evaluating animation data  */
143 void BKE_animsys_evaluate_animdata(struct ID *id, struct AnimData *adt, float ctime, short recalc);
144
145 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
146 void BKE_animsys_evaluate_all_animation(struct Main *main, float ctime);
147
148
149 /* ------------ Specialised API --------------- */
150 /* There are a few special tools which require these following functions. They are NOT to be used
151  * for standard animation evaluation UNDER ANY CIRCUMSTANCES! 
152  *
153  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but 
154  *          Particles/Sequencer performing funky time manipulation is not ok.
155  */
156
157 /* Evaluate Action (F-Curve Bag) */
158 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
159
160 /* Evaluate Action Group */
161 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
162
163 /* ************************************* */
164
165 #endif /* BKE_ANIM_SYS_H*/