Merging r39717 through r39983 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_fcurve.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 (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_FCURVE_H
29 #define BKE_FCURVE_H
30
31 /** \file BKE_fcurve.h
32  *  \ingroup bke
33  *  \author Joshua Leung
34  *  \since 2009
35  */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct FCurve;
42 struct FModifier;
43 struct ChannelDriver;
44 struct DriverVar;
45 struct DriverTarget;
46
47 struct bAction;
48 struct BezTriple;
49 struct StructRNA;
50 struct PointerRNA;
51 struct PropertyRNA;
52
53 #include "DNA_curve_types.h"
54
55 /* ************** Keyframe Tools ***************** */
56
57 typedef struct CfraElem {
58         struct CfraElem *next, *prev;
59         float cfra;
60         int sel;
61 } CfraElem;
62
63 void bezt_add_to_cfra_elem(ListBase *lb, struct BezTriple *bezt);
64
65 /* ************** F-Curve Drivers ***************** */
66
67 /* With these iterators for convenience, the variables "tarIndex" and "dtar" can be 
68  * accessed directly from the code using them, but it is not recommended that their
69  * values be changed to point at other slots...
70  */
71
72 /* convenience looper over ALL driver targets for a given variable (even the unused ones) */
73 #define DRIVER_TARGETS_LOOPER(dvar) \
74         { \
75                 DriverTarget *dtar= &dvar->targets[0]; \
76                 int tarIndex= 0; \
77                 for (; tarIndex < MAX_DRIVER_TARGETS; tarIndex++, dtar++)
78                  
79 /* convenience looper over USED driver targets only */
80 #define DRIVER_TARGETS_USED_LOOPER(dvar) \
81         { \
82                 DriverTarget *dtar= &dvar->targets[0]; \
83                 int tarIndex= 0; \
84                 for (; tarIndex < dvar->num_targets; tarIndex++, dtar++)
85                 
86 /* tidy up for driver targets loopers */
87 #define DRIVER_TARGETS_LOOPER_END \
88         }
89
90 /* ---------------------- */
91
92 void fcurve_free_driver(struct FCurve *fcu);
93 struct ChannelDriver *fcurve_copy_driver(struct ChannelDriver *driver);
94
95 void driver_free_variable(struct ChannelDriver *driver, struct DriverVar *dvar);
96 void driver_change_variable_type(struct DriverVar *dvar, int type);
97 struct DriverVar *driver_add_new_variable(struct ChannelDriver *driver);
98
99 float driver_get_variable_value (struct ChannelDriver *driver, struct DriverVar *dvar);
100
101 /* ************** F-Curve Modifiers *************** */
102
103 /* F-Curve Modifier Type-Info (fmi):
104  *  This struct provides function pointers for runtime, so that functions can be
105  *  written more generally (with fewer/no special exceptions for various modifiers).
106  *
107  *  Callers of these functions must check that they actually point to something useful,
108  *  as some constraints don't define some of these.
109  *
110  *  Warning: it is not too advisable to reorder order of members of this struct,
111  *                      as you'll have to edit quite a few ($FMODIFIER_NUM_TYPES) of these
112  *                      structs.
113  */
114 typedef struct FModifierTypeInfo {
115         /* admin/ident */
116         short type;                             /* FMODIFIER_TYPE_### */
117         short size;                             /* size in bytes of the struct */
118         short acttype;                  /* eFMI_Action_Types */
119         short requires;                 /* eFMI_Requirement_Flags */
120         char name[64];                  /* name of modifier in interface */
121         char structName[64];    /* name of struct for SDNA */
122         
123         /* data management function pointers - special handling */
124                 /* free any data that is allocated separately (optional) */
125         void (*free_data)(struct FModifier *fcm);
126                 /* copy any special data that is allocated separately (optional) */
127         void (*copy_data)(struct FModifier *fcm, struct FModifier *src);
128                 /* set settings for data that will be used for FCuModifier.data (memory already allocated using MEM_callocN) */
129         void (*new_data)(void *mdata);
130                 /* verifies that the modifier settings are valid */
131         void (*verify_data)(struct FModifier *fcm);
132         
133         /* evaluation */
134                 /* evaluate time that the modifier requires the F-Curve to be evaluated at */
135         float (*evaluate_modifier_time)(struct FCurve *fcu, struct FModifier *fcm, float cvalue, float evaltime);
136                 /* evaluate the modifier for the given time and 'accumulated' value */
137         void (*evaluate_modifier)(struct FCurve *fcu, struct FModifier *fcm, float *cvalue, float evaltime);
138 } FModifierTypeInfo;
139
140 /* Values which describe the behaviour of a FModifier Type */
141 typedef enum eFMI_Action_Types {
142                 /* modifier only modifies values outside of data range */
143         FMI_TYPE_EXTRAPOLATION = 0,
144                 /* modifier leaves data-points alone, but adjusts the interpolation between and around them */
145         FMI_TYPE_INTERPOLATION,
146                 /* modifier only modifies the values of points (but times stay the same) */
147         FMI_TYPE_REPLACE_VALUES,
148                 /* modifier generates a curve regardless of what came before */
149         FMI_TYPE_GENERATE_CURVE
150 } eFMI_Action_Types;
151
152 /* Flags for the requirements of a FModifier Type */
153 typedef enum eFMI_Requirement_Flags {
154                 /* modifier requires original data-points (kindof beats the purpose of a modifier stack?) */
155         FMI_REQUIRES_ORIGINAL_DATA              = (1<<0),
156                 /* modifier doesn't require on any preceding data (i.e. it will generate a curve). 
157                  * Use in conjunction with FMI_TYPE_GENRATE_CURVE 
158                  */
159         FMI_REQUIRES_NOTHING                    = (1<<1),
160                 /* refer to modifier instance */
161         FMI_REQUIRES_RUNTIME_CHECK              = (1<<2)
162 } eFMI_Requirement_Flags;
163
164 /* Function Prototypes for FModifierTypeInfo's */
165 FModifierTypeInfo *fmodifier_get_typeinfo(struct FModifier *fcm);
166 FModifierTypeInfo *get_fmodifier_typeinfo(int type);
167
168 /* ---------------------- */
169
170 struct FModifier *add_fmodifier(ListBase *modifiers, int type);
171 struct FModifier *copy_fmodifier(struct FModifier *src);
172 void copy_fmodifiers(ListBase *dst, ListBase *src);
173 int remove_fmodifier(ListBase *modifiers, struct FModifier *fcm);
174 void free_fmodifiers(ListBase *modifiers);
175
176 struct FModifier *find_active_fmodifier(ListBase *modifiers);
177 void set_active_fmodifier(ListBase *modifiers, struct FModifier *fcm);
178
179 short list_has_suitable_fmodifier(ListBase *modifiers, int mtype, short acttype);
180
181 float evaluate_time_fmodifiers(ListBase *modifiers, struct FCurve *fcu, float cvalue, float evaltime);
182 void evaluate_value_fmodifiers(ListBase *modifiers, struct FCurve *fcu, float *cvalue, float evaltime);
183
184 void fcurve_bake_modifiers(struct FCurve *fcu, int start, int end);
185
186 /* ************** F-Curves API ******************** */
187
188 /* -------- Data Managemnt  --------  */
189
190 void free_fcurve(struct FCurve *fcu);
191 struct FCurve *copy_fcurve(struct FCurve *fcu);
192
193 void free_fcurves(ListBase *list);
194 void copy_fcurves(ListBase *dst, ListBase *src);
195
196 /* find matching F-Curve in the given list of F-Curves */
197 struct FCurve *list_find_fcurve(ListBase *list, const char rna_path[], const int array_index);
198
199 struct FCurve *iter_step_fcurve (struct FCurve *fcu_iter, const char rna_path[]);
200
201 /* high level function to get an fcurve from C without having the rna */
202 struct FCurve *id_data_find_fcurve(ID *id, void *data, struct StructRNA *type, const char *prop_name, int index, char *driven);
203
204 /* Get list of LinkData's containing pointers to the F-Curves which control the types of data indicated 
205  *      e.g.  numMatches = list_find_data_fcurves(matches, &act->curves, "pose.bones[", "MyFancyBone");
206  */
207 int list_find_data_fcurves(ListBase *dst, ListBase *src, const char *dataPrefix, const char *dataName);
208
209 /* find an f-curve based on an rna property */
210 struct FCurve *rna_get_fcurve(struct PointerRNA *ptr, struct PropertyRNA *prop, int rnaindex, struct bAction **action, int *driven);
211
212 /* Binary search algorithm for finding where to 'insert' BezTriple with given frame number.
213  * Returns the index to insert at (data already at that index will be offset if replace is 0)
214  */
215 int binarysearch_bezt_index(struct BezTriple array[], float frame, int arraylen, short *replace);
216
217 /* get the time extents for F-Curve */
218 void calc_fcurve_range(struct FCurve *fcu, float *min, float *max, const short selOnly);
219
220 /* get the bounding-box extents for F-Curve */
221 void calc_fcurve_bounds(struct FCurve *fcu, float *xmin, float *xmax, float *ymin, float *ymax, const short selOnly);
222
223 /* .............. */
224
225 /* Are keyframes on F-Curve of any use (to final result, and to show in editors)? */
226 short fcurve_are_keyframes_usable(struct FCurve *fcu);
227
228 /* Can keyframes be added to F-Curve? */
229 short fcurve_is_keyframable(struct FCurve *fcu);
230
231 /* -------- Curve Sanity --------  */
232
233 void calchandles_fcurve(struct FCurve *fcu);
234 void testhandles_fcurve(struct FCurve *fcu);
235 void sort_time_fcurve(struct FCurve *fcu);
236 short test_time_fcurve(struct FCurve *fcu);
237
238 void correct_bezpart(float *v1, float *v2, float *v3, float *v4);
239
240 /* -------- Evaluation --------  */
241
242 /* evaluate fcurve */
243 float evaluate_fcurve(struct FCurve *fcu, float evaltime);
244 /* evaluate fcurve and store value */
245 void calculate_fcurve(struct FCurve *fcu, float ctime);
246
247 /* ************* F-Curve Samples API ******************** */
248
249 /* -------- Defines --------  */
250
251 /* Basic signature for F-Curve sample-creation function 
252  *      - fcu: the F-Curve being operated on
253  *      - data: pointer to some specific data that may be used by one of the callbacks
254  */
255 typedef float (*FcuSampleFunc)(struct FCurve *fcu, void *data, float evaltime);
256
257 /* ----- Sampling Callbacks ------  */
258
259 /* Basic sampling callback which acts as a wrapper for evaluate_fcurve() */
260 float fcurve_samplingcb_evalcurve(struct FCurve *fcu, void *data, float evaltime);
261
262 /* -------- Main Methods --------  */
263
264 /* Main API function for creating a set of sampled curve data, given some callback function 
265  * used to retrieve the values to store.
266  */
267 void fcurve_store_samples(struct FCurve *fcu, void *data, int start, int end, FcuSampleFunc sample_cb);
268
269 #ifdef __cplusplus
270 }
271 #endif
272
273 #endif /* BKE_FCURVE_H*/