F-Modifier Goodies (as requested by @ndy):
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 "BLI_math.h"
41
42 #include "WM_types.h"
43
44 EnumPropertyItem fmodifier_type_items[] = {
45         {FMODIFIER_TYPE_NULL, "NULL", 0, "Invalid", ""},
46         {FMODIFIER_TYPE_GENERATOR, "GENERATOR", 0, "Generator", ""},
47         {FMODIFIER_TYPE_FN_GENERATOR, "FNGENERATOR", 0, "Built-In Function", ""},
48         {FMODIFIER_TYPE_ENVELOPE, "ENVELOPE", 0, "Envelope", ""},
49         {FMODIFIER_TYPE_CYCLES, "CYCLES", 0, "Cycles", ""},
50         {FMODIFIER_TYPE_NOISE, "NOISE", 0, "Noise", ""},
51         {FMODIFIER_TYPE_FILTER, "FILTER", 0, "Filter", ""},
52         {FMODIFIER_TYPE_PYTHON, "PYTHON", 0, "Python", ""},
53         {FMODIFIER_TYPE_LIMITS, "LIMITS", 0, "Limits", ""},
54         {FMODIFIER_TYPE_STEPPED, "STEPPED", 0, "Stepped Interpolation", ""},
55         {0, NULL, 0, NULL, NULL}};
56
57 EnumPropertyItem beztriple_keyframe_type_items[] = {
58         {BEZT_KEYTYPE_KEYFRAME, "KEYFRAME", 0, "Keyframe", ""},
59         {BEZT_KEYTYPE_BREAKDOWN, "BREAKDOWN", 0, "Breakdown", ""},
60         {BEZT_KEYTYPE_EXTREME, "EXTREME", 0, "Extreme", ""},
61         {0, NULL, 0, NULL, NULL}};
62
63 #ifdef RNA_RUNTIME
64
65 #include "WM_api.h"
66
67 static StructRNA *rna_FModifierType_refine(struct PointerRNA *ptr)
68 {
69         FModifier *fcm= (FModifier *)ptr->data;
70
71         switch (fcm->type) {
72                 case FMODIFIER_TYPE_GENERATOR:
73                         return &RNA_FModifierGenerator;
74                 case FMODIFIER_TYPE_FN_GENERATOR:
75                         return &RNA_FModifierFunctionGenerator;
76                 case FMODIFIER_TYPE_ENVELOPE:
77                         return &RNA_FModifierEnvelope;
78                 case FMODIFIER_TYPE_CYCLES:
79                         return &RNA_FModifierCycles;
80                 case FMODIFIER_TYPE_NOISE:
81                         return &RNA_FModifierNoise;
82                 //case FMODIFIER_TYPE_FILTER:
83                 //      return &RNA_FModifierFilter;
84                 case FMODIFIER_TYPE_PYTHON:
85                         return &RNA_FModifierPython;
86                 case FMODIFIER_TYPE_LIMITS:
87                         return &RNA_FModifierLimits;
88                 case FMODIFIER_TYPE_STEPPED:
89                         return &RNA_FModifierStepped;
90                 default:
91                         return &RNA_UnknownType;
92         }
93 }
94
95 /* ****************************** */
96
97 #include "BKE_fcurve.h"
98 #include "BKE_depsgraph.h"
99 #include "BKE_animsys.h"
100
101 static void rna_ChannelDriver_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
102 {
103         ID *id= ptr->id.data;
104         ChannelDriver *driver= ptr->data;
105
106         driver->flag &= ~DRIVER_FLAG_INVALID;
107         
108         // TODO: this really needs an update guard...
109         DAG_scene_sort(scene);
110         DAG_id_flush_update(id, OB_RECALC_OB|OB_RECALC_DATA);
111         
112         WM_main_add_notifier(NC_SCENE|ND_FRAME, scene);
113 }
114
115 static void rna_ChannelDriver_update_expr(Main *bmain, Scene *scene, PointerRNA *ptr)
116 {
117         ChannelDriver *driver= ptr->data;
118         driver->flag |= DRIVER_FLAG_RECOMPILE;
119         rna_ChannelDriver_update_data(bmain, scene, ptr);
120 }
121
122 static void rna_DriverTarget_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
123 {
124         PointerRNA driverptr;
125         ChannelDriver *driver;
126         FCurve *fcu;
127         AnimData *adt= BKE_animdata_from_id(ptr->id.data);
128
129         /* find the driver this belongs to and update it */
130         for (fcu=adt->drivers.first; fcu; fcu=fcu->next) {
131                 driver= fcu->driver;
132                 
133                 if (driver) {
134                         // FIXME: need to be able to search targets for required one...
135                         //BLI_findindex(&driver->targets, ptr->data) != -1) 
136                         RNA_pointer_create(ptr->id.data, &RNA_Driver, driver, &driverptr);
137                         rna_ChannelDriver_update_data(bmain, scene, &driverptr);
138                         return;
139                 }
140         }
141 }
142
143 static void rna_DriverTarget_update_name(Main *bmain, Scene *scene, PointerRNA *ptr)
144 {
145         ChannelDriver *driver= ptr->data;
146         rna_DriverTarget_update_data(bmain, scene, ptr);
147
148         driver->flag |= DRIVER_FLAG_RENAMEVAR;
149
150 }
151
152 /* ----------- */
153
154 static StructRNA *rna_DriverTarget_id_typef(PointerRNA *ptr)
155 {
156         DriverTarget *dtar= (DriverTarget*)ptr->data;
157         return ID_code_to_RNA_type(dtar->idtype);
158 }
159
160 static int rna_DriverTarget_id_editable(PointerRNA *ptr)
161 {
162         DriverTarget *dtar= (DriverTarget*)ptr->data;
163         return (dtar->idtype)? PROP_EDITABLE : 0;
164 }
165
166 static int rna_DriverTarget_id_type_editable(PointerRNA *ptr)
167 {
168         DriverTarget *dtar= (DriverTarget*)ptr->data;
169         
170         /* when the id-type can only be object, don't allow editing
171          * otherwise, there may be strange crashes
172          */
173         return ((dtar->flag & DTAR_FLAG_ID_OB_ONLY) == 0);
174 }
175
176 static void rna_DriverTarget_id_type_set(PointerRNA *ptr, int value)
177 {
178         DriverTarget *data= (DriverTarget*)(ptr->data);
179         
180         /* check if ID-type is settable */
181         if ((data->flag & DTAR_FLAG_ID_OB_ONLY) == 0) {
182                 /* change ID-type to the new type */
183                 data->idtype= value;
184         }
185         else {
186                 /* make sure ID-type is Object */
187                 data->idtype= ID_OB;
188         }
189         
190         /* clear the id-block if the type is invalid */
191         if ((data->id) && (GS(data->id->name) != data->idtype))
192                 data->id= NULL;
193 }
194
195 static void rna_DriverTarget_RnaPath_get(PointerRNA *ptr, char *value)
196 {
197         DriverTarget *dtar= (DriverTarget *)ptr->data;
198
199         if (dtar->rna_path)
200                 strcpy(value, dtar->rna_path);
201         else
202                 strcpy(value, "");
203 }
204
205 static int rna_DriverTarget_RnaPath_length(PointerRNA *ptr)
206 {
207         DriverTarget *dtar= (DriverTarget *)ptr->data;
208         
209         if (dtar->rna_path)
210                 return strlen(dtar->rna_path);
211         else
212                 return 0;
213 }
214
215 static void rna_DriverTarget_RnaPath_set(PointerRNA *ptr, const char *value)
216 {
217         DriverTarget *dtar= (DriverTarget *)ptr->data;
218         
219         // XXX in this case we need to be very careful, as this will require some new dependencies to be added!
220         if (dtar->rna_path)
221                 MEM_freeN(dtar->rna_path);
222         
223         if (strlen(value))
224                 dtar->rna_path= BLI_strdup(value);
225         else 
226                 dtar->rna_path= NULL;
227 }
228
229 static void rna_DriverVariable_type_set(PointerRNA *ptr, int value)
230 {
231         DriverVar *dvar= (DriverVar *)ptr->data;
232         
233         /* call the API function for this */
234         driver_change_variable_type(dvar, value);
235 }
236
237 /* ****************************** */
238
239 static void rna_FKeyframe_handle1_get(PointerRNA *ptr, float *values)
240 {
241         BezTriple *bezt= (BezTriple*)ptr->data;
242         
243         values[0]= bezt->vec[0][0];
244         values[1]= bezt->vec[0][1];
245 }
246
247 static void rna_FKeyframe_handle1_set(PointerRNA *ptr, const float *values)
248 {
249         BezTriple *bezt= (BezTriple*)ptr->data;
250         
251         bezt->vec[0][0]= values[0];
252         bezt->vec[0][1]= values[1];
253 }
254
255 static void rna_FKeyframe_handle2_get(PointerRNA *ptr, float *values)
256 {
257         BezTriple *bezt= (BezTriple*)ptr->data;
258         
259         values[0]= bezt->vec[2][0];
260         values[1]= bezt->vec[2][1];
261 }
262
263 static void rna_FKeyframe_handle2_set(PointerRNA *ptr, const float *values)
264 {
265         BezTriple *bezt= (BezTriple*)ptr->data;
266         
267         bezt->vec[2][0]= values[0];
268         bezt->vec[2][1]= values[1];
269 }
270
271 static void rna_FKeyframe_ctrlpoint_get(PointerRNA *ptr, float *values)
272 {
273         BezTriple *bezt= (BezTriple*)ptr->data;
274         
275         values[0]= bezt->vec[1][0];
276         values[1]= bezt->vec[1][1];
277 }
278
279 static void rna_FKeyframe_ctrlpoint_set(PointerRNA *ptr, const float *values)
280 {
281         BezTriple *bezt= (BezTriple*)ptr->data;
282         
283         bezt->vec[1][0]= values[0];
284         bezt->vec[1][1]= values[1];
285 }
286
287 /* ****************************** */
288
289 static void rna_FCurve_RnaPath_get(PointerRNA *ptr, char *value)
290 {
291         FCurve *fcu= (FCurve *)ptr->data;
292
293         if (fcu->rna_path)
294                 strcpy(value, fcu->rna_path);
295         else
296                 strcpy(value, "");
297 }
298
299 static int rna_FCurve_RnaPath_length(PointerRNA *ptr)
300 {
301         FCurve *fcu= (FCurve *)ptr->data;
302         
303         if (fcu->rna_path)
304                 return strlen(fcu->rna_path);
305         else
306                 return 0;
307 }
308
309 static void rna_FCurve_RnaPath_set(PointerRNA *ptr, const char *value)
310 {
311         FCurve *fcu= (FCurve *)ptr->data;
312
313         if (fcu->rna_path)
314                 MEM_freeN(fcu->rna_path);
315         
316         if (strlen(value))
317                 fcu->rna_path= BLI_strdup(value);
318         else 
319                 fcu->rna_path= NULL;
320 }
321
322 DriverVar *rna_Driver_new_variable(ChannelDriver *driver)
323 {
324         /* call the API function for this */
325         return driver_add_new_variable(driver);
326 }
327
328 void rna_Driver_remove_variable(ChannelDriver *driver, DriverVar *dvar)
329 {
330         /* call the API function for this */
331         driver_free_variable(driver, dvar);
332 }
333
334
335 static PointerRNA rna_FCurve_active_modifier_get(PointerRNA *ptr)
336 {
337         FCurve *fcu= (FCurve*)ptr->data;
338         FModifier *fcm= find_active_fmodifier(&fcu->modifiers);
339         return rna_pointer_inherit_refine(ptr, &RNA_FModifier, fcm);
340 }
341
342 static void rna_FCurve_active_modifier_set(PointerRNA *ptr, PointerRNA value)
343 {
344         FCurve *fcu= (FCurve*)ptr->data;
345         set_active_fmodifier(&fcu->modifiers, (FModifier *)value.data);
346 }
347
348 static FModifier *rna_FCurve_modifiers_new(FCurve *fcu, bContext *C, int type)
349 {
350         return add_fmodifier(&fcu->modifiers, type);
351 }
352
353 static int rna_FCurve_modifiers_remove(FCurve *fcu, bContext *C, int index)
354 {
355         return remove_fmodifier_index(&fcu->modifiers, index);
356 }
357
358 static void rna_FModifier_active_set(PointerRNA *ptr, int value)
359 {
360         FModifier *fm= (FModifier*)ptr->data;
361
362         /* don't toggle, always switch on */
363         fm->flag |= FMODIFIER_FLAG_ACTIVE;
364 }
365
366 static void rna_FModifier_active_update(Main *bmain, Scene *scene, PointerRNA *ptr)
367 {
368         FModifier *fm, *fmo= (FModifier*)ptr->data;
369
370         /* clear active state of other FModifiers in this list */
371         for (fm=fmo->prev; fm; fm=fm->prev)
372         {
373                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
374         }
375         for (fm=fmo->next; fm; fm=fm->next)
376         {
377                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
378         }
379         
380 }
381
382 static int rna_FModifierGenerator_coefficients_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
383 {
384         FModifier *fcm= (FModifier*)ptr->data;
385         FMod_Generator *gen= fcm->data;
386
387         if(gen)
388                 length[0]= gen->arraysize;
389         else
390                 length[0]= 100; /* for raw_access, untested */
391
392         return length[0];
393 }
394
395 static void rna_FModifierGenerator_coefficients_get(PointerRNA *ptr, float *values)
396 {
397         FModifier *fcm= (FModifier*)ptr->data;
398         FMod_Generator *gen= fcm->data;
399         memcpy(values, gen->coefficients, gen->arraysize * sizeof(float));
400 }
401
402 static void rna_FModifierGenerator_coefficients_set(PointerRNA *ptr, const float *values)
403 {
404         FModifier *fcm= (FModifier*)ptr->data;
405         FMod_Generator *gen= fcm->data;
406         memcpy(gen->coefficients, values, gen->arraysize * sizeof(float));
407 }
408
409 #else
410
411 static void rna_def_fmodifier_generator(BlenderRNA *brna)
412 {
413         StructRNA *srna;
414         PropertyRNA *prop;
415         
416         static EnumPropertyItem generator_mode_items[] = {
417                 {FCM_GENERATOR_POLYNOMIAL, "POLYNOMIAL", 0, "Expanded Polynomial", ""},
418                 {FCM_GENERATOR_POLYNOMIAL_FACTORISED, "POLYNOMIAL_FACTORISED", 0, "Factorised Polynomial", ""},
419                 {0, NULL, 0, NULL, NULL}};
420         
421         srna= RNA_def_struct(brna, "FModifierGenerator", "FModifier");
422         RNA_def_struct_ui_text(srna, "Generator F-Curve Modifier", "Deterministically generates values for the modified F-Curve");
423         RNA_def_struct_sdna_from(srna, "FMod_Generator", "data");
424         
425         /* define common props */
426         prop= RNA_def_property(srna, "additive", PROP_BOOLEAN, PROP_NONE);
427         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
428         RNA_def_property_ui_text(prop, "Additive", "Values generated by this modifier are applied on top of the existing values instead of overwriting them");
429         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
430         
431                 // XXX this has a special validation func
432         prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
433         RNA_def_property_enum_items(prop, generator_mode_items);
434         RNA_def_property_ui_text(prop, "Mode", "Type of generator to use");
435         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
436         
437         
438         /* order of the polynomial */
439                 // XXX this has a special validation func
440         prop= RNA_def_property(srna, "poly_order", PROP_INT, PROP_NONE);
441         RNA_def_property_ui_text(prop, "Polynomial Order", "The highest power of 'x' for this polynomial. (number of coefficients - 1)");
442         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
443         
444         /* coefficients array */
445         prop= RNA_def_property(srna, "coefficients", PROP_FLOAT, PROP_NONE);
446         RNA_def_property_array(prop, 32);
447         RNA_def_property_flag(prop, PROP_DYNAMIC);
448         RNA_def_property_dynamic_array_funcs(prop, "rna_FModifierGenerator_coefficients_get_length");
449         RNA_def_property_float_funcs(prop, "rna_FModifierGenerator_coefficients_get", "rna_FModifierGenerator_coefficients_set", NULL);
450         RNA_def_property_ui_text(prop, "Coefficients", "Coefficients for 'x' (starting from lowest power of x^0)");
451 }
452
453 /* --------- */
454
455 static void rna_def_fmodifier_function_generator(BlenderRNA *brna)
456 {
457         StructRNA *srna;
458         PropertyRNA *prop;
459         
460         static EnumPropertyItem prop_type_items[] = {
461                 {0, "SIN", 0, "Sine", ""},
462                 {1, "COS", 0, "Cosine", ""},
463                 {2, "TAN", 0, "Tangent", ""},
464                 {3, "SQRT", 0, "Square Root", ""},
465                 {4, "LN", 0, "Natural Logarithm", ""},
466                 {5, "SINC", 0, "Normalised Sine", "sin(x) / x"},
467                 {0, NULL, 0, NULL, NULL}};
468         
469         srna= RNA_def_struct(brna, "FModifierFunctionGenerator", "FModifier");
470         RNA_def_struct_ui_text(srna, "Built-In Function F-Modifier", "Generates values using a Built-In Function");
471         RNA_def_struct_sdna_from(srna, "FMod_FunctionGenerator", "data");
472         
473         /* coefficients */
474         prop= RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
475         RNA_def_property_ui_text(prop, "Amplitude", "Scale factor determining the maximum/minimum values");
476         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
477         
478         prop= RNA_def_property(srna, "phase_multiplier", PROP_FLOAT, PROP_NONE);
479         RNA_def_property_ui_text(prop, "Phase Multiplier", "Scale factor determining the 'speed' of the function");
480         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
481         
482         prop= RNA_def_property(srna, "phase_offset", PROP_FLOAT, PROP_NONE);
483         RNA_def_property_ui_text(prop, "Phase Offset", "Constant factor to offset time by for function");
484         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
485         
486         prop= RNA_def_property(srna, "value_offset", PROP_FLOAT, PROP_NONE);
487         RNA_def_property_ui_text(prop, "Value Offset", "Constant factor to offset values by");
488         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
489         
490         /* flags */
491         prop= RNA_def_property(srna, "additive", PROP_BOOLEAN, PROP_NONE);
492         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
493         RNA_def_property_ui_text(prop, "Additive", "Values generated by this modifier are applied on top of the existing values instead of overwriting them");
494         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
495         
496         prop= RNA_def_property(srna, "function_type", PROP_ENUM, PROP_NONE);
497         RNA_def_property_enum_sdna(prop, NULL, "type");
498         RNA_def_property_enum_items(prop, prop_type_items);
499         RNA_def_property_ui_text(prop, "Type", "Type of built-in function to use");
500         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
501 }
502
503 /* --------- */
504
505 static void rna_def_fmodifier_envelope_ctrl(BlenderRNA *brna)
506 {
507         StructRNA *srna;
508         PropertyRNA *prop;
509         
510         srna= RNA_def_struct(brna, "FModifierEnvelopeControlPoint", NULL);
511         RNA_def_struct_ui_text(srna, "Envelope Control Point", "Control point for envelope F-Modifier");
512         RNA_def_struct_sdna(srna, "FCM_EnvelopeData");
513         
514         /* min/max extents 
515          *      - for now, these are allowed to go past each other, so that we can have inverted action
516          *      - technically, the range is limited by the settings in the envelope-modifier data, not here...
517          */
518         prop= RNA_def_property(srna, "minimum", PROP_FLOAT, PROP_NONE);
519         RNA_def_property_float_sdna(prop, NULL, "min");
520         RNA_def_property_ui_text(prop, "Minimum Value", "Lower bound of envelope at this control-point");
521         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
522         
523         prop= RNA_def_property(srna, "maximum", PROP_FLOAT, PROP_NONE);
524         RNA_def_property_float_sdna(prop, NULL, "max");
525         RNA_def_property_ui_text(prop, "Maximum Value", "Upper bound of envelope at this control-point");
526         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
527         
528         /* Frame */
529         prop= RNA_def_property(srna, "frame", PROP_FLOAT, PROP_TIME);
530         RNA_def_property_float_sdna(prop, NULL, "time");
531         RNA_def_property_ui_text(prop, "Frame", "Frame this control-point occurs on");
532         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
533         
534         // TODO:
535         //      - selection flags (not implemented in UI yet though)
536 }
537
538 static void rna_def_fmodifier_envelope(BlenderRNA *brna)
539 {
540         StructRNA *srna;
541         PropertyRNA *prop;
542         
543         srna= RNA_def_struct(brna, "FModifierEnvelope", "FModifier");
544         RNA_def_struct_ui_text(srna, "Envelope F-Modifier", "Scales the values of the modified F-Curve");
545         RNA_def_struct_sdna_from(srna, "FMod_Envelope", "data");
546         
547         /* Collections */
548         prop= RNA_def_property(srna, "control_points", PROP_COLLECTION, PROP_NONE);
549         RNA_def_property_collection_sdna(prop, NULL, "data", "totvert");
550         RNA_def_property_struct_type(prop, "FModifierEnvelopeControlPoint");
551         RNA_def_property_ui_text(prop, "Control Points", "Control points defining the shape of the envelope");
552         
553         /* Range Settings */
554         prop= RNA_def_property(srna, "reference_value", PROP_FLOAT, PROP_NONE);
555         RNA_def_property_float_sdna(prop, NULL, "midval");
556         RNA_def_property_ui_text(prop, "Reference Value", "Value that envelope's influence is centered around / based on");
557         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
558         
559         prop= RNA_def_property(srna, "default_minimum", PROP_FLOAT, PROP_NONE);
560         RNA_def_property_float_sdna(prop, NULL, "min");
561         RNA_def_property_ui_text(prop, "Default Minimum", "Lower distance from Reference Value for 1:1 default influence");
562         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
563         
564         prop= RNA_def_property(srna, "default_maximum", PROP_FLOAT, PROP_NONE);
565         RNA_def_property_float_sdna(prop, NULL, "max");
566         RNA_def_property_ui_text(prop, "Default Maximum", "Upper distance from Reference Value for 1:1 default influence");
567         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
568 }
569
570 /* --------- */
571
572 static void rna_def_fmodifier_cycles(BlenderRNA *brna)
573 {
574         StructRNA *srna;
575         PropertyRNA *prop;
576         
577         static EnumPropertyItem prop_type_items[] = {
578                 {FCM_EXTRAPOLATE_NONE, "NONE", 0, "No Cycles", "Don't do anything"},
579                 {FCM_EXTRAPOLATE_CYCLIC, "REPEAT", 0, "Repeat Motion", "Repeat keyframe range as-is"},
580                 {FCM_EXTRAPOLATE_CYCLIC_OFFSET, "REPEAT_OFFSET", 0, "Repeat with Offset", "Repeat keyframe range, but with offset based on gradient between values"},
581                 {FCM_EXTRAPOLATE_MIRROR, "MIRROR", 0, "Repeat Mirrored", "Alternate between forward and reverse playback of keyframe range"},
582                 {0, NULL, 0, NULL, NULL}};
583         
584         srna= RNA_def_struct(brna, "FModifierCycles", "FModifier");
585         RNA_def_struct_ui_text(srna, "Cycles F-Modifier", "Repeats the values of the modified F-Curve");
586         RNA_def_struct_sdna_from(srna, "FMod_Cycles", "data");
587         
588         /* before */
589         prop= RNA_def_property(srna, "before_mode", PROP_ENUM, PROP_NONE);
590         RNA_def_property_enum_items(prop, prop_type_items);
591         RNA_def_property_ui_text(prop, "Before Mode", "Cycling mode to use before first keyframe");
592         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
593         
594         prop= RNA_def_property(srna, "before_cycles", PROP_FLOAT, PROP_NONE);
595         RNA_def_property_ui_text(prop, "Before Cycles", "Maximum number of cycles to allow before first keyframe. (0 = infinite)");
596         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
597         
598         /* after */
599         prop= RNA_def_property(srna, "after_mode", PROP_ENUM, PROP_NONE);
600         RNA_def_property_enum_items(prop, prop_type_items);
601         RNA_def_property_ui_text(prop, "After Mode", "Cycling mode to use after last keyframe");
602         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
603         
604         prop= RNA_def_property(srna, "after_cycles", PROP_FLOAT, PROP_NONE);
605         RNA_def_property_ui_text(prop, "After Cycles", "Maximum number of cycles to allow after last keyframe. (0 = infinite)");
606         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
607 }
608
609 /* --------- */
610
611 static void rna_def_fmodifier_python(BlenderRNA *brna)
612 {
613         StructRNA *srna;
614         //PropertyRNA *prop;
615         
616         srna= RNA_def_struct(brna, "FModifierPython", "FModifier");
617         RNA_def_struct_ui_text(srna, "Python F-Modifier", "Performs user-defined operation on the modified F-Curve");
618         RNA_def_struct_sdna_from(srna, "FMod_Python", "data");
619 }
620
621 /* --------- */
622
623 static void rna_def_fmodifier_limits(BlenderRNA *brna)
624 {
625         StructRNA *srna;
626         PropertyRNA *prop;
627         
628         srna= RNA_def_struct(brna, "FModifierLimits", "FModifier");
629         RNA_def_struct_ui_text(srna, "Limits F-Modifier", "Limits the time/value ranges of the modified F-Curve");
630         RNA_def_struct_sdna_from(srna, "FMod_Limits", "data");
631         
632         prop= RNA_def_property(srna, "use_minimum_x", PROP_BOOLEAN, PROP_NONE);
633         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMIN);
634         RNA_def_property_ui_text(prop, "Minimum X", "Use the minimum X value");
635         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
636         
637         prop= RNA_def_property(srna, "use_minimum_y", PROP_BOOLEAN, PROP_NONE);
638         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMIN);
639         RNA_def_property_ui_text(prop, "Minimum Y", "Use the minimum Y value");
640         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
641         
642         prop= RNA_def_property(srna, "use_maximum_x", PROP_BOOLEAN, PROP_NONE);
643         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMAX);
644         RNA_def_property_ui_text(prop, "Maximum X", "Use the maximum X value");
645         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
646         
647         prop= RNA_def_property(srna, "use_maximum_y", PROP_BOOLEAN, PROP_NONE);
648         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMAX);
649         RNA_def_property_ui_text(prop, "Maximum Y", "Use the maximum Y value");
650         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
651         
652         prop= RNA_def_property(srna, "minimum_x", PROP_FLOAT, PROP_NONE);
653         RNA_def_property_float_sdna(prop, NULL, "rect.xmin");
654         RNA_def_property_ui_text(prop, "Minimum X", "Lowest X value to allow");
655         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
656         
657         prop= RNA_def_property(srna, "minimum_y", PROP_FLOAT, PROP_NONE);
658         RNA_def_property_float_sdna(prop, NULL, "rect.ymin");
659         RNA_def_property_ui_text(prop, "Minimum Y", "Lowest Y value to allow");
660         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
661         
662         prop= RNA_def_property(srna, "maximum_x", PROP_FLOAT, PROP_NONE);
663         RNA_def_property_float_sdna(prop, NULL, "rect.xmax");
664         RNA_def_property_ui_text(prop, "Maximum X", "Highest X value to allow");
665         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
666         
667         prop= RNA_def_property(srna, "maximum_y", PROP_FLOAT, PROP_NONE);
668         RNA_def_property_float_sdna(prop, NULL, "rect.ymax");
669         RNA_def_property_ui_text(prop, "Maximum Y", "Highest Y value to allow");
670         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
671 }
672
673 /* --------- */
674
675 static void rna_def_fmodifier_noise(BlenderRNA *brna)
676 {
677         StructRNA *srna;
678         PropertyRNA *prop;
679         
680         static EnumPropertyItem prop_modification_items[] = {
681                 {FCM_NOISE_MODIF_REPLACE, "REPLACE", 0, "Replace", ""},
682                 {FCM_NOISE_MODIF_ADD, "ADD", 0, "Add", ""},
683                 {FCM_NOISE_MODIF_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
684                 {FCM_NOISE_MODIF_MULTIPLY, "MULTIPLY", 0, "Multiply", ""},
685                 {0, NULL, 0, NULL, NULL}};
686         
687         srna= RNA_def_struct(brna, "FModifierNoise", "FModifier");
688         RNA_def_struct_ui_text(srna, "Noise F-Modifier", "Gives randomness to the modified F-Curve");
689         RNA_def_struct_sdna_from(srna, "FMod_Noise", "data");
690         
691         prop= RNA_def_property(srna, "modification", PROP_ENUM, PROP_NONE);
692         RNA_def_property_enum_items(prop, prop_modification_items);
693         RNA_def_property_ui_text(prop, "Modification", "Method of modifying the existing F-Curve");
694         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
695         
696         prop= RNA_def_property(srna, "size", PROP_FLOAT, PROP_NONE);
697         RNA_def_property_float_sdna(prop, NULL, "size");
698         RNA_def_property_ui_text(prop, "Size", "Scaling (in time) of the noise");
699         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
700         
701         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
702         RNA_def_property_float_sdna(prop, NULL, "strength");
703         RNA_def_property_ui_text(prop, "Strength", "Amplitude of the noise - the amount that it modifies the underlying curve");
704         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
705         
706         prop= RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
707         RNA_def_property_float_sdna(prop, NULL, "phase");
708         RNA_def_property_ui_text(prop, "Phase", "A random seed for the noise effect");
709         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
710         
711         prop= RNA_def_property(srna, "depth", PROP_INT, PROP_NONE);
712         RNA_def_property_int_sdna(prop, NULL, "depth");
713         RNA_def_property_ui_text(prop, "Depth", "Amount of fine level detail present in the noise");
714         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
715
716 }
717
718 /* --------- */
719
720 static void rna_def_fmodifier_stepped(BlenderRNA *brna)
721 {
722         StructRNA *srna;
723         PropertyRNA *prop;
724         
725         srna= RNA_def_struct(brna, "FModifierStepped", "FModifier");
726         RNA_def_struct_ui_text(srna, "Stepped Interpolation F-Modifier", "Holds each interpolated value from the F-Curve for several frames without changing the timing");
727         RNA_def_struct_sdna_from(srna, "FMod_Stepped", "data");
728         
729         /* properties */
730         prop= RNA_def_property(srna, "step_size", PROP_FLOAT, PROP_NONE);
731         RNA_def_property_ui_text(prop, "Step Size", "Number of frames to hold each value");
732         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
733         
734         prop= RNA_def_property(srna, "start_offset", PROP_FLOAT, PROP_NONE);
735         RNA_def_property_float_sdna(prop, NULL, "start");
736         RNA_def_property_ui_text(prop, "Start Offset", "Reference number of frames before frames get held. Use to get hold for '1-3' vs '5-7' holding patterns");
737         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
738 }
739
740 /* --------- */
741
742
743 static void rna_def_fmodifier(BlenderRNA *brna)
744 {
745         StructRNA *srna;
746         PropertyRNA *prop;
747         
748         /* base struct definition */
749         srna= RNA_def_struct(brna, "FModifier", NULL);
750         RNA_def_struct_refine_func(srna, "rna_FModifierType_refine");
751         RNA_def_struct_ui_text(srna, "F-Modifier", "Modifier for values of F-Curve");
752         
753 #if 0 // XXX not used yet
754         /* name */
755         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
756         RNA_def_struct_name_property(srna, prop);
757         RNA_def_property_ui_text(prop, "Name", "Short description of F-Curve Modifier");
758 #endif // XXX not used yet
759         
760         /* type */
761         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
762         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
763         RNA_def_property_enum_items(prop, fmodifier_type_items);
764         RNA_def_property_ui_text(prop, "Type", "F-Curve Modifier Type");
765         
766         /* settings */
767         prop= RNA_def_property(srna, "expanded", PROP_BOOLEAN, PROP_NONE);
768         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_EXPANDED);
769         RNA_def_property_ui_text(prop, "Expanded", "F-Curve Modifier's panel is expanded in UI");
770         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);
771         
772         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
773         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_MUTED);
774         RNA_def_property_ui_text(prop, "Muted", "F-Curve Modifier will not be evaluated");
775         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
776         RNA_def_property_ui_icon(prop, ICON_MUTE_IPO_OFF, 1);
777         
778         prop= RNA_def_property(srna, "disabled", PROP_BOOLEAN, PROP_NONE);
779         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
780         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_DISABLED);
781         RNA_def_property_ui_text(prop, "Disabled", "F-Curve Modifier has invalid settings and will not be evaluated");
782         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
783         
784                 // TODO: setting this to true must ensure that all others in stack are turned off too...
785         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
786         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_ACTIVE);
787         RNA_def_property_ui_text(prop, "Active", "F-Curve Modifier is the one being edited ");
788         RNA_def_property_boolean_funcs(prop, NULL, "rna_FModifier_active_set");
789         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, "rna_FModifier_active_update");
790         RNA_def_property_ui_icon(prop, ICON_RADIOBUT_OFF, 1);
791 }       
792
793 /* *********************** */
794
795 static void rna_def_drivertarget(BlenderRNA *brna)
796 {
797         StructRNA *srna;
798         PropertyRNA *prop;
799         
800         static EnumPropertyItem prop_trans_chan_items[] = {
801                 {DTAR_TRANSCHAN_LOCX, "LOC_X", 0, "X Location", ""},
802                 {DTAR_TRANSCHAN_LOCY, "LOC_Y", 0, "Y Location", ""},
803                 {DTAR_TRANSCHAN_LOCZ, "LOC_Z", 0, "Z Location", ""},
804                 {DTAR_TRANSCHAN_ROTX, "ROT_X", 0, "X Rotation", ""},
805                 {DTAR_TRANSCHAN_ROTY, "ROT_Y", 0, "Y Rotation", ""},
806                 {DTAR_TRANSCHAN_ROTZ, "ROT_Z", 0, "Z Rotation", ""},
807                 {DTAR_TRANSCHAN_SCALEX, "SCALE_X", 0, "X Scale", ""},
808                 {DTAR_TRANSCHAN_SCALEY, "SCALE_Y", 0, "Y Scale", ""},
809                 {DTAR_TRANSCHAN_SCALEZ, "SCALE_Z", 0, "Z Scale", ""},
810                 {0, NULL, 0, NULL, NULL}};
811         
812         srna= RNA_def_struct(brna, "DriverTarget", NULL);
813         RNA_def_struct_ui_text(srna, "Driver Target", "Source of input values for driver variables");
814         
815         /* Target Properties - ID-block to Drive */
816         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
817         RNA_def_property_struct_type(prop, "ID");
818         RNA_def_property_flag(prop, PROP_EDITABLE);
819         RNA_def_property_editable_func(prop, "rna_DriverTarget_id_editable");
820         RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_DriverTarget_id_typef");
821         RNA_def_property_ui_text(prop, "ID", "ID-block that the specific property used can be found from (id_type property must be set first)");
822         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
823         
824         prop= RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
825         RNA_def_property_enum_sdna(prop, NULL, "idtype");
826         RNA_def_property_enum_items(prop, id_type_items);
827         RNA_def_property_enum_default(prop, ID_OB);
828         RNA_def_property_enum_funcs(prop, NULL, "rna_DriverTarget_id_type_set", NULL);
829         RNA_def_property_editable_func(prop, "rna_DriverTarget_id_type_editable");
830         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
831         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
832         
833         /* Target Properties - Property to Drive */
834         prop= RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
835         RNA_def_property_string_funcs(prop, "rna_DriverTarget_RnaPath_get", "rna_DriverTarget_RnaPath_length", "rna_DriverTarget_RnaPath_set");
836         RNA_def_property_ui_text(prop, "Data Path", "RNA Path (from ID-block) to property used");
837         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
838         
839         prop= RNA_def_property(srna, "bone_target", PROP_STRING, PROP_NONE);
840         RNA_def_property_string_sdna(prop, NULL, "pchan_name");
841         RNA_def_property_ui_text(prop, "Bone Name", "Name of PoseBone to use as target");
842         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
843         
844         prop= RNA_def_property(srna, "transform_type", PROP_ENUM, PROP_NONE);
845         RNA_def_property_enum_sdna(prop, NULL, "transChan");
846         RNA_def_property_enum_items(prop, prop_trans_chan_items);
847         RNA_def_property_ui_text(prop, "Type", "Driver variable type");
848         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
849         
850         prop= RNA_def_property(srna, "use_local_space_transforms", PROP_BOOLEAN, PROP_NONE);
851         RNA_def_property_boolean_sdna(prop, NULL, "flag", DTAR_FLAG_LOCALSPACE);
852         RNA_def_property_ui_text(prop, "Local Space", "Use transforms in Local Space (as opposed to the worldspace default)");
853         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
854 }
855
856 static void rna_def_drivervar(BlenderRNA *brna)
857 {
858         StructRNA *srna;
859         PropertyRNA *prop;
860         
861         static EnumPropertyItem prop_type_items[] = {
862                 {DVAR_TYPE_SINGLE_PROP, "SINGLE_PROP", 0, "Single Property", "Use the value from some RNA property (Default)"},
863                 {DVAR_TYPE_TRANSFORM_CHAN, "TRANSFORMS", 0, "Transform Channel", "Final transformation value of object or bone"},
864                 {DVAR_TYPE_ROT_DIFF, "ROTATION_DIFF", 0, "Rotational Difference", "Use the angle between two bones"},
865                 {DVAR_TYPE_LOC_DIFF, "LOC_DIFF", 0, "Distance", "Distance between two bones or objects"},
866                 {0, NULL, 0, NULL, NULL}};
867                 
868         
869         srna= RNA_def_struct(brna, "DriverVariable", NULL);
870         RNA_def_struct_sdna(srna, "DriverVar");
871         RNA_def_struct_ui_text(srna, "Driver Variable", "Variable from some source/target for driver relationship");
872         
873         /* Variable Name */
874         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
875         RNA_def_struct_name_property(srna, prop);
876         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)");
877         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_name"); // XXX
878         
879         /* Enums */
880         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
881         RNA_def_property_enum_items(prop, prop_type_items);
882         RNA_def_property_enum_funcs(prop, NULL, "rna_DriverVariable_type_set", NULL);
883         RNA_def_property_ui_text(prop, "Type", "Driver variable type");
884         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); // XXX
885         
886         /* Targets */
887         // TODO: for nicer api, only expose the relevant props via subclassing, instead of exposing the collection of targets
888         prop= RNA_def_property(srna, "targets", PROP_COLLECTION, PROP_NONE);
889         RNA_def_property_collection_sdna(prop, NULL, "targets", "num_targets");
890         RNA_def_property_struct_type(prop, "DriverTarget");
891         RNA_def_property_ui_text(prop, "Targets", "Sources of input data for evaluating this variable");
892 }
893
894
895 /* channeldriver.variables.* */
896 static void rna_def_channeldriver_variables(BlenderRNA *brna, PropertyRNA *cprop)
897 {
898         StructRNA *srna;
899 //      PropertyRNA *prop;
900         
901         FunctionRNA *func;
902         PropertyRNA *parm;
903         
904         RNA_def_property_srna(cprop, "ChannelDriverVariables");
905         srna= RNA_def_struct(brna, "ChannelDriverVariables", NULL);
906         RNA_def_struct_sdna(srna, "ChannelDriver");
907         RNA_def_struct_ui_text(srna, "ChannelDriver Variables", "Collection of channel driver Variables");
908         
909         
910         /* add variable */
911         func= RNA_def_function(srna, "new", "rna_Driver_new_variable");
912         RNA_def_function_ui_description(func, "Add a new variable for the driver.");
913                 /* return type */
914         parm= RNA_def_pointer(func, "var", "DriverVariable", "", "Newly created Driver Variable.");
915                 RNA_def_function_return(func, parm);
916
917         /* remove variable */
918         func= RNA_def_function(srna, "remove", "rna_Driver_remove_variable");
919                 RNA_def_function_ui_description(func, "Remove an existing variable from the driver.");
920                 /* target to remove */
921         parm= RNA_def_pointer(func, "var", "DriverVariable", "", "Variable to remove from the driver.");
922                 RNA_def_property_flag(parm, PROP_REQUIRED);
923 }
924
925 static void rna_def_channeldriver(BlenderRNA *brna)
926 {
927         StructRNA *srna;
928         PropertyRNA *prop;
929         
930         static EnumPropertyItem prop_type_items[] = {
931                 {DRIVER_TYPE_AVERAGE, "AVERAGE", 0, "Averaged Value", ""},
932                 {DRIVER_TYPE_SUM, "SUM", 0, "Sum Values", ""},
933                 {DRIVER_TYPE_PYTHON, "SCRIPTED", 0, "Scripted Expression", ""},
934                 {DRIVER_TYPE_MIN, "MIN", 0, "Minimum Value", ""},
935                 {DRIVER_TYPE_MAX, "MAX", 0, "Maximum Value", ""},
936                 {0, NULL, 0, NULL, NULL}};
937
938         srna= RNA_def_struct(brna, "Driver", NULL);
939         RNA_def_struct_sdna(srna, "ChannelDriver");
940         RNA_def_struct_ui_text(srna, "Driver", "Driver for the value of a setting based on an external value");
941
942         /* Enums */
943         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
944         RNA_def_property_enum_items(prop, prop_type_items);
945         RNA_def_property_ui_text(prop, "Type", "Driver type");
946         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data");
947
948         /* String values */
949         prop= RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
950         RNA_def_property_ui_text(prop, "Expression", "Expression to use for Scripted Expression");
951         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_expr");
952
953         /* Collections */
954         prop= RNA_def_property(srna, "variables", PROP_COLLECTION, PROP_NONE);
955         RNA_def_property_collection_sdna(prop, NULL, "variables", NULL);
956         RNA_def_property_struct_type(prop, "DriverVariable");
957         RNA_def_property_ui_text(prop, "Variables", "Properties acting as inputs for this driver");
958         rna_def_channeldriver_variables(brna, prop);
959         
960         /* Settings */
961         prop= RNA_def_property(srna, "show_debug_info", PROP_BOOLEAN, PROP_NONE);
962         RNA_def_property_boolean_sdna(prop, NULL, "flag", DRIVER_FLAG_SHOWDEBUG);
963         RNA_def_property_ui_text(prop, "Show Debug Info", "Show intermediate values for the driver calculations to allow debugging of drivers");
964         
965         /* Functions */
966         RNA_api_drivers(srna);
967 }
968
969 /* *********************** */
970
971 static void rna_def_fpoint(BlenderRNA *brna)
972 {
973         StructRNA *srna;
974         PropertyRNA *prop;
975         
976         srna= RNA_def_struct(brna, "FCurveSample", NULL);
977         RNA_def_struct_sdna(srna, "FPoint");
978         RNA_def_struct_ui_text(srna, "F-Curve Sample", "Sample point for F-Curve");
979         
980         /* Boolean values */
981         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
982         RNA_def_property_boolean_sdna(prop, NULL, "flag", 1);
983         RNA_def_property_ui_text(prop, "Selected", "Selection status");
984         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
985         
986         /* Vector value */
987         prop= RNA_def_property(srna, "point", PROP_FLOAT, PROP_XYZ);
988         RNA_def_property_float_sdna(prop, NULL, "vec");
989         RNA_def_property_array(prop, 2);
990         RNA_def_property_ui_text(prop, "Point", "Point coordinates");
991         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
992 }
993
994
995 /* duplicate of BezTriple in rna_curve.c
996  * but with F-Curve specific options updates/functionality 
997  */
998 static void rna_def_fkeyframe(BlenderRNA *brna)
999 {
1000         StructRNA *srna;
1001         PropertyRNA *prop;
1002         
1003         srna= RNA_def_struct(brna, "Keyframe", NULL);
1004         RNA_def_struct_sdna(srna, "BezTriple");
1005         RNA_def_struct_ui_text(srna, "Keyframe", "Bezier curve point with two handles defining a Keyframe on an F-Curve");
1006         
1007         /* Boolean values */
1008         prop= RNA_def_property(srna, "selected_handle1", PROP_BOOLEAN, PROP_NONE);
1009         RNA_def_property_boolean_sdna(prop, NULL, "f1", 0);
1010         RNA_def_property_ui_text(prop, "Handle 1 selected", "Handle 1 selection status");
1011         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
1012         
1013         prop= RNA_def_property(srna, "selected_handle2", PROP_BOOLEAN, PROP_NONE);
1014         RNA_def_property_boolean_sdna(prop, NULL, "f3", 0);
1015         RNA_def_property_ui_text(prop, "Handle 2 selected", "Handle 2 selection status");
1016         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
1017         
1018         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
1019         RNA_def_property_boolean_sdna(prop, NULL, "f2", 0);
1020         RNA_def_property_ui_text(prop, "Selected", "Control point selection status");
1021         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
1022         
1023         /* Enums */
1024         prop= RNA_def_property(srna, "handle1_type", PROP_ENUM, PROP_NONE);
1025         RNA_def_property_enum_sdna(prop, NULL, "h1");
1026         RNA_def_property_enum_items(prop, beztriple_handle_type_items);
1027         RNA_def_property_ui_text(prop, "Handle 1 Type", "Handle types");
1028         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
1029         
1030         prop= RNA_def_property(srna, "handle2_type", PROP_ENUM, PROP_NONE);
1031         RNA_def_property_enum_sdna(prop, NULL, "h2");
1032         RNA_def_property_enum_items(prop, beztriple_handle_type_items);
1033         RNA_def_property_ui_text(prop, "Handle 2 Type", "Handle types");
1034         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
1035         
1036         prop= RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
1037         RNA_def_property_enum_sdna(prop, NULL, "ipo");
1038         RNA_def_property_enum_items(prop, beztriple_interpolation_mode_items);
1039         RNA_def_property_ui_text(prop, "Interpolation", "Interpolation method to use for segment of the curve from this Keyframe until the next Keyframe");
1040         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
1041         
1042         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1043         RNA_def_property_enum_sdna(prop, NULL, "hide");
1044         RNA_def_property_enum_items(prop, beztriple_keyframe_type_items);
1045         RNA_def_property_ui_text(prop, "Type", "The type of keyframe");
1046         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
1047         
1048         /* Vector values */
1049         prop= RNA_def_property(srna, "handle1", PROP_FLOAT, PROP_TRANSLATION);
1050         RNA_def_property_array(prop, 2);
1051         RNA_def_property_float_funcs(prop, "rna_FKeyframe_handle1_get", "rna_FKeyframe_handle1_set", NULL);
1052         RNA_def_property_ui_text(prop, "Handle 1", "Coordinates of the first handle");
1053         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
1054         
1055         prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
1056         RNA_def_property_array(prop, 2);
1057         RNA_def_property_float_funcs(prop, "rna_FKeyframe_ctrlpoint_get", "rna_FKeyframe_ctrlpoint_set", NULL);
1058         RNA_def_property_ui_text(prop, "Control Point", "Coordinates of the control point");
1059         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
1060         
1061         prop= RNA_def_property(srna, "handle2", PROP_FLOAT, PROP_TRANSLATION);
1062         RNA_def_property_array(prop, 2);
1063         RNA_def_property_float_funcs(prop, "rna_FKeyframe_handle2_get", "rna_FKeyframe_handle2_set", NULL);
1064         RNA_def_property_ui_text(prop, "Handle 2", "Coordinates of the second handle");
1065         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_EDIT, NULL);
1066 }
1067
1068
1069 static void rna_def_fcurve_modifiers(BlenderRNA *brna, PropertyRNA *cprop)
1070 {
1071         /* add modifiers */
1072         StructRNA *srna;
1073         PropertyRNA *prop;
1074
1075         FunctionRNA *func;
1076         PropertyRNA *parm;
1077
1078         RNA_def_property_srna(cprop, "FCurveModifiers");
1079         srna= RNA_def_struct(brna, "FCurveModifiers", NULL);
1080         RNA_def_struct_sdna(srna, "FCurve");
1081         RNA_def_struct_ui_text(srna, "F-Curve Modifiers", "Collection of F-Curve Modifiers");
1082
1083
1084         /* Collection active property */
1085         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1086         RNA_def_property_struct_type(prop, "FModifier");
1087         RNA_def_property_pointer_funcs(prop, "rna_FCurve_active_modifier_get", "rna_FCurve_active_modifier_set", NULL);
1088         RNA_def_property_flag(prop, PROP_EDITABLE);
1089         RNA_def_property_ui_text(prop, "Active F-Curve Modifier", "Active F-Curve Modifier");
1090
1091         /* Constraint collection */
1092         func= RNA_def_function(srna, "new", "rna_FCurve_modifiers_new");
1093         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1094         RNA_def_function_ui_description(func, "Add a constraint to this object");
1095         /* return type */
1096         parm= RNA_def_pointer(func, "fmodifier", "FModifier", "", "New fmodifier.");
1097         RNA_def_function_return(func, parm);
1098         /* object to add */
1099         parm= RNA_def_enum(func, "type", fmodifier_type_items, 1, "", "Constraint type to add.");
1100         RNA_def_property_flag(parm, PROP_REQUIRED);
1101
1102         func= RNA_def_function(srna, "remove", "rna_FCurve_modifiers_remove");
1103         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1104         RNA_def_function_ui_description(func, "Remove a modifier from this fcurve.");
1105         /* return type */
1106         parm= RNA_def_boolean(func, "success", 0, "Success", "Removed the constraint successfully.");
1107         RNA_def_function_return(func, parm);
1108         /* object to add */
1109         parm= RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "", 0, INT_MAX);
1110         RNA_def_property_flag(parm, PROP_REQUIRED);
1111 }
1112
1113 static void rna_def_fcurve(BlenderRNA *brna)
1114 {
1115         StructRNA *srna;
1116         PropertyRNA *prop;
1117         
1118         static EnumPropertyItem prop_mode_extend_items[] = {
1119                 {FCURVE_EXTRAPOLATE_CONSTANT, "CONSTANT", 0, "Constant", ""},
1120                 {FCURVE_EXTRAPOLATE_LINEAR, "LINEAR", 0, "Linear", ""},
1121                 {0, NULL, 0, NULL, NULL}};
1122         static EnumPropertyItem prop_mode_color_items[] = {
1123                 {FCURVE_COLOR_AUTO_RAINBOW, "AUTO_RAINBOW", 0, "Auto Rainbow", ""},
1124                 {FCURVE_COLOR_AUTO_RGB, "AUTO_RGB", 0, "Auto XYZ to RGB", ""},
1125                 {FCURVE_COLOR_CUSTOM, "CUSTOM", 0, "User Defined", ""},
1126                 {0, NULL, 0, NULL, NULL}};
1127
1128         srna= RNA_def_struct(brna, "FCurve", NULL);
1129         RNA_def_struct_ui_text(srna, "F-Curve", "F-Curve defining values of a period of time");
1130         RNA_def_struct_ui_icon(srna, ICON_ANIM_DATA);
1131
1132         /* Enums */
1133         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
1134         RNA_def_property_enum_sdna(prop, NULL, "extend");
1135         RNA_def_property_enum_items(prop, prop_mode_extend_items);
1136         RNA_def_property_ui_text(prop, "Extrapolation", "");
1137         RNA_def_property_update(prop, NC_ANIMATION, NULL);      // XXX need an update callback for this so that animation gets evaluated
1138
1139         /* Pointers */
1140         prop= RNA_def_property(srna, "driver", PROP_POINTER, PROP_NONE);
1141         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1142         RNA_def_property_ui_text(prop, "Driver", "Channel Driver (only set for Driver F-Curves)");
1143         
1144         prop= RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
1145         RNA_def_property_pointer_sdna(prop, NULL, "grp");
1146         RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX this is not editable for now, since editing this will easily break the visible hierarchy
1147         RNA_def_property_ui_text(prop, "Group", "Action Group that this F-Curve belongs to");
1148         RNA_def_property_update(prop, NC_ANIMATION|ND_FCURVES_ORDER, NULL);
1149         
1150         /* Path + Array Index */
1151         prop= RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
1152         RNA_def_property_string_funcs(prop, "rna_FCurve_RnaPath_get", "rna_FCurve_RnaPath_length", "rna_FCurve_RnaPath_set");
1153         RNA_def_property_ui_text(prop, "Data Path", "RNA Path to property affected by F-Curve");
1154         RNA_def_property_update(prop, NC_ANIMATION, NULL);      // XXX need an update callback for this to that animation gets evaluated
1155         
1156         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
1157         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific property affected by F-Curve if applicable");
1158         RNA_def_property_update(prop, NC_ANIMATION, NULL);      // XXX need an update callback for this so that animation gets evaluated
1159         
1160         /* Color */
1161         prop= RNA_def_property(srna, "color_mode", PROP_ENUM, PROP_NONE);
1162         RNA_def_property_enum_items(prop, prop_mode_color_items);
1163         RNA_def_property_ui_text(prop, "Color Mode", "Method used to determine color of F-Curve in Graph Editor");
1164         RNA_def_property_update(prop, NC_ANIMATION, NULL);      
1165         
1166         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
1167         RNA_def_property_array(prop, 3);
1168         RNA_def_property_ui_text(prop, "Color", "Color of the F-Curve in the Graph Editor");
1169         RNA_def_property_update(prop, NC_ANIMATION, NULL);      
1170         
1171         /* Flags */
1172         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
1173         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_SELECTED);
1174         RNA_def_property_ui_text(prop, "Selected", "F-Curve is selected for editing");
1175         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
1176         
1177         prop= RNA_def_property(srna, "locked", PROP_BOOLEAN, PROP_NONE);
1178         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_PROTECTED);
1179         RNA_def_property_ui_text(prop, "Locked", "F-Curve's settings cannot be edited");
1180         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN_EDIT, NULL);
1181         
1182         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
1183         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_MUTED);
1184         RNA_def_property_ui_text(prop, "Muted", "F-Curve is not evaluated");
1185         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN_EDIT, NULL);
1186         
1187         prop= RNA_def_property(srna, "auto_clamped_handles", PROP_BOOLEAN, PROP_NONE);
1188         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_AUTO_HANDLES);
1189         RNA_def_property_ui_text(prop, "Auto Clamped Handles", "All auto-handles for F-Curve are clamped");
1190         RNA_def_property_update(prop, NC_ANIMATION|ND_KEYFRAME_PROP, NULL);
1191         
1192         prop= RNA_def_property(srna, "visible", PROP_BOOLEAN, PROP_NONE);
1193         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_VISIBLE);
1194         RNA_def_property_ui_text(prop, "Visible", "F-Curve and its keyframes are shown in the Graph Editor graphs");
1195         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_GRAPH, NULL);
1196         
1197         /* Collections */
1198         prop= RNA_def_property(srna, "sampled_points", PROP_COLLECTION, PROP_NONE);
1199         RNA_def_property_collection_sdna(prop, NULL, "fpt", "totvert");
1200         RNA_def_property_struct_type(prop, "FCurveSample");
1201         RNA_def_property_ui_text(prop, "Sampled Points", "Sampled animation data");
1202
1203         prop= RNA_def_property(srna, "keyframe_points", PROP_COLLECTION, PROP_NONE);
1204         RNA_def_property_collection_sdna(prop, NULL, "bezt", "totvert");
1205         RNA_def_property_struct_type(prop, "Keyframe");
1206         RNA_def_property_ui_text(prop, "Keyframes", "User-editable keyframes");
1207         
1208         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
1209         RNA_def_property_struct_type(prop, "FModifier");
1210         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the shape of the F-Curve");
1211
1212         rna_def_fcurve_modifiers(brna, prop);
1213 }
1214
1215 /* *********************** */
1216
1217 void RNA_def_fcurve(BlenderRNA *brna)
1218 {
1219         rna_def_fcurve(brna);
1220                 rna_def_fkeyframe(brna);
1221                 rna_def_fpoint(brna);
1222         
1223         rna_def_drivertarget(brna);
1224         rna_def_drivervar(brna);
1225         rna_def_channeldriver(brna);
1226         
1227         rna_def_fmodifier(brna);
1228         
1229         rna_def_fmodifier_generator(brna);
1230         rna_def_fmodifier_function_generator(brna);
1231         rna_def_fmodifier_envelope(brna);
1232                 rna_def_fmodifier_envelope_ctrl(brna);
1233         rna_def_fmodifier_cycles(brna);
1234         rna_def_fmodifier_python(brna);
1235         rna_def_fmodifier_limits(brna);
1236         rna_def_fmodifier_noise(brna);
1237         rna_def_fmodifier_stepped(brna);
1238 }
1239
1240
1241 #endif