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