Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_fcurve.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * Contributor(s): Joshua Leung (full recode)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_FCURVE_H__
27 #define __BKE_FCURVE_H__
28
29 /** \file BKE_fcurve.h
30  *  \ingroup bke
31  *  \author Joshua Leung
32  *  \since 2009
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct FCurve;
40 struct FModifier;
41 struct ChannelDriver;
42 struct DriverVar;
43 struct DriverTarget;
44 struct FCM_EnvelopeData;
45
46 struct bContext;
47 struct AnimData;
48 struct bAction;
49 struct BezTriple;
50 struct StructRNA;
51 struct PathResolvedRNA;
52 struct PointerRNA;
53 struct PropertyRNA;
54
55 #include "DNA_curve_types.h"
56
57 /* ************** Keyframe Tools ***************** */
58
59 typedef struct CfraElem {
60         struct CfraElem *next, *prev;
61         float cfra;
62         int sel;
63 } CfraElem;
64
65 void bezt_add_to_cfra_elem(ListBase *lb, struct BezTriple *bezt);
66
67 /* ************** F-Curve Drivers ***************** */
68
69 /* With these iterators for convenience, the variables "tarIndex" and "dtar" can be 
70  * accessed directly from the code using them, but it is not recommended that their
71  * values be changed to point at other slots...
72  */
73
74 /* convenience looper over ALL driver targets for a given variable (even the unused ones) */
75 #define DRIVER_TARGETS_LOOPER(dvar) \
76         { \
77                 DriverTarget *dtar = &dvar->targets[0]; \
78                 int tarIndex = 0; \
79                 for (; tarIndex < MAX_DRIVER_TARGETS; tarIndex++, dtar++)
80                  
81 /* convenience looper over USED driver targets only */
82 #define DRIVER_TARGETS_USED_LOOPER(dvar) \
83         { \
84                 DriverTarget *dtar = &dvar->targets[0]; \
85                 int tarIndex = 0; \
86                 for (; tarIndex < dvar->num_targets; tarIndex++, dtar++)
87                 
88 /* tidy up for driver targets loopers */
89 #define DRIVER_TARGETS_LOOPER_END \
90 }
91
92 /* ---------------------- */
93
94 void fcurve_free_driver(struct FCurve *fcu);
95 struct ChannelDriver *fcurve_copy_driver(const struct ChannelDriver *driver);
96
97 void driver_variables_copy(struct ListBase *dst_list, const struct ListBase *src_list);
98
99 void driver_free_variable(struct ListBase *variables, struct DriverVar *dvar);
100 void driver_free_variable_ex(struct ChannelDriver *driver, struct DriverVar *dvar);
101
102 void driver_change_variable_type(struct DriverVar *dvar, int type);
103 void driver_variable_name_validate(struct DriverVar *dvar);
104 struct DriverVar *driver_add_new_variable(struct ChannelDriver *driver);
105
106 float driver_get_variable_value(struct ChannelDriver *driver, struct DriverVar *dvar);
107 bool  driver_get_variable_property(
108         struct ChannelDriver *driver, struct DriverTarget *dtar,
109         struct PointerRNA *r_ptr, struct PropertyRNA **r_prop, int *r_index);
110
111 float evaluate_driver(struct PathResolvedRNA *anim_rna, struct ChannelDriver *driver, const float evaltime);
112
113 /* ************** F-Curve Modifiers *************** */
114
115 typedef struct GHash FModifierStackStorage;
116
117 /* F-Curve Modifier Type-Info (fmi):
118  *  This struct provides function pointers for runtime, so that functions can be
119  *  written more generally (with fewer/no special exceptions for various modifiers).
120  *
121  *  Callers of these functions must check that they actually point to something useful,
122  *  as some constraints don't define some of these.
123  *
124  *  Warning: it is not too advisable to reorder order of members of this struct,
125  *                      as you'll have to edit quite a few ($FMODIFIER_NUM_TYPES) of these
126  *                      structs.
127  */
128 typedef struct FModifierTypeInfo {
129         /* admin/ident */
130         short type;             /* FMODIFIER_TYPE_### */
131         short size;             /* size in bytes of the struct */
132         short acttype;          /* eFMI_Action_Types */
133         short requires;         /* eFMI_Requirement_Flags */
134         char  name[64];          /* name of modifier in interface */
135         char  structName[64];    /* name of struct for SDNA */
136         
137         /* data management function pointers - special handling */
138         /* free any data that is allocated separately (optional) */
139         void (*free_data)(struct FModifier *fcm);
140         /* copy any special data that is allocated separately (optional) */
141         void (*copy_data)(struct FModifier *fcm, const struct FModifier *src);
142         /* set settings for data that will be used for FCuModifier.data (memory already allocated using MEM_callocN) */
143         void (*new_data)(void *mdata);
144         /* verifies that the modifier settings are valid */
145         void (*verify_data)(struct FModifier *fcm);
146         
147         /* evaluation */
148         /* evaluate time that the modifier requires the F-Curve to be evaluated at */
149         float (*evaluate_modifier_time)(struct FCurve *fcu, struct FModifier *fcm, float cvalue, float evaltime);
150         /* evaluate the modifier for the given time and 'accumulated' value */
151         void (*evaluate_modifier)(struct FCurve *fcu, struct FModifier *fcm, float *cvalue, float evaltime);
152
153         /* Same as above but for modifiers which requires storage */
154         float (*evaluate_modifier_time_storage)(FModifierStackStorage *storage, struct FCurve *fcu, struct FModifier *fcm, float cvalue, float evaltime);
155         void (*evaluate_modifier_storage)(FModifierStackStorage *storage, struct FCurve *fcu, struct FModifier *fcm, float *cvalue, float evaltime);
156 } FModifierTypeInfo;
157
158 /* Values which describe the behavior of a FModifier Type */
159 typedef enum eFMI_Action_Types {
160         /* modifier only modifies values outside of data range */
161         FMI_TYPE_EXTRAPOLATION = 0,
162         /* modifier leaves data-points alone, but adjusts the interpolation between and around them */
163         FMI_TYPE_INTERPOLATION,
164         /* modifier only modifies the values of points (but times stay the same) */
165         FMI_TYPE_REPLACE_VALUES,
166         /* modifier generates a curve regardless of what came before */
167         FMI_TYPE_GENERATE_CURVE
168 } eFMI_Action_Types;
169
170 /* Flags for the requirements of a FModifier Type */
171 typedef enum eFMI_Requirement_Flags {
172         /* modifier requires original data-points (kindof beats the purpose of a modifier stack?) */
173         FMI_REQUIRES_ORIGINAL_DATA      = (1 << 0),
174         /* modifier doesn't require on any preceding data (i.e. it will generate a curve).
175          * Use in conjunction with FMI_TYPE_GENRATE_CURVE
176          */
177         FMI_REQUIRES_NOTHING            = (1 << 1),
178         /* refer to modifier instance */
179         FMI_REQUIRES_RUNTIME_CHECK      = (1 << 2),
180
181         /* Requires to store data shared between time and valua evaluation */
182         FMI_REQUIRES_STORAGE            = (1 << 3)
183 } eFMI_Requirement_Flags;
184
185 /* Function Prototypes for FModifierTypeInfo's */
186 const FModifierTypeInfo *fmodifier_get_typeinfo(const struct FModifier *fcm);
187 const FModifierTypeInfo *get_fmodifier_typeinfo(const int type);
188
189 /* ---------------------- */
190
191 struct FModifier *add_fmodifier(ListBase *modifiers, int type, struct FCurve *owner_fcu);
192 struct FModifier *copy_fmodifier(const struct FModifier *src);
193 void copy_fmodifiers(ListBase *dst, const ListBase *src);
194 bool remove_fmodifier(ListBase *modifiers, struct FModifier *fcm);
195 void free_fmodifiers(ListBase *modifiers);
196
197 struct FModifier *find_active_fmodifier(ListBase *modifiers);
198 void set_active_fmodifier(ListBase *modifiers, struct FModifier *fcm);
199
200 bool list_has_suitable_fmodifier(ListBase *modifiers, int mtype, short acttype);
201
202 FModifierStackStorage *evaluate_fmodifiers_storage_new(ListBase *modifiers);
203 void evaluate_fmodifiers_storage_free(FModifierStackStorage *storage);
204 float evaluate_time_fmodifiers(FModifierStackStorage *storage, ListBase *modifiers, struct FCurve *fcu, float cvalue, float evaltime);
205 void evaluate_value_fmodifiers(FModifierStackStorage *storage, ListBase *modifiers, struct FCurve *fcu, float *cvalue, float evaltime);
206
207 void fcurve_bake_modifiers(struct FCurve *fcu, int start, int end);
208
209 int BKE_fcm_envelope_find_index(struct FCM_EnvelopeData *array, float frame, int arraylen, bool *r_exists);
210
211 /* ************** F-Curves API ******************** */
212
213 /* threshold for binary-searching keyframes - threshold here should be good enough for now, but should become userpref */
214 #define BEZT_BINARYSEARCH_THRESH   0.01f /* was 0.00001, but giving errors */
215
216 /* -------- Data Management  --------  */
217
218 void free_fcurve(struct FCurve *fcu);
219 struct FCurve *copy_fcurve(const struct FCurve *fcu);
220
221 void free_fcurves(ListBase *list);
222 void copy_fcurves(ListBase *dst, ListBase *src);
223
224 /* find matching F-Curve in the given list of F-Curves */
225 struct FCurve *list_find_fcurve(ListBase *list, const char rna_path[], const int array_index);
226
227 struct FCurve *iter_step_fcurve(struct FCurve *fcu_iter, const char rna_path[]);
228
229 /* high level function to get an fcurve from C without having the rna */
230 struct FCurve *id_data_find_fcurve(ID *id, void *data, struct StructRNA *type, const char *prop_name, int index, bool *r_driven);
231
232 /* Get list of LinkData's containing pointers to the F-Curves which control the types of data indicated 
233  *      e.g.  numMatches = list_find_data_fcurves(matches, &act->curves, "pose.bones[", "MyFancyBone");
234  */
235 int list_find_data_fcurves(ListBase *dst, ListBase *src, const char *dataPrefix, const char *dataName);
236
237 /* Find an f-curve based on an rna property. */
238 struct FCurve *rna_get_fcurve(
239         struct PointerRNA *ptr, struct PropertyRNA *prop, int rnaindex,
240         struct AnimData **r_adt, struct bAction **r_action,
241         bool *r_driven, bool *r_special);
242 /* Same as above, but takes a context data, temp hack needed for complex paths like texture ones. */
243 struct FCurve *rna_get_fcurve_context_ui(
244         struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int rnaindex,
245         struct AnimData **r_adt, struct bAction **r_action, bool *r_driven, bool *r_special);
246
247 /* Binary search algorithm for finding where to 'insert' BezTriple with given frame number.
248  * Returns the index to insert at (data already at that index will be offset if replace is 0)
249  */
250 int binarysearch_bezt_index(struct BezTriple array[], float frame, int arraylen, bool *r_replace);
251
252 /* get the time extents for F-Curve */
253 bool calc_fcurve_range(struct FCurve *fcu, float *min, float *max,
254                        const bool do_sel_only, const bool do_min_length);
255
256 /* get the bounding-box extents for F-Curve */
257 bool calc_fcurve_bounds(struct FCurve *fcu, float *xmin, float *xmax, float *ymin, float *ymax,
258                         const bool do_sel_only, const bool include_handles);
259
260 /* .............. */
261
262 /* Are keyframes on F-Curve of any use (to final result, and to show in editors)? */
263 bool fcurve_are_keyframes_usable(struct FCurve *fcu);
264
265 /* Can keyframes be added to F-Curve? */
266 bool fcurve_is_keyframable(struct FCurve *fcu);
267 bool BKE_fcurve_is_protected(struct FCurve *fcu);
268
269 /* The curve is an infinite cycle via Cycles modifier */
270 bool BKE_fcurve_is_cyclic(struct FCurve *fcu);
271
272 /* -------- Curve Sanity --------  */
273
274 void calchandles_fcurve(struct FCurve *fcu);
275 void testhandles_fcurve(struct FCurve *fcu, const bool use_handle);
276 void sort_time_fcurve(struct FCurve *fcu);
277 short test_time_fcurve(struct FCurve *fcu);
278
279 void correct_bezpart(float v1[2], float v2[2], float v3[2], float v4[2]);
280
281 /* -------- Evaluation --------  */
282
283 /* evaluate fcurve */
284 float evaluate_fcurve(struct FCurve *fcu, float evaltime);
285 float evaluate_fcurve_driver(struct PathResolvedRNA *anim_rna, struct FCurve *fcu, float evaltime);
286 /* evaluate fcurve and store value */
287 float calculate_fcurve(struct PathResolvedRNA *anim_rna, struct FCurve *fcu, float evaltime);
288
289 /* ************* F-Curve Samples API ******************** */
290
291 /* -------- Defines --------  */
292
293 /* Basic signature for F-Curve sample-creation function 
294  *      - fcu: the F-Curve being operated on
295  *      - data: pointer to some specific data that may be used by one of the callbacks
296  */
297 typedef float (*FcuSampleFunc)(struct FCurve *fcu, void *data, float evaltime);
298
299 /* ----- Sampling Callbacks ------  */
300
301 /* Basic sampling callback which acts as a wrapper for evaluate_fcurve() */
302 float fcurve_samplingcb_evalcurve(struct FCurve *fcu, void *data, float evaltime);
303
304 /* -------- Main Methods --------  */
305
306 /* Main API function for creating a set of sampled curve data, given some callback function 
307  * used to retrieve the values to store.
308  */
309 void fcurve_store_samples(struct FCurve *fcu, void *data, int start, int end, FcuSampleFunc sample_cb);
310
311 #ifdef __cplusplus
312 }
313 #endif
314
315 #endif /* __BKE_FCURVE_H__*/