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