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