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