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