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