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