synched with trunk at revision 34793
[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 struct ID;
32 struct ListBase;
33 struct Main;
34 struct AnimData;
35 struct KeyingSet;
36 struct KS_Path;
37
38 struct PointerRNA;
39 struct bAction;
40 struct bActionGroup;
41 struct AnimMapper;
42
43 /* ************************************* */
44 /* AnimData API */
45
46 /* Check if the given ID-block can have AnimData */
47 short id_type_can_have_animdata(struct ID *id);
48
49 /* Get AnimData from the given ID-block */
50 struct AnimData *BKE_animdata_from_id(struct ID *id);
51
52 /* Add AnimData to the given ID-block */
53 struct AnimData *BKE_id_add_animdata(struct ID *id);
54
55 /* Free AnimData */
56 void BKE_free_animdata(struct ID *id);
57
58 /* Copy AnimData */
59 struct AnimData *BKE_copy_animdata(struct AnimData *adt);
60
61 /* Copy AnimData */
62 int BKE_copy_animdata_id(struct ID *id_to, struct ID *id_from);
63
64 /* Make Local */
65 void BKE_animdata_make_local(struct AnimData *adt);
66
67 /* ************************************* */
68 /* KeyingSets API */
69
70 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
71 struct KeyingSet *BKE_keyingset_add(struct ListBase *list, const char name[], short flag, short keyingflag);
72
73 /* Add a path to a KeyingSet */
74 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);
75
76 /* Find the destination matching the criteria given */
77 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);
78
79 /* Copy all KeyingSets in the given list */
80 void BKE_keyingsets_copy(struct ListBase *newlist, struct ListBase *list);
81
82 /* Free the given Keying Set path */
83 void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
84
85 /* Free data for KeyingSet but not set itself */
86 void BKE_keyingset_free(struct KeyingSet *ks);
87
88 /* Free all the KeyingSets in the given list */
89 void BKE_keyingsets_free(struct ListBase *list);
90
91 /* ************************************* */
92 /* Path Fixing API */
93
94 /* Fix all the paths for the given ID+AnimData */
95 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, char *prefix, char *oldName, char *newName, int oldSubscript, int newSubscript, int verify_paths);
96
97 /* Fix all the paths for the entire database... */
98 void BKE_all_animdata_fix_paths_rename(char *prefix, char *oldName, char *newName);
99
100 /* ************************************* */
101 /* Batch AnimData API */
102
103 /* Define for callback looper used in BKE_animdata_main_cb */
104 typedef void (*ID_AnimData_Edit_Callback)(struct ID *id, struct AnimData *adt, void *user_data);
105
106
107 /* Loop over all datablocks applying callback */
108 void BKE_animdata_main_cb(struct Main *main, ID_AnimData_Edit_Callback func, void *user_data);
109
110 /* ************************************* */
111 // TODO: overrides, remapping, and path-finding api's
112
113 /* ************************************* */
114 /* Evaluation API */
115
116 /* ------------- Main API -------------------- */
117 /* In general, these ones should be called to do all animation evaluation */
118
119 /* Evaluation loop for evaluating animation data  */
120 void BKE_animsys_evaluate_animdata(struct ID *id, struct AnimData *adt, float ctime, short recalc);
121
122 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
123 void BKE_animsys_evaluate_all_animation(struct Main *main, float ctime);
124
125
126 /* ------------ Specialised API --------------- */
127 /* There are a few special tools which require these following functions. They are NOT to be used
128  * for standard animation evaluation UNDER ANY CIRCUMSTANCES! 
129  *
130  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but 
131  *          Particles/Sequencer performing funky time manipulation is not ok.
132  */
133
134 /* Evaluate Action (F-Curve Bag) */
135 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
136
137 /* Evaluate Action Group */
138 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
139
140 /* ************************************* */
141
142 #endif /* BKE_ANIM_SYS_H*/