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