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