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