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