Merged changes in the trunk up to revision 44797.
[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
41 struct PointerRNA;
42 struct ReportList;
43 struct bAction;
44 struct bActionGroup;
45 struct AnimMapper;
46
47 /* ************************************* */
48 /* AnimData API */
49
50 /* Check if the given ID-block can have AnimData */
51 short id_type_can_have_animdata(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_id_add_animdata(struct ID *id);
58
59 /* Set active action used by AnimData from the given ID-block */
60 short BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
61
62 /* Free AnimData */
63 void BKE_free_animdata(struct ID *id);
64
65 /* Copy AnimData */
66 struct AnimData *BKE_copy_animdata(struct AnimData *adt, const short do_action);
67
68 /* Copy AnimData */
69 int BKE_copy_animdata_id(struct ID *id_to, struct ID *id_from, const short do_action);
70
71 /* Copy AnimData Actions */
72 void BKE_copy_animdata_id_action(struct ID *id);
73
74 /* Make Local */
75 void BKE_animdata_make_local(struct AnimData *adt);
76
77 /* Re-Assign ID's */
78 void BKE_relink_animdata(struct AnimData *adt);
79
80 /* ************************************* */
81 /* KeyingSets API */
82
83 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
84 struct KeyingSet *BKE_keyingset_add(struct ListBase *list, const char idname[], const char name[], short flag, short keyingflag);
85
86 /* Add a path to a KeyingSet */
87 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);
88
89 /* Find the destination matching the criteria given */
90 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);
91
92 /* Copy all KeyingSets in the given list */
93 void BKE_keyingsets_copy(struct ListBase *newlist, struct ListBase *list);
94
95 /* Free the given Keying Set path */
96 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
97
98 /* Free data for KeyingSet but not set itself */
99 void BKE_keyingset_free(struct KeyingSet *ks);
100
101 /* Free all the KeyingSets in the given list */
102 void BKE_keyingsets_free(struct ListBase *list);
103
104 /* ************************************* */
105 /* Path Fixing API */
106
107 /* Fix all the paths for the given ID+AnimData */
108 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, const char *prefix, const char *oldName, const char *newName, int oldSubscript, int newSubscript, int verify_paths);
109
110 /* Fix all the paths for the entire database... */
111 void BKE_all_animdata_fix_paths_rename(const char *prefix, const char *oldName, const char *newName);
112
113 /* -------------------------------------- */
114
115 /* Move animation data from src to destination if it's paths are based on basepaths */
116 void BKE_animdata_separate_by_basepath(struct ID *srcID, struct ID *dstID, struct ListBase *basepaths);
117
118 /* Move F-Curves from src to destination if it's path is based on basepath */
119 void action_move_fcurves_by_basepath(struct bAction *srcAct, struct bAction *dstAct, const char basepath[]);
120
121 /* ************************************* */
122 /* Batch AnimData API */
123
124 /* Define for callback looper used in BKE_animdata_main_cb */
125 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
126
127
128 /* Loop over all datablocks applying callback */
129 void BKE_animdata_main_cb(struct Main *main, ID_AnimData_Edit_Callback func, void *user_data);
130
131 /* ************************************* */
132 // TODO: overrides, remapping, and path-finding api's
133
134 /* ************************************* */
135 /* Evaluation API */
136
137 /* ------------- Main API -------------------- */
138 /* In general, these ones should be called to do all animation evaluation */
139
140 /* Evaluation loop for evaluating animation data  */
141 void BKE_animsys_evaluate_animdata(struct Scene *scene, struct ID *id, struct AnimData *adt, float ctime, short recalc);
142
143 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
144 void BKE_animsys_evaluate_all_animation(struct Main *main, struct Scene *scene, float ctime);
145
146
147 /* ------------ Specialized API --------------- */
148 /* There are a few special tools which require these following functions. They are NOT to be used
149  * for standard animation evaluation UNDER ANY CIRCUMSTANCES! 
150  *
151  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but 
152  *          Particles/Sequencer performing funky time manipulation is not ok.
153  */
154
155 /* Evaluate Action (F-Curve Bag) */
156 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
157
158 /* Evaluate Action Group */
159 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
160
161 /* ************************************* */
162
163 #endif /* __BKE_ANIMSYS_H__*/