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