commit before doing some hefty shapekey change, will break compilation
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* Get AnimData from the given ID-block. */
47 struct AnimData *BKE_animdata_from_id(struct ID *id);
48
49 /* Add AnimData to the given ID-block */
50 struct AnimData *BKE_id_add_animdata(struct ID *id);
51
52 /* Free AnimData */
53 void BKE_free_animdata(struct ID *id);
54
55 /* Copy AnimData */
56 struct AnimData *BKE_copy_animdata(struct AnimData *adt);
57
58 /* Make Local */
59 void BKE_animdata_make_local(struct AnimData *adt);
60
61 /* ************************************* */
62 /* KeyingSets API */
63
64 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
65 struct KeyingSet *BKE_keyingset_add(struct ListBase *list, const char name[], short flag, short keyingflag);
66
67 /* Add a destination to a KeyingSet */
68 void BKE_keyingset_add_destination(struct KeyingSet *ks, struct ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode);
69
70 /* Find the destination matching the criteria given */
71 struct KS_Path *BKE_keyingset_find_destination(struct KeyingSet *ks, struct ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode);
72
73 /* Copy all KeyingSets in the given list */
74 void BKE_keyingsets_copy(struct ListBase *newlist, struct ListBase *list);
75
76 /* Free data for KeyingSet but not set itself */
77 void BKE_keyingset_free(struct KeyingSet *ks);
78
79 /* Free all the KeyingSets in the given list */
80 void BKE_keyingsets_free(struct ListBase *list);
81
82 /* ************************************* */
83 /* Path Fixing API */
84
85 /* Fix all the paths for the given ID+AnimData */
86 void BKE_animdata_fix_paths_rename(struct ID *owner_id, struct AnimData *adt, char *prefix, char *oldName, char *newName);
87
88 /* Fix all the paths for the entire database... */
89 void BKE_all_animdata_fix_paths_rename(char *prefix, char *oldName, char *newName);
90
91 /* ************************************* */
92 // TODO: overrides, remapping, and path-finding api's
93
94 /* ************************************* */
95 /* Evaluation API */
96
97 /* ------------- Main API -------------------- */
98 /* In general, these ones should be called to do all animation evaluation */
99
100 /* Evaluation loop for evaluating animation data  */
101 void BKE_animsys_evaluate_animdata(struct ID *id, struct AnimData *adt, float ctime, short recalc);
102
103 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only */
104 void BKE_animsys_evaluate_all_animation(struct Main *main, float ctime);
105
106
107 /* ------------ Specialised API --------------- */
108 /* There are a few special tools which require these following functions. They are NOT to be used
109  * for standard animation evaluation UNDER ANY CIRCUMSTANCES! 
110  *
111  * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but 
112  *          Particles/Sequencer performing funky time manipulation is not ok.
113  */
114
115 /* Evaluate Action (F-Curve Bag) */
116 void animsys_evaluate_action(struct PointerRNA *ptr, struct bAction *act, struct AnimMapper *remap, float ctime);
117
118 /* Evaluate Action Group */
119 void animsys_evaluate_action_group(struct PointerRNA *ptr, struct bAction *act, struct bActionGroup *agrp, struct AnimMapper *remap, float ctime);
120
121 /* ************************************* */
122
123 #endif /* BKE_ANIM_SYS_H*/