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