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