UI:
[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_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_anim_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "MEM_guardedalloc.h"
36
37 EnumPropertyItem fmodifier_type_items[] = {
38         {FMODIFIER_TYPE_NULL, "NULL", "Invalid", ""},
39         {FMODIFIER_TYPE_GENERATOR, "GENERATOR", "Generator", ""},
40         {FMODIFIER_TYPE_ENVELOPE, "ENVELOPE", "Envelope", ""},
41         {FMODIFIER_TYPE_CYCLES, "CYCLES", "Cycles", ""},
42         {FMODIFIER_TYPE_NOISE, "NOISE", "Noise", ""},
43         {FMODIFIER_TYPE_FILTER, "FILTER", "Filter", ""},
44         {FMODIFIER_TYPE_PYTHON, "PYTHON", "Python", ""},
45         {FMODIFIER_TYPE_LIMITS, "LIMITS", "Limits", ""},
46         {0, NULL, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 float FModGenFunc_amplitude_get(PointerRNA *ptr)
51 {
52         FModifier *fcm = (FModifier *)(ptr->data);
53         FMod_Generator *data= (FMod_Generator*)(fcm->data);
54         return (data->coefficients) ? (float)data->coefficients[0] : 1.0f;
55 }
56
57 void FModGenFunc_amplitude_set(PointerRNA *ptr, float value)
58 {
59         FModifier *fcm = (FModifier *)(ptr->data);
60         FMod_Generator *data= (FMod_Generator*)(fcm->data);
61         if (data->coefficients) data->coefficients[0]= value;
62 }
63
64 float FModGenFunc_pre_multiplier_get(PointerRNA *ptr)
65 {
66         FModifier *fcm = (FModifier *)(ptr->data);
67         FMod_Generator *data= (FMod_Generator*)(fcm->data);
68         return (data->coefficients) ? (float)data->coefficients[1] : 1.0f;
69 }
70
71 void FModGenFunc_pre_multiplier_set(PointerRNA *ptr, float value)
72 {
73         FModifier *fcm = (FModifier *)(ptr->data);
74         FMod_Generator *data= (FMod_Generator*)(fcm->data);
75         if (data->coefficients) data->coefficients[1]= value;
76 }
77
78 float FModGenFunc_x_offset_get(PointerRNA *ptr)
79 {
80         FModifier *fcm = (FModifier *)(ptr->data);
81         FMod_Generator *data= (FMod_Generator*)(fcm->data);
82         return (data->coefficients) ? (float)data->coefficients[2] : 0.0f;
83 }
84
85 void FModGenFunc_x_offset_set(PointerRNA *ptr, float value)
86 {
87         FModifier *fcm = (FModifier *)(ptr->data);
88         FMod_Generator *data= (FMod_Generator*)(fcm->data);
89         if (data->coefficients) data->coefficients[2]= value;
90 }
91
92 float FModGenFunc_y_offset_get(PointerRNA *ptr)
93 {
94         FModifier *fcm = (FModifier *)(ptr->data);
95         FMod_Generator *data= (FMod_Generator*)(fcm->data);
96         return (data->coefficients) ? (float)data->coefficients[3] : 0.0f;
97 }
98
99 void FModGenFunc_y_offset_set(PointerRNA *ptr, float value)
100 {
101         FModifier *fcm = (FModifier *)(ptr->data);
102         FMod_Generator *data= (FMod_Generator*)(fcm->data);
103         if (data->coefficients) data->coefficients[3]= value;
104 }
105
106 /* --------- */
107
108 StructRNA *rna_FModifierType_refine(struct PointerRNA *ptr)
109 {
110         FModifier *fcm= (FModifier *)ptr->data;
111
112         switch (fcm->type) {
113                 case FMODIFIER_TYPE_GENERATOR:
114                 {
115                         FMod_Generator *gen= (FMod_Generator *)fcm->data;
116                         
117                         switch (gen->mode) {
118                                 case FCM_GENERATOR_POLYNOMIAL:
119                                         return &RNA_FModifierGenerator_PolyExpanded;
120                                 //case FCM_GENERATOR_POLYNOMIAL_FACTORISED:
121                                 case FCM_GENERATOR_FUNCTION:
122                                         return &RNA_FModifierGenerator_Function;
123                                 //case FCM_GENERATOR_EXPRESSION:
124                                 default:
125                                         return &RNA_FModifierGenerator;
126                         }
127                 }
128                 case FMODIFIER_TYPE_ENVELOPE:
129                         return &RNA_FModifierEnvelope;
130                 case FMODIFIER_TYPE_CYCLES:
131                         return &RNA_FModifierCycles;
132                 case FMODIFIER_TYPE_NOISE:
133                         return &RNA_FModifierNoise;
134                 //case FMODIFIER_TYPE_FILTER:
135                 //      return &RNA_FModifierFilter;
136                 case FMODIFIER_TYPE_PYTHON:
137                         return &RNA_FModifierPython;
138                 case FMODIFIER_TYPE_LIMITS:
139                         return &RNA_FModifierLimits;
140                 default:
141                         return &RNA_UnknownType;
142         }
143 }
144
145 /* ****************************** */
146
147 static void rna_DriverTarget_RnaPath_get(PointerRNA *ptr, char *value)
148 {
149         DriverTarget *dtar= (DriverTarget *)ptr->data;
150
151         if (dtar->rna_path)
152                 strcpy(value, dtar->rna_path);
153         else
154                 strcpy(value, "");
155 }
156
157 static int rna_DriverTarget_RnaPath_length(PointerRNA *ptr)
158 {
159         DriverTarget *dtar= (DriverTarget *)ptr->data;
160         
161         if (dtar->rna_path)
162                 return strlen(dtar->rna_path);
163         else
164                 return 0;
165 }
166
167 static void rna_DriverTarget_RnaPath_set(PointerRNA *ptr, const char *value)
168 {
169         DriverTarget *dtar= (DriverTarget *)ptr->data;
170         
171         // XXX in this case we need to be very careful, as this will require some new dependencies to be added!
172         if (dtar->rna_path)
173                 MEM_freeN(dtar->rna_path);
174         
175         if (strlen(value))
176                 dtar->rna_path= BLI_strdup(value);
177         else 
178                 dtar->rna_path= NULL;
179 }
180
181 /* ****************************** */
182
183 static void rna_FCurve_RnaPath_get(PointerRNA *ptr, char *value)
184 {
185         FCurve *fcu= (FCurve *)ptr->data;
186
187         if (fcu->rna_path)
188                 strcpy(value, fcu->rna_path);
189         else
190                 strcpy(value, "");
191 }
192
193 static int rna_FCurve_RnaPath_length(PointerRNA *ptr)
194 {
195         FCurve *fcu= (FCurve *)ptr->data;
196         
197         if (fcu->rna_path)
198                 return strlen(fcu->rna_path);
199         else
200                 return 0;
201 }
202
203 static void rna_FCurve_RnaPath_set(PointerRNA *ptr, const char *value)
204 {
205         FCurve *fcu= (FCurve *)ptr->data;
206
207         if (fcu->rna_path)
208                 MEM_freeN(fcu->rna_path);
209         
210         if (strlen(value))
211                 fcu->rna_path= BLI_strdup(value);
212         else 
213                 fcu->rna_path= NULL;
214 }
215
216 #else
217
218 static void rna_def_fmodifier_generator_common(StructRNA *srna)
219 {
220         PropertyRNA *prop;
221         
222         static EnumPropertyItem prop_mode_items[] = {
223                 {FCM_GENERATOR_POLYNOMIAL, "POLYNOMIAL", "Expanded Polynomial", ""},
224                 {FCM_GENERATOR_POLYNOMIAL_FACTORISED, "POLYNOMIAL_FACTORISED", "Factorised Polynomial", ""},
225                 {FCM_GENERATOR_FUNCTION, "FUNCTION", "Built-In Function", ""},
226                 {FCM_GENERATOR_EXPRESSION, "EXPRESSION", "Expression", ""},
227                 {0, NULL, NULL, NULL}};
228                 
229         /* struct wrapping settings */
230         RNA_def_struct_sdna_from(srna, "FMod_Generator", "data");       
231         
232         /* settings */
233         prop= RNA_def_property(srna, "additive", PROP_BOOLEAN, PROP_NONE);
234         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
235         RNA_def_property_ui_text(prop, "Additive", "Values generated by this modifier are applied on top of the existing values instead of overwriting them.");
236         
237                 // XXX this has a special validation func
238         prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
239         RNA_def_property_enum_items(prop, prop_mode_items);
240         RNA_def_property_ui_text(prop, "Mode", "Type of generator to use.");
241 }
242
243 /* this is a temporary dummy generator-modifier wrapping (to be discarded) */
244 static void rna_def_fmodifier_generator(BlenderRNA *brna)
245 {
246         StructRNA *srna;
247         
248         srna= RNA_def_struct(brna, "FModifierGenerator", "FModifier");
249         RNA_def_struct_ui_text(srna, "Generator F-Curve Modifier", "Deterministically generates values for the modified F-Curve.");
250         
251         /* define common props */
252         rna_def_fmodifier_generator_common(srna);
253 }
254
255 static void rna_def_fmodifier_generator_polyexpanded(BlenderRNA *brna)
256 {
257         StructRNA *srna;
258         PropertyRNA *prop;
259         
260         srna= RNA_def_struct(brna, "FModifierGenerator_PolyExpanded", "FModifier");
261         RNA_def_struct_ui_text(srna, "Expanded Polynomial Generator", "Generates values for the modified F-Curve using expanded polynomial expresion.");
262         
263         /* define common props */
264         rna_def_fmodifier_generator_common(srna);
265         
266         /* order of the polynomial */
267                 // XXX this has a special validation func
268         prop= RNA_def_property(srna, "poly_order", PROP_INT, PROP_NONE);
269         RNA_def_property_ui_text(prop, "Polynomial Order", "The highest power of 'x' for this polynomial. (i.e. the number of coefficients - 1)");
270         
271         /* coefficients array */
272         //prop= RNA_def_property(srna, "coefficients", PROP_FLOAT, PROP_NONE);
273         //RNA_def_property_ui_text(prop, "Coefficients", "Coefficients for 'x' (starting from lowest power).");
274 }
275
276 static void rna_def_fmodifier_generator_function(BlenderRNA *brna)
277 {
278         StructRNA *srna;
279         PropertyRNA *prop;
280         
281         static EnumPropertyItem prop_type_items[] = {
282                 {0, "SIN", "Sine", ""},
283                 {1, "COS", "Cosine", ""},
284                 {2, "TAN", "Tangent", ""},
285                 {3, "SQRT", "Square Root", ""},
286                 {4, "LN", "Natural Logarithm", ""},
287                 {0, NULL, NULL, NULL}};
288                 
289         
290         srna= RNA_def_struct(brna, "FModifierGenerator_Function", "FModifier");
291         RNA_def_struct_ui_text(srna, "Built-In Function Generator", "Generates values for modified F-Curve using Built-In Function.");
292         
293         /* common settings */
294         rna_def_fmodifier_generator_common(srna);
295         
296         /* type */
297         prop= RNA_def_property(srna, "func_type", PROP_ENUM, PROP_NONE);
298         RNA_def_property_enum_items(prop, prop_type_items);
299         RNA_def_property_ui_text(prop, "Type", "Type of Built-In function to use as generator.");
300         
301         /* coefficients */
302         prop= RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
303         RNA_def_property_float_funcs(prop, "FModGenFunc_amplitude_get", "FModGenFunc_amplitude_set", NULL);
304         RNA_def_property_ui_text(prop, "Amplitude", "Scale factor for y-values generated by the function.");
305         
306         prop= RNA_def_property(srna, "pre_multiplier", PROP_FLOAT, PROP_NONE);
307         RNA_def_property_float_funcs(prop, "FModGenFunc_pre_multiplier_get", "FModGenFunc_pre_multiplier_set", NULL);
308         RNA_def_property_ui_text(prop, "PreMultiplier", "Scale factor for x-value inputs to function.");
309         
310         prop= RNA_def_property(srna, "x_offset", PROP_FLOAT, PROP_NONE);
311         RNA_def_property_float_funcs(prop, "FModGenFunc_x_offset_get", "FModGenFunc_x_offset_set", NULL);
312         RNA_def_property_ui_text(prop, "X Offset", "Offset for x-value inputs to function.");
313         
314         prop= RNA_def_property(srna, "y_offset", PROP_FLOAT, PROP_NONE);
315         RNA_def_property_float_funcs(prop, "FModGenFunc_y_offset_get", "FModGenFunc_y_offset_set", NULL);
316         RNA_def_property_ui_text(prop, "Y Offset", "Offset for y-values generated by the function.");
317 }
318
319 /* --------- */
320
321 static void rna_def_fmodifier_envelope(BlenderRNA *brna)
322 {
323         StructRNA *srna;
324         //PropertyRNA *prop;
325         
326         srna= RNA_def_struct(brna, "FModifierEnvelope", "FModifier");
327         RNA_def_struct_ui_text(srna, "Envelope F-Curve Modifier", "Scales the values of the modified F-Curve.");
328         RNA_def_struct_sdna_from(srna, "FMod_Envelope", "data");
329 }
330
331 /* --------- */
332
333 static void rna_def_fmodifier_cycles(BlenderRNA *brna)
334 {
335         StructRNA *srna;
336         PropertyRNA *prop;
337         
338         static EnumPropertyItem prop_type_items[] = {
339                 {FCM_EXTRAPOLATE_NONE, "NONE", "No Cycles", "Don't do anything."},
340                 {FCM_EXTRAPOLATE_CYCLIC, "REPEAT", "Repeat Motion", "Repeat keyframe range as-is."},
341                 {FCM_EXTRAPOLATE_CYCLIC_OFFSET, "REPEAT_OFFSET", "Repeat with Offset", "Repeat keyframe range, but with offset based on gradient between values"},
342                 {FCM_EXTRAPOLATE_MIRROR, "MIRROR", "Repeat Mirrored", "Alternate between forward and reverse playback of keyframe range"},
343                 {0, NULL, NULL, NULL}};
344         
345         srna= RNA_def_struct(brna, "FModifierCycles", "FModifier");
346         RNA_def_struct_ui_text(srna, "Cycles F-Curve Modifier", "Repeats the values of the modified F-Curve.");
347         RNA_def_struct_sdna_from(srna, "FMod_Cycles", "data");
348         
349         /* before */
350         prop= RNA_def_property(srna, "before_mode", PROP_ENUM, PROP_NONE);
351         RNA_def_property_enum_items(prop, prop_type_items);
352         RNA_def_property_ui_text(prop, "Before Mode", "Cycling mode to use before first keyframe.");
353         
354         prop= RNA_def_property(srna, "before_cycles", PROP_FLOAT, PROP_NONE);
355         RNA_def_property_ui_text(prop, "Before Cycles", "Maximum number of cycles to allow before first keyframe. (0 = infinite)");
356         
357         
358         /* after */
359         prop= RNA_def_property(srna, "after_mode", PROP_ENUM, PROP_NONE);
360         RNA_def_property_enum_items(prop, prop_type_items);
361         RNA_def_property_ui_text(prop, "After Mode", "Cycling mode to use after last keyframe.");
362         
363         prop= RNA_def_property(srna, "after_cycles", PROP_FLOAT, PROP_NONE);
364         RNA_def_property_ui_text(prop, "After Cycles", "Maximum number of cycles to allow after last keyframe. (0 = infinite)");
365 }
366
367 /* --------- */
368
369 static void rna_def_fmodifier_python(BlenderRNA *brna)
370 {
371         StructRNA *srna;
372         //PropertyRNA *prop;
373         
374         srna= RNA_def_struct(brna, "FModifierPython", "FModifier");
375         RNA_def_struct_ui_text(srna, "Python F-Curve Modifier", "Performs user-defined operation on the modified F-Curve.");
376         RNA_def_struct_sdna_from(srna, "FMod_Python", "data");
377 }
378
379 /* --------- */
380
381 static void rna_def_fmodifier_limits(BlenderRNA *brna)
382 {
383         StructRNA *srna;
384         PropertyRNA *prop;
385         
386         srna= RNA_def_struct(brna, "FModifierLimits", "FModifier");
387         RNA_def_struct_ui_text(srna, "Limits F-Curve Modifier", "Limits the time/value ranges of the modified F-Curve.");
388         RNA_def_struct_sdna_from(srna, "FMod_Limits", "data");
389         
390         prop= RNA_def_property(srna, "use_minimum_x", PROP_BOOLEAN, PROP_NONE);
391         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMIN);
392         RNA_def_property_ui_text(prop, "Minimum X", "Use the minimum X value.");
393         
394         prop= RNA_def_property(srna, "use_minimum_y", PROP_BOOLEAN, PROP_NONE);
395         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMIN);
396         RNA_def_property_ui_text(prop, "Minimum Y", "Use the minimum Y value.");
397         
398         prop= RNA_def_property(srna, "use_maximum_x", PROP_BOOLEAN, PROP_NONE);
399         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMAX);
400         RNA_def_property_ui_text(prop, "Maximum X", "Use the maximum X value.");
401         
402         prop= RNA_def_property(srna, "use_maximum_y", PROP_BOOLEAN, PROP_NONE);
403         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMAX);
404         RNA_def_property_ui_text(prop, "Maximum Y", "Use the maximum Y value.");
405         
406         prop= RNA_def_property(srna, "minimum_x", PROP_FLOAT, PROP_NONE);
407         RNA_def_property_float_sdna(prop, NULL, "rect.xmin");
408         RNA_def_property_ui_text(prop, "Minimum X", "Lowest X value to allow.");
409         
410         prop= RNA_def_property(srna, "minimum_y", PROP_FLOAT, PROP_NONE);
411         RNA_def_property_float_sdna(prop, NULL, "rect.ymin");
412         RNA_def_property_ui_text(prop, "Minimum Y", "Lowest Y value to allow.");
413         
414         prop= RNA_def_property(srna, "maximum_x", PROP_FLOAT, PROP_NONE);
415         RNA_def_property_float_sdna(prop, NULL, "rect.xmax");
416         RNA_def_property_ui_text(prop, "Maximum X", "Highest X value to allow.");
417         
418         prop= RNA_def_property(srna, "maximum_y", PROP_FLOAT, PROP_NONE);
419         RNA_def_property_float_sdna(prop, NULL, "rect.ymax");
420         RNA_def_property_ui_text(prop, "Maximum Y", "Highest Y value to allow.");
421 }
422
423 /* --------- */
424
425 static void rna_def_fmodifier_noise(BlenderRNA *brna)
426 {
427         StructRNA *srna;
428         PropertyRNA *prop;
429         
430         static EnumPropertyItem prop_modification_items[] = {
431                 {FCM_NOISE_MODIF_REPLACE, "REPLACE", "Replace", ""},
432                 {FCM_NOISE_MODIF_ADD, "ADD", "Add", ""},
433                 {FCM_NOISE_MODIF_SUBTRACT, "SUBTRACT", "Subtract", ""},
434                 {FCM_NOISE_MODIF_MULTIPLY, "MULTIPLY", "Multiply", ""},
435                 {0, NULL, NULL, NULL}};
436         
437         srna= RNA_def_struct(brna, "FModifierNoise", "FModifier");
438         RNA_def_struct_ui_text(srna, "Noise F-Curve Modifier", "Gives randomness to the modified F-Curve.");
439         RNA_def_struct_sdna_from(srna, "FMod_Noise", "data");
440         
441         prop= RNA_def_property(srna, "modification", PROP_ENUM, PROP_NONE);
442         RNA_def_property_enum_items(prop, prop_modification_items);
443         RNA_def_property_ui_text(prop, "Modification", "Method of modifying the existing F-Curve.");
444         
445         prop= RNA_def_property(srna, "size", PROP_FLOAT, PROP_NONE);
446         RNA_def_property_float_sdna(prop, NULL, "size");
447         RNA_def_property_ui_text(prop, "Size", "Scaling (in time) of the noise");
448         
449         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
450         RNA_def_property_float_sdna(prop, NULL, "strength");
451         RNA_def_property_ui_text(prop, "Strength", "Amplitude of the noise - the amount that it modifies the underlying curve");
452         
453         prop= RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
454         RNA_def_property_float_sdna(prop, NULL, "phase");
455         RNA_def_property_ui_text(prop, "Phase", "A random seed for the noise effect");
456         
457         prop= RNA_def_property(srna, "depth", PROP_INT, PROP_NONE);
458         RNA_def_property_int_sdna(prop, NULL, "depth");
459         RNA_def_property_ui_text(prop, "Depth", "Amount of fine level detail present in the noise");
460
461 }
462
463
464 /* --------- */
465
466 void rna_def_fmodifier(BlenderRNA *brna)
467 {
468         StructRNA *srna;
469         PropertyRNA *prop;
470         
471         /* base struct definition */
472         srna= RNA_def_struct(brna, "FModifier", NULL);
473         RNA_def_struct_refine_func(srna, "rna_FModifierType_refine");
474         RNA_def_struct_ui_text(srna, "FCurve Modifier", "Modifier for values of F-Curve.");
475         
476 #if 0 // XXX not used yet
477         /* name */
478         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
479         RNA_def_struct_name_property(srna, prop);
480         RNA_def_property_ui_text(prop, "Name", "Short description of F-Curve Modifier.");
481 #endif // XXX not used yet
482         
483         /* type */
484         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
485         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
486         RNA_def_property_enum_items(prop, fmodifier_type_items);
487         RNA_def_property_ui_text(prop, "Type", "F-Curve Modifier Type");
488         
489         /* settings */
490         prop= RNA_def_property(srna, "expanded", PROP_BOOLEAN, PROP_NONE);
491         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_EXPANDED);
492         RNA_def_property_ui_text(prop, "Expanded", "F-Curve Modifier's panel is expanded in UI.");
493         
494         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
495         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
496         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_MUTED);
497         RNA_def_property_ui_text(prop, "Muted", "F-Curve Modifier will not be evaluated.");
498         
499                 // XXX this is really an internal flag, but it may be useful for some tools to be able to access this...
500         prop= RNA_def_property(srna, "disabled", PROP_BOOLEAN, PROP_NONE);
501         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
502         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_DISABLED);
503         RNA_def_property_ui_text(prop, "Disabled", "F-Curve Modifier has invalid settings and will not be evaluated.");
504         
505                 // TODO: setting this to true must ensure that all others in stack are turned off too...
506         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
507         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_ACTIVE);
508         RNA_def_property_ui_text(prop, "Active", "F-Curve Modifier is the one being edited ");
509 }       
510
511 /* *********************** */
512
513 void rna_def_drivertarget(BlenderRNA *brna)
514 {
515         StructRNA *srna;
516         PropertyRNA *prop;
517         
518         srna= RNA_def_struct(brna, "DriverTarget", NULL);
519         RNA_def_struct_ui_text(srna, "Driver Target", "Variable from some source/target for driver relationship.");
520         
521         /* Variable Name */
522         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
523         RNA_def_struct_name_property(srna, prop);
524         RNA_def_property_ui_text(prop, "Name", "Name to use in scripted expressions/functions.");
525         
526         /* Target Properties */
527         prop= RNA_def_property(srna, "target", PROP_POINTER, PROP_NONE);
528         RNA_def_property_pointer_sdna(prop, NULL, "id");
529         RNA_def_property_ui_text(prop, "Object", "Object the specific property used can be found from");
530         
531         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
532         RNA_def_property_string_funcs(prop, "rna_DriverTarget_RnaPath_get", "rna_DriverTarget_RnaPath_length", "rna_DriverTarget_RnaPath_set");
533         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path (from Object) to property used");
534         
535         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
536         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific property used (if applicable)");
537 }
538
539 void rna_def_channeldriver(BlenderRNA *brna)
540 {
541         StructRNA *srna;
542         PropertyRNA *prop;
543         
544         static EnumPropertyItem prop_type_items[] = {
545                 {DRIVER_TYPE_AVERAGE, "AVERAGE", "Averaged Value", ""},
546                 {DRIVER_TYPE_PYTHON, "SCRIPTED", "Scripted Expression", ""},
547                 {DRIVER_TYPE_ROTDIFF, "ROTDIFF", "Rotational Difference", ""},
548                 {0, NULL, NULL, NULL}};
549
550         srna= RNA_def_struct(brna, "Driver", NULL);
551         RNA_def_struct_sdna(srna, "ChannelDriver");
552         RNA_def_struct_ui_text(srna, "Driver", "Driver for the value of a setting based on an external value.");
553
554         /* Enums */
555         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
556         RNA_def_property_enum_items(prop, prop_type_items);
557         RNA_def_property_ui_text(prop, "Type", "Driver types.");
558
559         /* String values */
560         prop= RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
561         RNA_def_property_ui_text(prop, "Expression", "Expression to use for Scripted Expression.");
562
563         /* Collections */
564         prop= RNA_def_property(srna, "targets", PROP_COLLECTION, PROP_NONE);
565         RNA_def_property_collection_sdna(prop, NULL, "targets", NULL);
566         RNA_def_property_struct_type(prop, "DriverTarget");
567         RNA_def_property_ui_text(prop, "Target Variables", "Properties acting as targets for this driver.");
568 }
569
570 /* *********************** */
571
572 void rna_def_fcurve(BlenderRNA *brna)
573 {
574         StructRNA *srna;
575         PropertyRNA *prop;
576         
577         static EnumPropertyItem prop_mode_extend_items[] = {
578                 {FCURVE_EXTRAPOLATE_CONSTANT, "CONSTANT", "Constant", ""},
579                 {FCURVE_EXTRAPOLATE_LINEAR, "LINEAR", "Linear", ""},
580                 {0, NULL, NULL, NULL}};
581         static EnumPropertyItem prop_mode_color_items[] = {
582                 {FCURVE_COLOR_AUTO_RAINBOW, "AUTO_RAINBOW", "Automatic Rainbow", ""},
583                 {FCURVE_COLOR_AUTO_RGB, "AUTO_RGB", "Automatic XYZ to RGB", ""},
584                 {FCURVE_COLOR_CUSTOM, "CUSTOM", "User Defined", ""},
585                 {0, NULL, NULL, NULL}};
586
587         srna= RNA_def_struct(brna, "FCurve", NULL);
588         RNA_def_struct_ui_text(srna, "F-Curve", "F-Curve defining values of a period of time.");
589
590         /* Enums */
591         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
592         RNA_def_property_enum_sdna(prop, NULL, "extend");
593         RNA_def_property_enum_items(prop, prop_mode_extend_items);
594         RNA_def_property_ui_text(prop, "Extrapolation", "");
595
596         /* Pointers */
597         prop= RNA_def_property(srna, "driver", PROP_POINTER, PROP_NONE);
598         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
599         RNA_def_property_ui_text(prop, "Driver", "Channel Driver (only set for Driver F-Curves)");
600         
601         /* Path + Array Index */
602         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
603         RNA_def_property_string_funcs(prop, "rna_FCurve_RnaPath_get", "rna_FCurve_RnaPath_length", "rna_FCurve_RnaPath_set");
604         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property affected by F-Curve.");
605         
606         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
607         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific property affected by F-Curve if applicable.");
608         
609         /* Color */
610         prop= RNA_def_property(srna, "color_mode", PROP_ENUM, PROP_NONE);
611         RNA_def_property_enum_items(prop, prop_mode_color_items);
612         RNA_def_property_ui_text(prop, "Color Mode", "Method used to determine color of F-Curve in Graph Editor.");
613         
614         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
615         RNA_def_property_array(prop, 3);
616         RNA_def_property_ui_text(prop, "Color", "Color of the F-Curve in the Graph Editor.");
617         
618         /* Collections */
619         prop= RNA_def_property(srna, "sampled_points", PROP_COLLECTION, PROP_NONE);
620         RNA_def_property_collection_sdna(prop, NULL, "fpt", "totvert");
621         RNA_def_property_struct_type(prop, "CurvePoint"); // XXX FPoints not BPoints here! FPoints are much smaller!
622         RNA_def_property_ui_text(prop, "Sampled Points", "Sampled animation data");
623
624         prop= RNA_def_property(srna, "keyframe_points", PROP_COLLECTION, PROP_NONE);
625         RNA_def_property_collection_sdna(prop, NULL, "bezt", "totvert");
626         RNA_def_property_struct_type(prop, "BezierCurvePoint");
627         RNA_def_property_ui_text(prop, "Keyframes", "User-editable keyframes");
628         
629         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
630         RNA_def_property_struct_type(prop, "FModifier");
631         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the shape of the F-Curve.");
632 }
633
634 /* *********************** */
635
636 void RNA_def_fcurve(BlenderRNA *brna)
637 {
638         rna_def_fcurve(brna);
639         
640         rna_def_drivertarget(brna);
641         rna_def_channeldriver(brna);
642         
643         rna_def_fmodifier(brna);
644         
645         rna_def_fmodifier_generator(brna);
646                 rna_def_fmodifier_generator_polyexpanded(brna);
647                 rna_def_fmodifier_generator_function(brna);
648         rna_def_fmodifier_envelope(brna);
649         rna_def_fmodifier_cycles(brna);
650         rna_def_fmodifier_python(brna);
651         rna_def_fmodifier_limits(brna);
652         rna_def_fmodifier_noise(brna);
653 }
654
655
656 #endif