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