COLLADA branch: merge from trunk -r 24522:24758.
[blender.git] / source / blender / makesrna / intern / rna_fcurve.c
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  * Contributor(s): Blender Foundation (2009), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_access.h"
28 #include "RNA_define.h"
29 #include "RNA_types.h"
30 #include "RNA_enum_types.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "MEM_guardedalloc.h"
39
40 #include "WM_types.h"
41
42 EnumPropertyItem fmodifier_type_items[] = {
43         {FMODIFIER_TYPE_NULL, "NULL", 0, "Invalid", ""},
44         {FMODIFIER_TYPE_GENERATOR, "GENERATOR", 0, "Generator", ""},
45         {FMODIFIER_TYPE_FN_GENERATOR, "FNGENERATOR", 0, "Built-In Function", ""},
46         {FMODIFIER_TYPE_ENVELOPE, "ENVELOPE", 0, "Envelope", ""},
47         {FMODIFIER_TYPE_CYCLES, "CYCLES", 0, "Cycles", ""},
48         {FMODIFIER_TYPE_NOISE, "NOISE", 0, "Noise", ""},
49         {FMODIFIER_TYPE_FILTER, "FILTER", 0, "Filter", ""},
50         {FMODIFIER_TYPE_PYTHON, "PYTHON", 0, "Python", ""},
51         {FMODIFIER_TYPE_LIMITS, "LIMITS", 0, "Limits", ""},
52         {0, NULL, 0, NULL, NULL}};
53
54 #ifdef RNA_RUNTIME
55
56 #include "WM_api.h"
57
58 static StructRNA *rna_FModifierType_refine(struct PointerRNA *ptr)
59 {
60         FModifier *fcm= (FModifier *)ptr->data;
61
62         switch (fcm->type) {
63                 case FMODIFIER_TYPE_GENERATOR:
64                         return &RNA_FModifierGenerator;
65                 case FMODIFIER_TYPE_FN_GENERATOR:
66                         return &RNA_FModifierFunctionGenerator;
67                 case FMODIFIER_TYPE_ENVELOPE:
68                         return &RNA_FModifierEnvelope;
69                 case FMODIFIER_TYPE_CYCLES:
70                         return &RNA_FModifierCycles;
71                 case FMODIFIER_TYPE_NOISE:
72                         return &RNA_FModifierNoise;
73                 //case FMODIFIER_TYPE_FILTER:
74                 //      return &RNA_FModifierFilter;
75                 case FMODIFIER_TYPE_PYTHON:
76                         return &RNA_FModifierPython;
77                 case FMODIFIER_TYPE_LIMITS:
78                         return &RNA_FModifierLimits;
79                 default:
80                         return &RNA_UnknownType;
81         }
82 }
83
84 /* ****************************** */
85
86 #include "BKE_fcurve.h"
87 #include "BKE_depsgraph.h"
88
89 static void rna_ChannelDriver_update_data(bContext *C, PointerRNA *ptr)
90 {
91         ID *id= ptr->id.data;
92         
93         // TODO: this really needs an update guard...
94         DAG_scene_sort(CTX_data_scene(C));
95         DAG_id_flush_update(id, OB_RECALC_DATA);
96         
97         WM_event_add_notifier(C, NC_SCENE, id);
98 }
99
100 /* ----------- */
101
102 static StructRNA *rna_DriverTarget_id_typef(PointerRNA *ptr)
103 {
104         DriverTarget *dtar= (DriverTarget*)ptr->data;
105         return ID_code_to_RNA_type(dtar->idtype);
106 }
107
108 static int rna_DriverTarget_id_editable(PointerRNA *ptr)
109 {
110         DriverTarget *dtar= (DriverTarget*)ptr->data;
111         return (dtar->idtype)? PROP_EDITABLE : 0;
112 }
113
114 static void rna_DriverTarget_id_type_set(PointerRNA *ptr, int value)
115 {
116         DriverTarget *data= (DriverTarget*)(ptr->data);
117         
118         /* set the driver type, then clear the id-block if the type is invalid */
119         data->idtype= value;
120         if ((data->id) && (GS(data->id->name) != data->idtype))
121                 data->id= NULL;
122 }
123
124 static void rna_DriverTarget_RnaPath_get(PointerRNA *ptr, char *value)
125 {
126         DriverTarget *dtar= (DriverTarget *)ptr->data;
127
128         if (dtar->rna_path)
129                 strcpy(value, dtar->rna_path);
130         else
131                 strcpy(value, "");
132 }
133
134 static int rna_DriverTarget_RnaPath_length(PointerRNA *ptr)
135 {
136         DriverTarget *dtar= (DriverTarget *)ptr->data;
137         
138         if (dtar->rna_path)
139                 return strlen(dtar->rna_path);
140         else
141                 return 0;
142 }
143
144 static void rna_DriverTarget_RnaPath_set(PointerRNA *ptr, const char *value)
145 {
146         DriverTarget *dtar= (DriverTarget *)ptr->data;
147         
148         // XXX in this case we need to be very careful, as this will require some new dependencies to be added!
149         if (dtar->rna_path)
150                 MEM_freeN(dtar->rna_path);
151         
152         if (strlen(value))
153                 dtar->rna_path= BLI_strdup(value);
154         else 
155                 dtar->rna_path= NULL;
156 }
157
158 /* ****************************** */
159
160 static void rna_FCurve_RnaPath_get(PointerRNA *ptr, char *value)
161 {
162         FCurve *fcu= (FCurve *)ptr->data;
163
164         if (fcu->rna_path)
165                 strcpy(value, fcu->rna_path);
166         else
167                 strcpy(value, "");
168 }
169
170 static int rna_FCurve_RnaPath_length(PointerRNA *ptr)
171 {
172         FCurve *fcu= (FCurve *)ptr->data;
173         
174         if (fcu->rna_path)
175                 return strlen(fcu->rna_path);
176         else
177                 return 0;
178 }
179
180 static void rna_FCurve_RnaPath_set(PointerRNA *ptr, const char *value)
181 {
182         FCurve *fcu= (FCurve *)ptr->data;
183
184         if (fcu->rna_path)
185                 MEM_freeN(fcu->rna_path);
186         
187         if (strlen(value))
188                 fcu->rna_path= BLI_strdup(value);
189         else 
190                 fcu->rna_path= NULL;
191 }
192
193 DriverTarget *rna_Driver_new_target(ChannelDriver *driver)
194 {
195         return driver_add_new_target(driver);
196 }
197
198 void rna_Driver_remove_target(ChannelDriver *driver, DriverTarget *dtar)
199 {
200         /* call the API function for this */
201         driver_free_target(driver, dtar);
202 }
203
204
205 static PointerRNA rna_FCurve_active_modifier_get(PointerRNA *ptr)
206 {
207         FCurve *fcu= (FCurve*)ptr->data;
208         FModifier *fcm= find_active_fmodifier(&fcu->modifiers);
209         return rna_pointer_inherit_refine(ptr, &RNA_FModifier, fcm);
210 }
211
212 static void rna_FCurve_active_modifier_set(PointerRNA *ptr, PointerRNA value)
213 {
214         FCurve *fcu= (FCurve*)ptr->data;
215         set_active_fmodifier(&fcu->modifiers, (FModifier *)value.data);
216 }
217
218 static FModifier *rna_FCurve_modifiers_new(FCurve *fcu, bContext *C, int type)
219 {
220         return add_fmodifier(&fcu->modifiers, type);
221 }
222
223 static int rna_FCurve_modifiers_remove(FCurve *fcu, bContext *C, int index)
224 {
225         return remove_fmodifier_index(&fcu->modifiers, index);
226 }
227
228 #else
229
230 static void rna_def_fmodifier_generator(BlenderRNA *brna)
231 {
232         StructRNA *srna;
233         PropertyRNA *prop;
234         
235         static EnumPropertyItem generator_mode_items[] = {
236                 {FCM_GENERATOR_POLYNOMIAL, "POLYNOMIAL", 0, "Expanded Polynomial", ""},
237                 {FCM_GENERATOR_POLYNOMIAL_FACTORISED, "POLYNOMIAL_FACTORISED", 0, "Factorised Polynomial", ""},
238                 {0, NULL, 0, NULL, NULL}};
239         
240         srna= RNA_def_struct(brna, "FModifierGenerator", "FModifier");
241         RNA_def_struct_ui_text(srna, "Generator F-Curve Modifier", "Deterministically generates values for the modified F-Curve.");
242         RNA_def_struct_sdna_from(srna, "FMod_Generator", "data");
243         
244         /* define common props */
245         prop= RNA_def_property(srna, "additive", PROP_BOOLEAN, PROP_NONE);
246         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
247         RNA_def_property_ui_text(prop, "Additive", "Values generated by this modifier are applied on top of the existing values instead of overwriting them.");
248         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
249         
250                 // XXX this has a special validation func
251         prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
252         RNA_def_property_enum_items(prop, generator_mode_items);
253         RNA_def_property_ui_text(prop, "Mode", "Type of generator to use.");
254         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
255         
256         
257         /* order of the polynomial */
258                 // XXX this has a special validation func
259         prop= RNA_def_property(srna, "poly_order", PROP_INT, PROP_NONE);
260         RNA_def_property_ui_text(prop, "Polynomial Order", "The highest power of 'x' for this polynomial. (number of coefficients - 1)");
261         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
262         
263         /* coefficients array */
264                 // FIXME: this is quite difficult to try to wrap
265         //prop= RNA_def_property(srna, "coefficients", PROP_COLLECTION, PROP_NONE);
266         //RNA_def_property_collection_funcs(prop, "rna_FModifierGenerator_coefficients_begin", "rna_FModifierGenerator_coefficients_next", "rna_FModifierGenerator_coefficients_end", "rna_iterator_array_get", "rna_FModifierGenerator_coefficients_length", 0, 0, 0, 0);
267         //RNA_def_property_ui_text(prop, "Coefficients", "Coefficients for 'x' (starting from lowest power of x^0).");
268 }
269
270 /* --------- */
271
272 static void rna_def_fmodifier_function_generator(BlenderRNA *brna)
273 {
274         StructRNA *srna;
275         PropertyRNA *prop;
276         
277         static EnumPropertyItem prop_type_items[] = {
278                 {0, "SIN", 0, "Sine", ""},
279                 {1, "COS", 0, "Cosine", ""},
280                 {2, "TAN", 0, "Tangent", ""},
281                 {3, "SQRT", 0, "Square Root", ""},
282                 {4, "LN", 0, "Natural Logarithm", ""},
283                 {5, "SINC", 0, "Normalised Sine", "sin(x) / x"},
284                 {0, NULL, 0, NULL, NULL}};
285         
286         srna= RNA_def_struct(brna, "FModifierFunctionGenerator", "FModifier");
287         RNA_def_struct_ui_text(srna, "Built-In Function F-Modifier", "Generates values using a Built-In Function.");
288         RNA_def_struct_sdna_from(srna, "FMod_FunctionGenerator", "data");
289         
290         /* coefficients */
291         prop= RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
292         RNA_def_property_ui_text(prop, "Amplitude", "Scale factor determining the maximum/minimum values.");
293         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
294         
295         prop= RNA_def_property(srna, "phase_multiplier", PROP_FLOAT, PROP_NONE);
296         RNA_def_property_ui_text(prop, "Phase Multiplier", "Scale factor determining the 'speed' of the function.");
297         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
298         
299         prop= RNA_def_property(srna, "phase_offset", PROP_FLOAT, PROP_NONE);
300         RNA_def_property_ui_text(prop, "Phase Offset", "Constant factor to offset time by for function.");
301         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
302         
303         prop= RNA_def_property(srna, "value_offset", PROP_FLOAT, PROP_NONE);
304         RNA_def_property_ui_text(prop, "Value Offset", "Constant factor to offset values by.");
305         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
306         
307         /* flags */
308         prop= RNA_def_property(srna, "additive", PROP_BOOLEAN, PROP_NONE);
309         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
310         RNA_def_property_ui_text(prop, "Additive", "Values generated by this modifier are applied on top of the existing values instead of overwriting them.");
311         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
312         
313         prop= RNA_def_property(srna, "function_type", PROP_ENUM, PROP_NONE);
314         RNA_def_property_enum_sdna(prop, NULL, "type");
315         RNA_def_property_enum_items(prop, prop_type_items);
316         RNA_def_property_ui_text(prop, "Type", "Type of built-in function to use.");
317         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
318 }
319
320 /* --------- */
321
322 static void rna_def_fmodifier_envelope_ctrl(BlenderRNA *brna)
323 {
324         StructRNA *srna;
325         PropertyRNA *prop;
326         
327         srna= RNA_def_struct(brna, "FModifierEnvelopeControlPoint", NULL);
328         RNA_def_struct_ui_text(srna, "Envelope Control Point", "Control point for envelope F-Modifier.");
329         RNA_def_struct_sdna(srna, "FCM_EnvelopeData");
330         
331         /* min/max extents 
332          *      - for now, these are allowed to go past each other, so that we can have inverted action
333          *      - technically, the range is limited by the settings in the envelope-modifier data, not here...
334          */
335         prop= RNA_def_property(srna, "minimum", PROP_FLOAT, PROP_NONE);
336         RNA_def_property_float_sdna(prop, NULL, "min");
337         RNA_def_property_ui_text(prop, "Minimum Value", "Lower bound of envelope at this control-point.");
338         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
339         
340         prop= RNA_def_property(srna, "maximum", PROP_FLOAT, PROP_NONE);
341         RNA_def_property_float_sdna(prop, NULL, "max");
342         RNA_def_property_ui_text(prop, "Maximum Value", "Upper bound of envelope at this control-point.");
343         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
344         
345         /* Frame */
346         prop= RNA_def_property(srna, "frame", PROP_FLOAT, PROP_TIME);
347         RNA_def_property_float_sdna(prop, NULL, "time");
348         RNA_def_property_ui_text(prop, "Frame", "Frame this control-point occurs on.");
349         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
350         
351         // TODO:
352         //      - selection flags (not implemented in UI yet though)
353 }
354
355 static void rna_def_fmodifier_envelope(BlenderRNA *brna)
356 {
357         StructRNA *srna;
358         PropertyRNA *prop;
359         
360         srna= RNA_def_struct(brna, "FModifierEnvelope", "FModifier");
361         RNA_def_struct_ui_text(srna, "Envelope F-Modifier", "Scales the values of the modified F-Curve.");
362         RNA_def_struct_sdna_from(srna, "FMod_Envelope", "data");
363         
364         /* Collections */
365         prop= RNA_def_property(srna, "control_points", PROP_COLLECTION, PROP_NONE);
366         RNA_def_property_collection_sdna(prop, NULL, "data", "totvert");
367         RNA_def_property_struct_type(prop, "FModifierEnvelopeControlPoint");
368         RNA_def_property_ui_text(prop, "Control Points", "Control points defining the shape of the envelope.");
369         
370         /* Range Settings */
371         prop= RNA_def_property(srna, "reference_value", PROP_FLOAT, PROP_NONE);
372         RNA_def_property_float_sdna(prop, NULL, "midval");
373         RNA_def_property_ui_text(prop, "Reference Value", "Value that envelope's influence is centered around / based on.");
374         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
375         
376         prop= RNA_def_property(srna, "default_minimum", PROP_FLOAT, PROP_NONE);
377         RNA_def_property_float_sdna(prop, NULL, "min");
378         RNA_def_property_ui_text(prop, "Default Minimum", "Lower distance from Reference Value for 1:1 default influence.");
379         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
380         
381         prop= RNA_def_property(srna, "default_maximum", PROP_FLOAT, PROP_NONE);
382         RNA_def_property_float_sdna(prop, NULL, "max");
383         RNA_def_property_ui_text(prop, "Default Maximum", "Upper distance from Reference Value for 1:1 default influence.");
384         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
385 }
386
387 /* --------- */
388
389 static void rna_def_fmodifier_cycles(BlenderRNA *brna)
390 {
391         StructRNA *srna;
392         PropertyRNA *prop;
393         
394         static EnumPropertyItem prop_type_items[] = {
395                 {FCM_EXTRAPOLATE_NONE, "NONE", 0, "No Cycles", "Don't do anything."},
396                 {FCM_EXTRAPOLATE_CYCLIC, "REPEAT", 0, "Repeat Motion", "Repeat keyframe range as-is."},
397                 {FCM_EXTRAPOLATE_CYCLIC_OFFSET, "REPEAT_OFFSET", 0, "Repeat with Offset", "Repeat keyframe range, but with offset based on gradient between values"},
398                 {FCM_EXTRAPOLATE_MIRROR, "MIRROR", 0, "Repeat Mirrored", "Alternate between forward and reverse playback of keyframe range"},
399                 {0, NULL, 0, NULL, NULL}};
400         
401         srna= RNA_def_struct(brna, "FModifierCycles", "FModifier");
402         RNA_def_struct_ui_text(srna, "Cycles F-Modifier", "Repeats the values of the modified F-Curve.");
403         RNA_def_struct_sdna_from(srna, "FMod_Cycles", "data");
404         
405         /* before */
406         prop= RNA_def_property(srna, "before_mode", PROP_ENUM, PROP_NONE);
407         RNA_def_property_enum_items(prop, prop_type_items);
408         RNA_def_property_ui_text(prop, "Before Mode", "Cycling mode to use before first keyframe.");
409         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
410         
411         prop= RNA_def_property(srna, "before_cycles", PROP_FLOAT, PROP_NONE);
412         RNA_def_property_ui_text(prop, "Before Cycles", "Maximum number of cycles to allow before first keyframe. (0 = infinite)");
413         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
414         
415         /* after */
416         prop= RNA_def_property(srna, "after_mode", PROP_ENUM, PROP_NONE);
417         RNA_def_property_enum_items(prop, prop_type_items);
418         RNA_def_property_ui_text(prop, "After Mode", "Cycling mode to use after last keyframe.");
419         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
420         
421         prop= RNA_def_property(srna, "after_cycles", PROP_FLOAT, PROP_NONE);
422         RNA_def_property_ui_text(prop, "After Cycles", "Maximum number of cycles to allow after last keyframe. (0 = infinite)");
423         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
424 }
425
426 /* --------- */
427
428 static void rna_def_fmodifier_python(BlenderRNA *brna)
429 {
430         StructRNA *srna;
431         //PropertyRNA *prop;
432         
433         srna= RNA_def_struct(brna, "FModifierPython", "FModifier");
434         RNA_def_struct_ui_text(srna, "Python F-Modifier", "Performs user-defined operation on the modified F-Curve.");
435         RNA_def_struct_sdna_from(srna, "FMod_Python", "data");
436 }
437
438 /* --------- */
439
440 static void rna_def_fmodifier_limits(BlenderRNA *brna)
441 {
442         StructRNA *srna;
443         PropertyRNA *prop;
444         
445         srna= RNA_def_struct(brna, "FModifierLimits", "FModifier");
446         RNA_def_struct_ui_text(srna, "Limits F-Modifier", "Limits the time/value ranges of the modified F-Curve.");
447         RNA_def_struct_sdna_from(srna, "FMod_Limits", "data");
448         
449         prop= RNA_def_property(srna, "use_minimum_x", PROP_BOOLEAN, PROP_NONE);
450         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMIN);
451         RNA_def_property_ui_text(prop, "Minimum X", "Use the minimum X value.");
452         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
453         
454         prop= RNA_def_property(srna, "use_minimum_y", PROP_BOOLEAN, PROP_NONE);
455         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMIN);
456         RNA_def_property_ui_text(prop, "Minimum Y", "Use the minimum Y value.");
457         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
458         
459         prop= RNA_def_property(srna, "use_maximum_x", PROP_BOOLEAN, PROP_NONE);
460         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMAX);
461         RNA_def_property_ui_text(prop, "Maximum X", "Use the maximum X value.");
462         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
463         
464         prop= RNA_def_property(srna, "use_maximum_y", PROP_BOOLEAN, PROP_NONE);
465         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMAX);
466         RNA_def_property_ui_text(prop, "Maximum Y", "Use the maximum Y value.");
467         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
468         
469         prop= RNA_def_property(srna, "minimum_x", PROP_FLOAT, PROP_NONE);
470         RNA_def_property_float_sdna(prop, NULL, "rect.xmin");
471         RNA_def_property_ui_text(prop, "Minimum X", "Lowest X value to allow.");
472         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
473         
474         prop= RNA_def_property(srna, "minimum_y", PROP_FLOAT, PROP_NONE);
475         RNA_def_property_float_sdna(prop, NULL, "rect.ymin");
476         RNA_def_property_ui_text(prop, "Minimum Y", "Lowest Y value to allow.");
477         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
478         
479         prop= RNA_def_property(srna, "maximum_x", PROP_FLOAT, PROP_NONE);
480         RNA_def_property_float_sdna(prop, NULL, "rect.xmax");
481         RNA_def_property_ui_text(prop, "Maximum X", "Highest X value to allow.");
482         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
483         
484         prop= RNA_def_property(srna, "maximum_y", PROP_FLOAT, PROP_NONE);
485         RNA_def_property_float_sdna(prop, NULL, "rect.ymax");
486         RNA_def_property_ui_text(prop, "Maximum Y", "Highest Y value to allow.");
487         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
488 }
489
490 /* --------- */
491
492 static void rna_def_fmodifier_noise(BlenderRNA *brna)
493 {
494         StructRNA *srna;
495         PropertyRNA *prop;
496         
497         static EnumPropertyItem prop_modification_items[] = {
498                 {FCM_NOISE_MODIF_REPLACE, "REPLACE", 0, "Replace", ""},
499                 {FCM_NOISE_MODIF_ADD, "ADD", 0, "Add", ""},
500                 {FCM_NOISE_MODIF_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
501                 {FCM_NOISE_MODIF_MULTIPLY, "MULTIPLY", 0, "Multiply", ""},
502                 {0, NULL, 0, NULL, NULL}};
503         
504         srna= RNA_def_struct(brna, "FModifierNoise", "FModifier");
505         RNA_def_struct_ui_text(srna, "Noise F-Modifier", "Gives randomness to the modified F-Curve.");
506         RNA_def_struct_sdna_from(srna, "FMod_Noise", "data");
507         
508         prop= RNA_def_property(srna, "modification", PROP_ENUM, PROP_NONE);
509         RNA_def_property_enum_items(prop, prop_modification_items);
510         RNA_def_property_ui_text(prop, "Modification", "Method of modifying the existing F-Curve.");
511         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
512         
513         prop= RNA_def_property(srna, "size", PROP_FLOAT, PROP_NONE);
514         RNA_def_property_float_sdna(prop, NULL, "size");
515         RNA_def_property_ui_text(prop, "Size", "Scaling (in time) of the noise");
516         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
517         
518         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
519         RNA_def_property_float_sdna(prop, NULL, "strength");
520         RNA_def_property_ui_text(prop, "Strength", "Amplitude of the noise - the amount that it modifies the underlying curve");
521         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
522         
523         prop= RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
524         RNA_def_property_float_sdna(prop, NULL, "phase");
525         RNA_def_property_ui_text(prop, "Phase", "A random seed for the noise effect");
526         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
527         
528         prop= RNA_def_property(srna, "depth", PROP_INT, PROP_NONE);
529         RNA_def_property_int_sdna(prop, NULL, "depth");
530         RNA_def_property_ui_text(prop, "Depth", "Amount of fine level detail present in the noise");
531         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
532
533 }
534
535
536 /* --------- */
537
538 static void rna_def_fmodifier(BlenderRNA *brna)
539 {
540         StructRNA *srna;
541         PropertyRNA *prop;
542         
543         /* base struct definition */
544         srna= RNA_def_struct(brna, "FModifier", NULL);
545         RNA_def_struct_refine_func(srna, "rna_FModifierType_refine");
546         RNA_def_struct_ui_text(srna, "F-Modifier", "Modifier for values of F-Curve.");
547         
548 #if 0 // XXX not used yet
549         /* name */
550         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
551         RNA_def_struct_name_property(srna, prop);
552         RNA_def_property_ui_text(prop, "Name", "Short description of F-Curve Modifier.");
553 #endif // XXX not used yet
554         
555         /* type */
556         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
557         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
558         RNA_def_property_enum_items(prop, fmodifier_type_items);
559         RNA_def_property_ui_text(prop, "Type", "F-Curve Modifier Type");
560         
561         /* settings */
562         prop= RNA_def_property(srna, "expanded", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_EXPANDED);
564         RNA_def_property_ui_text(prop, "Expanded", "F-Curve Modifier's panel is expanded in UI.");
565         
566         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
567         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
568         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_MUTED);
569         RNA_def_property_ui_text(prop, "Muted", "F-Curve Modifier will not be evaluated.");
570         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
571         
572                 // XXX this is really an internal flag, but it may be useful for some tools to be able to access this...
573         prop= RNA_def_property(srna, "disabled", PROP_BOOLEAN, PROP_NONE);
574         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
575         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_DISABLED);
576         RNA_def_property_ui_text(prop, "Disabled", "F-Curve Modifier has invalid settings and will not be evaluated.");
577         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
578         
579                 // TODO: setting this to true must ensure that all others in stack are turned off too...
580         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
581         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_ACTIVE);
582         RNA_def_property_ui_text(prop, "Active", "F-Curve Modifier is the one being edited ");
583         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
584 }       
585
586 /* *********************** */
587
588 static void rna_def_drivertarget(BlenderRNA *brna)
589 {
590         StructRNA *srna;
591         PropertyRNA *prop;
592         
593         srna= RNA_def_struct(brna, "DriverTarget", NULL);
594         RNA_def_struct_ui_text(srna, "Driver Target", "Variable from some source/target for driver relationship.");
595         
596         /* Variable Name */
597         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
598         RNA_def_struct_name_property(srna, prop);
599         RNA_def_property_ui_text(prop, "Name", "Name to use in scripted expressions/functions. (No spaces or dots are allowed. Also, must not start with a symbol or digit)");
600         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
601         
602         /* Target Properties - ID-block to Drive */
603         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
604         RNA_def_property_struct_type(prop, "ID");
605         RNA_def_property_flag(prop, PROP_EDITABLE);
606         RNA_def_property_editable_func(prop, "rna_DriverTarget_id_editable");
607         RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_DriverTarget_id_typef");
608         RNA_def_property_ui_text(prop, "ID", "ID-block that the specific property used can be found from");
609         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
610         
611         prop= RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
612         RNA_def_property_enum_sdna(prop, NULL, "idtype");
613         RNA_def_property_enum_items(prop, id_type_items);
614         RNA_def_property_enum_default(prop, ID_OB);
615         RNA_def_property_enum_funcs(prop, NULL, "rna_DriverTarget_id_type_set", NULL);
616         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used.");
617         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
618         
619         /* Target Properties - Property to Drive */
620         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
621         RNA_def_property_string_funcs(prop, "rna_DriverTarget_RnaPath_get", "rna_DriverTarget_RnaPath_length", "rna_DriverTarget_RnaPath_set");
622         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path (from Object) to property used");
623         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
624         
625         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
626         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific property used (if applicable)");
627         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
628 }
629
630
631 /* channeldriver.targets.* */
632 static void rna_def_channeldriver_targets(BlenderRNA *brna, PropertyRNA *cprop)
633 {
634         StructRNA *srna;
635 //      PropertyRNA *prop;
636
637         FunctionRNA *func;
638         PropertyRNA *parm;
639
640         RNA_def_property_srna(cprop, "ChannelDriverTargets");
641         srna= RNA_def_struct(brna, "ChannelDriverTargets", NULL);
642         RNA_def_struct_sdna(srna, "ChannelDriver");
643         RNA_def_struct_ui_text(srna, "ChannelDriver Targets", "Collection of channel driver Targets.");
644
645
646         /* add target */
647         func= RNA_def_function(srna, "new", "rna_Driver_new_target");
648         RNA_def_function_ui_description(func, "Add a new target for the driver.");
649                 /* return type */
650         parm= RNA_def_pointer(func, "target", "DriverTarget", "", "Newly created Driver Target.");
651                 RNA_def_function_return(func, parm);
652
653         /* remove target */
654         func= RNA_def_function(srna, "remove", "rna_Driver_remove_target");
655                 RNA_def_function_ui_description(func, "Remove an existing target from the driver.");
656                 /* target to remove*/
657         parm= RNA_def_pointer(func, "target", "DriverTarget", "", "Target to remove from the driver.");
658                 RNA_def_property_flag(parm, PROP_REQUIRED);
659
660 }
661
662 static void rna_def_channeldriver(BlenderRNA *brna)
663 {
664         StructRNA *srna;
665         PropertyRNA *prop;
666         
667         static EnumPropertyItem prop_type_items[] = {
668                 {DRIVER_TYPE_AVERAGE, "AVERAGE", 0, "Averaged Value", ""},
669                 {DRIVER_TYPE_PYTHON, "SCRIPTED", 0, "Scripted Expression", ""},
670                 {DRIVER_TYPE_ROTDIFF, "ROTDIFF", 0, "Rotational Difference", ""},
671                 {0, NULL, 0, NULL, NULL}};
672
673         srna= RNA_def_struct(brna, "Driver", NULL);
674         RNA_def_struct_sdna(srna, "ChannelDriver");
675         RNA_def_struct_ui_text(srna, "Driver", "Driver for the value of a setting based on an external value.");
676
677         /* Enums */
678         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
679         RNA_def_property_enum_items(prop, prop_type_items);
680         RNA_def_property_ui_text(prop, "Type", "Driver types.");
681         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data");
682
683         /* String values */
684         prop= RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
685         RNA_def_property_ui_text(prop, "Expression", "Expression to use for Scripted Expression.");
686         //RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX disabled for now, until we can turn off auto updates
687
688         /* Collections */
689         prop= RNA_def_property(srna, "targets", PROP_COLLECTION, PROP_NONE);
690         RNA_def_property_collection_sdna(prop, NULL, "targets", NULL);
691         RNA_def_property_struct_type(prop, "DriverTarget");
692         RNA_def_property_ui_text(prop, "Target Variables", "Properties acting as targets for this driver.");
693         rna_def_channeldriver_targets(brna, prop);
694         
695         /* Functions */
696         RNA_api_drivers(srna);
697 }
698
699 /* *********************** */
700
701 static void rna_def_fpoint(BlenderRNA *brna)
702 {
703         StructRNA *srna;
704         PropertyRNA *prop;
705         
706         srna= RNA_def_struct(brna, "FCurveSample", NULL);
707         RNA_def_struct_sdna(srna, "FPoint");
708         RNA_def_struct_ui_text(srna, "F-Curve Sample", "Sample point for F-Curve.");
709         
710         /* Boolean values */
711         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
712         RNA_def_property_boolean_sdna(prop, NULL, "flag", 1);
713         RNA_def_property_ui_text(prop, "Selected", "Selection status");
714         
715         /* Vector value */
716         prop= RNA_def_property(srna, "point", PROP_FLOAT, PROP_XYZ);
717         RNA_def_property_array(prop, 2);
718         RNA_def_property_float_sdna(prop, NULL, "vec");
719         RNA_def_property_ui_text(prop, "Point", "Point coordinates");
720 }
721
722 /* channeldriver.targets.* */
723 static void rna_def_fcurve_modifiers(BlenderRNA *brna, PropertyRNA *cprop)
724 {
725         /* add target */
726         StructRNA *srna;
727         PropertyRNA *prop;
728
729         FunctionRNA *func;
730         PropertyRNA *parm;
731
732         RNA_def_property_srna(cprop, "FCurveModifiers");
733         srna= RNA_def_struct(brna, "FCurveModifiers", NULL);
734         RNA_def_struct_sdna(srna, "FCurve");
735         RNA_def_struct_ui_text(srna, "FCurve Modifiers", "Collection of fcurve modifiers.");
736
737
738         /* Collection active property */
739         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
740         RNA_def_property_struct_type(prop, "FModifier");
741         RNA_def_property_pointer_funcs(prop, "rna_FCurve_active_modifier_get", "rna_FCurve_active_modifier_set", NULL);
742         RNA_def_property_flag(prop, PROP_EDITABLE);
743         RNA_def_property_ui_text(prop, "Active fcurve modifier", "Active fcurve modifier.");
744
745
746         /* Constraint collection */
747         func= RNA_def_function(srna, "new", "rna_FCurve_modifiers_new");
748         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
749         RNA_def_function_ui_description(func, "Add a constraint to this object");
750         /* return type */
751         parm= RNA_def_pointer(func, "fmodifier", "FModifier", "", "New fmodifier.");
752         RNA_def_function_return(func, parm);
753         /* object to add */
754         parm= RNA_def_enum(func, "type", fmodifier_type_items, 1, "", "Constraint type to add.");
755         RNA_def_property_flag(parm, PROP_REQUIRED);
756
757         func= RNA_def_function(srna, "remove", "rna_FCurve_modifiers_remove");
758         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
759         RNA_def_function_ui_description(func, "Remove a modifier from this fcurve.");
760         /* return type */
761         parm= RNA_def_boolean(func, "success", 0, "Success", "Removed the constraint successfully.");
762         RNA_def_function_return(func, parm);
763         /* object to add */
764         parm= RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "", 0, INT_MAX);
765         RNA_def_property_flag(parm, PROP_REQUIRED);
766 }
767
768 static void rna_def_fcurve(BlenderRNA *brna)
769 {
770         StructRNA *srna;
771         PropertyRNA *prop;
772         
773         static EnumPropertyItem prop_mode_extend_items[] = {
774                 {FCURVE_EXTRAPOLATE_CONSTANT, "CONSTANT", 0, "Constant", ""},
775                 {FCURVE_EXTRAPOLATE_LINEAR, "LINEAR", 0, "Linear", ""},
776                 {0, NULL, 0, NULL, NULL}};
777         static EnumPropertyItem prop_mode_color_items[] = {
778                 {FCURVE_COLOR_AUTO_RAINBOW, "AUTO_RAINBOW", 0, "Auto Rainbow", ""},
779                 {FCURVE_COLOR_AUTO_RGB, "AUTO_RGB", 0, "Auto XYZ to RGB", ""},
780                 {FCURVE_COLOR_CUSTOM, "CUSTOM", 0, "User Defined", ""},
781                 {0, NULL, 0, NULL, NULL}};
782
783         srna= RNA_def_struct(brna, "FCurve", NULL);
784         RNA_def_struct_ui_text(srna, "F-Curve", "F-Curve defining values of a period of time.");
785         RNA_def_struct_ui_icon(srna, ICON_ANIM_DATA);
786
787         /* Enums */
788         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
789         RNA_def_property_enum_sdna(prop, NULL, "extend");
790         RNA_def_property_enum_items(prop, prop_mode_extend_items);
791         RNA_def_property_ui_text(prop, "Extrapolation", "");
792
793         /* Pointers */
794         prop= RNA_def_property(srna, "driver", PROP_POINTER, PROP_NONE);
795         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
796         RNA_def_property_ui_text(prop, "Driver", "Channel Driver (only set for Driver F-Curves)");
797         
798         /* Path + Array Index */
799         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
800         RNA_def_property_string_funcs(prop, "rna_FCurve_RnaPath_get", "rna_FCurve_RnaPath_length", "rna_FCurve_RnaPath_set");
801         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property affected by F-Curve.");
802         
803         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
804         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific property affected by F-Curve if applicable.");
805         
806         /* Color */
807         prop= RNA_def_property(srna, "color_mode", PROP_ENUM, PROP_NONE);
808         RNA_def_property_enum_items(prop, prop_mode_color_items);
809         RNA_def_property_ui_text(prop, "Color Mode", "Method used to determine color of F-Curve in Graph Editor.");
810         
811         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
812         RNA_def_property_array(prop, 3);
813         RNA_def_property_ui_text(prop, "Color", "Color of the F-Curve in the Graph Editor.");
814         
815         /* Collections */
816         prop= RNA_def_property(srna, "sampled_points", PROP_COLLECTION, PROP_NONE);
817         RNA_def_property_collection_sdna(prop, NULL, "fpt", "totvert");
818         RNA_def_property_struct_type(prop, "FCurveSample");
819         RNA_def_property_ui_text(prop, "Sampled Points", "Sampled animation data");
820
821         prop= RNA_def_property(srna, "keyframe_points", PROP_COLLECTION, PROP_NONE);
822         RNA_def_property_collection_sdna(prop, NULL, "bezt", "totvert");
823         RNA_def_property_struct_type(prop, "BezierCurvePoint");
824         RNA_def_property_ui_text(prop, "Keyframes", "User-editable keyframes");
825         
826         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
827         RNA_def_property_struct_type(prop, "FModifier");
828         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the shape of the F-Curve.");
829
830         rna_def_fcurve_modifiers(brna, prop);
831 }
832
833 /* *********************** */
834
835 void RNA_def_fcurve(BlenderRNA *brna)
836 {
837         rna_def_fcurve(brna);
838         rna_def_fpoint(brna);
839         
840         rna_def_drivertarget(brna);
841         rna_def_channeldriver(brna);
842         
843         rna_def_fmodifier(brna);
844         
845         rna_def_fmodifier_generator(brna);
846         rna_def_fmodifier_function_generator(brna);
847         rna_def_fmodifier_envelope(brna);
848                 rna_def_fmodifier_envelope_ctrl(brna);
849         rna_def_fmodifier_cycles(brna);
850         rna_def_fmodifier_python(brna);
851         rna_def_fmodifier_limits(brna);
852         rna_def_fmodifier_noise(brna);
853 }
854
855
856 #endif