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