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