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