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