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