all remove functions now invalidate the RNA objects passed, to help script authors...
[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", ""},*/ /* FIXME: not implemented yet! */
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 static 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 static void rna_Driver_remove_variable(ChannelDriver *driver, ReportList *reports, PointerRNA *dvar_ptr)
413 {
414         DriverVar *dvar = dvar_ptr->data;
415         if (BLI_findindex(&driver->variables, dvar) == -1) {
416                 BKE_report(reports, RPT_ERROR, "Variable does not exist in this driver");
417                 return;
418         }
419
420         driver_free_variable(driver, dvar);
421         RNA_POINTER_INVALIDATE(dvar_ptr);
422 }
423
424
425 static PointerRNA rna_FCurve_active_modifier_get(PointerRNA *ptr)
426 {
427         FCurve *fcu = (FCurve *)ptr->data;
428         FModifier *fcm = find_active_fmodifier(&fcu->modifiers);
429         return rna_pointer_inherit_refine(ptr, &RNA_FModifier, fcm);
430 }
431
432 static void rna_FCurve_active_modifier_set(PointerRNA *ptr, PointerRNA value)
433 {
434         FCurve *fcu = (FCurve *)ptr->data;
435         set_active_fmodifier(&fcu->modifiers, (FModifier *)value.data);
436 }
437
438 static FModifier *rna_FCurve_modifiers_new(FCurve *fcu, int type)
439 {
440         return add_fmodifier(&fcu->modifiers, type);
441 }
442
443 static void rna_FCurve_modifiers_remove(FCurve *fcu, ReportList *reports, PointerRNA *fcm_ptr)
444 {
445         FModifier *fcm = fcm_ptr->data;
446         if (BLI_findindex(&fcu->modifiers, fcm) == -1) {
447                 BKE_reportf(reports, RPT_ERROR, "F-Curve modifier '%s' not found in F-Curve", fcm->name);
448                 return;
449         }
450
451         remove_fmodifier(&fcu->modifiers, fcm);
452         RNA_POINTER_INVALIDATE(fcm_ptr);
453 }
454
455 static void rna_FModifier_active_set(PointerRNA *ptr, int UNUSED(value))
456 {
457         FModifier *fm = (FModifier *)ptr->data;
458
459         /* don't toggle, always switch on */
460         fm->flag |= FMODIFIER_FLAG_ACTIVE;
461 }
462
463 static void rna_FModifier_start_frame_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
464 {
465         FModifier *fcm = (FModifier *)ptr->data;
466         
467         *min = MINAFRAMEF;
468         *max = (fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) ? fcm->efra : MAXFRAMEF;
469 }
470
471 static void rna_FModifier_end_frame_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
472 {
473         FModifier *fcm = (FModifier *)ptr->data;
474
475         *min = (fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) ? fcm->sfra : MINAFRAMEF;
476         *max = MAXFRAMEF;
477 }
478
479 static void rna_FModifier_blending_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
480 {
481         FModifier *fcm = (FModifier *)ptr->data;
482
483         *min = 0.0f;
484         *max = fcm->efra - fcm->sfra;
485 }
486
487 static void rna_FModifier_active_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
488 {
489         FModifier *fm, *fmo = (FModifier *)ptr->data;
490
491         /* clear active state of other FModifiers in this list */
492         for (fm = fmo->prev; fm; fm = fm->prev) {
493                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
494         }
495         for (fm = fmo->next; fm; fm = fm->next) {
496                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
497         }
498         
499 }
500
501 static int rna_FModifierGenerator_coefficients_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
502 {
503         FModifier *fcm = (FModifier *)ptr->data;
504         FMod_Generator *gen = fcm->data;
505
506         if (gen)
507                 length[0] = gen->arraysize;
508         else
509                 length[0] = 100;  /* for raw_access, untested */
510
511         return length[0];
512 }
513
514 static void rna_FModifierGenerator_coefficients_get(PointerRNA *ptr, float *values)
515 {
516         FModifier *fcm = (FModifier *)ptr->data;
517         FMod_Generator *gen = fcm->data;
518         memcpy(values, gen->coefficients, gen->arraysize * sizeof(float));
519 }
520
521 static void rna_FModifierGenerator_coefficients_set(PointerRNA *ptr, const float *values)
522 {
523         FModifier *fcm = (FModifier *)ptr->data;
524         FMod_Generator *gen = fcm->data;
525         memcpy(gen->coefficients, values, gen->arraysize * sizeof(float));
526 }
527
528 static void rna_FModifierLimits_minx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
529 {
530         FModifier *fcm = (FModifier *)ptr->data;
531         FMod_Limits *data = fcm->data;
532
533         *min = MINAFRAMEF;
534         *max = (data->flag & FCM_LIMIT_XMAX) ? data->rect.xmax : MAXFRAMEF;
535 }
536
537 static void rna_FModifierLimits_maxx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
538 {
539         FModifier *fcm = (FModifier *)ptr->data;
540         FMod_Limits *data = fcm->data;
541
542         *min = (data->flag & FCM_LIMIT_XMIN) ? data->rect.xmin : MINAFRAMEF;
543         *max = MAXFRAMEF;
544 }
545
546 static void rna_FModifierLimits_miny_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
547 {
548         FModifier *fcm = (FModifier *)ptr->data;
549         FMod_Limits *data = fcm->data;
550
551         *min = -FLT_MAX;
552         *max = (data->flag & FCM_LIMIT_YMAX) ? data->rect.ymax : FLT_MAX;
553 }
554
555 static void rna_FModifierLimits_maxy_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
556 {
557         FModifier *fcm = (FModifier *)ptr->data;
558         FMod_Limits *data = fcm->data;
559
560         *min = (data->flag & FCM_LIMIT_YMIN) ? data->rect.ymin : -FLT_MAX;
561         *max = FLT_MAX;
562 }
563
564
565 static void rna_FModifierStepped_start_frame_range(PointerRNA *ptr, float *min, float *max,
566                                                    float *softmin, float *softmax)
567 {
568         FModifier *fcm = (FModifier *)ptr->data;
569         FMod_Stepped *data = fcm->data;
570         
571         *min = MINAFRAMEF;
572         *max = (data->flag & FCM_STEPPED_NO_AFTER) ? data->end_frame : MAXFRAMEF;
573 }
574
575 static void rna_FModifierStepped_end_frame_range(PointerRNA *ptr, float *min, float *max,
576                                                  float *softmin, float *softmax)
577 {
578         FModifier *fcm = (FModifier *)ptr->data;
579         FMod_Stepped *data = fcm->data;
580
581         *min = (data->flag & FCM_STEPPED_NO_BEFORE) ? data->start_frame : MINAFRAMEF;
582         *max = MAXFRAMEF;
583 }
584
585 static BezTriple *rna_FKeyframe_points_insert(FCurve *fcu, float frame, float value, int flag)
586 {
587         int index = insert_vert_fcurve(fcu, frame, value, flag);
588         return ((fcu->bezt) && (index >= 0)) ? (fcu->bezt + index) : NULL;
589 }
590
591 static void rna_FKeyframe_points_add(FCurve *fcu, int tot)
592 {
593         if (tot > 0) {
594                 BezTriple *bezt;
595                 if (fcu->totvert) {
596                         BezTriple *nbezt = MEM_callocN(sizeof(BezTriple) * (fcu->totvert + tot), "rna_FKeyframe_points_add");
597                         memcpy(nbezt, fcu->bezt, sizeof(BezTriple) * fcu->totvert);
598                         MEM_freeN(fcu->bezt);
599                         fcu->bezt = nbezt;
600                 }
601                 else {
602                         fcu->bezt = MEM_callocN(sizeof(BezTriple) * tot, "rna_FKeyframe_points_add");
603                 }
604                 
605                 bezt = fcu->bezt + fcu->totvert;
606                 fcu->totvert += tot;
607                 
608                 while (tot--) {
609                         /* defaults, no userprefs gives predictable results for API */
610                         bezt->f1 = bezt->f2 = bezt->f3 = SELECT;
611                         bezt->ipo = BEZT_IPO_BEZ;
612                         bezt->h1 = bezt->h2 = HD_AUTO_ANIM;
613                         bezt++;
614                 }
615         }
616 }
617
618 static void rna_FKeyframe_points_remove(FCurve *fcu, ReportList *reports, PointerRNA *bezt_ptr, int do_fast)
619 {
620         BezTriple *bezt = bezt_ptr->data;
621         int index = (int)(bezt - fcu->bezt);
622         if (index < 0 || index >= fcu->totvert) {
623                 BKE_report(reports, RPT_ERROR, "Keyframe not in F-Curve");
624                 return;
625         }
626
627         delete_fcurve_key(fcu, index, !do_fast);
628         RNA_POINTER_INVALIDATE(bezt_ptr);
629 }
630
631 static void rna_fcurve_range(FCurve *fcu, float range[2])
632 {
633         calc_fcurve_range(fcu, range, range + 1, FALSE, FALSE);
634 }
635
636 #else
637
638 static void rna_def_fmodifier_generator(BlenderRNA *brna)
639 {
640         StructRNA *srna;
641         PropertyRNA *prop;
642         
643         static EnumPropertyItem generator_mode_items[] = {
644                 {FCM_GENERATOR_POLYNOMIAL, "POLYNOMIAL", 0, "Expanded Polynomial", ""},
645                 {FCM_GENERATOR_POLYNOMIAL_FACTORISED, "POLYNOMIAL_FACTORISED", 0, "Factorized Polynomial", ""},
646                 {0, NULL, 0, NULL, NULL}
647         };
648         
649         srna = RNA_def_struct(brna, "FModifierGenerator", "FModifier");
650         RNA_def_struct_ui_text(srna, "Generator F-Modifier", "Deterministically generate values for the modified F-Curve");
651         RNA_def_struct_sdna_from(srna, "FMod_Generator", "data");
652         
653         /* define common props */
654         prop = RNA_def_property(srna, "use_additive", PROP_BOOLEAN, PROP_NONE);
655         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
656         RNA_def_property_ui_text(prop, "Additive",
657                                  "Values generated by this modifier are applied on top of "
658                                  "the existing values instead of overwriting them");
659         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
660         
661         /* XXX this has a special validation func */
662         prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
663         RNA_def_property_enum_items(prop, generator_mode_items);
664         RNA_def_property_ui_text(prop, "Mode", "Type of generator to use");
665         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
666         
667         
668         /* order of the polynomial */
669         /* XXX this has a special validation func */
670         prop = RNA_def_property(srna, "poly_order", PROP_INT, PROP_NONE);
671         RNA_def_property_ui_text(prop, "Polynomial Order",
672                                  "The highest power of 'x' for this polynomial (number of coefficients - 1)");
673         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
674         
675         /* coefficients array */
676         prop = RNA_def_property(srna, "coefficients", PROP_FLOAT, PROP_NONE);
677         RNA_def_property_array(prop, 32);
678         RNA_def_property_flag(prop, PROP_DYNAMIC);
679         RNA_def_property_dynamic_array_funcs(prop, "rna_FModifierGenerator_coefficients_get_length");
680         RNA_def_property_float_funcs(prop, "rna_FModifierGenerator_coefficients_get",
681                                      "rna_FModifierGenerator_coefficients_set", NULL);
682         RNA_def_property_ui_text(prop, "Coefficients", "Coefficients for 'x' (starting from lowest power of x^0)");
683 }
684
685 /* --------- */
686
687 static void rna_def_fmodifier_function_generator(BlenderRNA *brna)
688 {
689         StructRNA *srna;
690         PropertyRNA *prop;
691         
692         static EnumPropertyItem prop_type_items[] = {
693                 {0, "SIN", 0, "Sine", ""},
694                 {1, "COS", 0, "Cosine", ""},
695                 {2, "TAN", 0, "Tangent", ""},
696                 {3, "SQRT", 0, "Square Root", ""},
697                 {4, "LN", 0, "Natural Logarithm", ""},
698                 {5, "SINC", 0, "Normalized Sine", "sin(x) / x"},
699                 {0, NULL, 0, NULL, NULL}
700         };
701         
702         srna = RNA_def_struct(brna, "FModifierFunctionGenerator", "FModifier");
703         RNA_def_struct_ui_text(srna, "Built-In Function F-Modifier", "Generate values using a Built-In Function");
704         RNA_def_struct_sdna_from(srna, "FMod_FunctionGenerator", "data");
705         
706         /* coefficients */
707         prop = RNA_def_property(srna, "amplitude", PROP_FLOAT, PROP_NONE);
708         RNA_def_property_ui_text(prop, "Amplitude", "Scale factor determining the maximum/minimum values");
709         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
710         
711         prop = RNA_def_property(srna, "phase_multiplier", PROP_FLOAT, PROP_NONE);
712         RNA_def_property_ui_text(prop, "Phase Multiplier", "Scale factor determining the 'speed' of the function");
713         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
714         
715         prop = RNA_def_property(srna, "phase_offset", PROP_FLOAT, PROP_NONE);
716         RNA_def_property_ui_text(prop, "Phase Offset", "Constant factor to offset time by for function");
717         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
718         
719         prop = RNA_def_property(srna, "value_offset", PROP_FLOAT, PROP_NONE);
720         RNA_def_property_ui_text(prop, "Value Offset", "Constant factor to offset values by");
721         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
722         
723         /* flags */
724         prop = RNA_def_property(srna, "use_additive", PROP_BOOLEAN, PROP_NONE);
725         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_GENERATOR_ADDITIVE);
726         RNA_def_property_ui_text(prop, "Additive",
727                                  "Values generated by this modifier are applied on top of "
728                                  "the existing values instead of overwriting them");
729         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
730         
731         prop = RNA_def_property(srna, "function_type", PROP_ENUM, PROP_NONE);
732         RNA_def_property_enum_sdna(prop, NULL, "type");
733         RNA_def_property_enum_items(prop, prop_type_items);
734         RNA_def_property_ui_text(prop, "Type", "Type of built-in function to use");
735         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
736 }
737
738 /* --------- */
739
740 static void rna_def_fmodifier_envelope_ctrl(BlenderRNA *brna)
741 {
742         StructRNA *srna;
743         PropertyRNA *prop;
744         
745         srna = RNA_def_struct(brna, "FModifierEnvelopeControlPoint", NULL);
746         RNA_def_struct_ui_text(srna, "Envelope Control Point", "Control point for envelope F-Modifier");
747         RNA_def_struct_sdna(srna, "FCM_EnvelopeData");
748         
749         /* min/max extents
750          *      - for now, these are allowed to go past each other, so that we can have inverted action
751          *      - technically, the range is limited by the settings in the envelope-modifier data, not here...
752          */
753         prop = RNA_def_property(srna, "min", PROP_FLOAT, PROP_NONE);
754         RNA_def_property_float_sdna(prop, NULL, "min");
755         RNA_def_property_ui_text(prop, "Minimum Value", "Lower bound of envelope at this control-point");
756         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
757         
758         prop = RNA_def_property(srna, "max", PROP_FLOAT, PROP_NONE);
759         RNA_def_property_float_sdna(prop, NULL, "max");
760         RNA_def_property_ui_text(prop, "Maximum Value", "Upper bound of envelope at this control-point");
761         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
762         
763         /* Frame */
764         prop = RNA_def_property(srna, "frame", PROP_FLOAT, PROP_TIME);
765         RNA_def_property_float_sdna(prop, NULL, "time");
766         RNA_def_property_ui_text(prop, "Frame", "Frame this control-point occurs on");
767         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
768         
769         /* TODO: */
770         /*      - selection flags (not implemented in UI yet though) */
771 }
772
773 static void rna_def_fmodifier_envelope(BlenderRNA *brna)
774 {
775         StructRNA *srna;
776         PropertyRNA *prop;
777         
778         srna = RNA_def_struct(brna, "FModifierEnvelope", "FModifier");
779         RNA_def_struct_ui_text(srna, "Envelope F-Modifier", "Scale the values of the modified F-Curve");
780         RNA_def_struct_sdna_from(srna, "FMod_Envelope", "data");
781         
782         /* Collections */
783         prop = RNA_def_property(srna, "control_points", PROP_COLLECTION, PROP_NONE);
784         RNA_def_property_collection_sdna(prop, NULL, "data", "totvert");
785         RNA_def_property_struct_type(prop, "FModifierEnvelopeControlPoint");
786         RNA_def_property_ui_text(prop, "Control Points", "Control points defining the shape of the envelope");
787         
788         /* Range Settings */
789         prop = RNA_def_property(srna, "reference_value", PROP_FLOAT, PROP_NONE);
790         RNA_def_property_float_sdna(prop, NULL, "midval");
791         RNA_def_property_ui_text(prop, "Reference Value", "Value that envelope's influence is centered around / based on");
792         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
793         
794         prop = RNA_def_property(srna, "default_min", PROP_FLOAT, PROP_NONE);
795         RNA_def_property_float_sdna(prop, NULL, "min");
796         RNA_def_property_ui_text(prop, "Default Minimum", "Lower distance from Reference Value for 1:1 default influence");
797         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
798         
799         prop = RNA_def_property(srna, "default_max", PROP_FLOAT, PROP_NONE);
800         RNA_def_property_float_sdna(prop, NULL, "max");
801         RNA_def_property_ui_text(prop, "Default Maximum", "Upper distance from Reference Value for 1:1 default influence");
802         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
803 }
804
805 /* --------- */
806
807 static void rna_def_fmodifier_cycles(BlenderRNA *brna)
808 {
809         StructRNA *srna;
810         PropertyRNA *prop;
811         
812         static EnumPropertyItem prop_type_items[] = {
813                 {FCM_EXTRAPOLATE_NONE, "NONE", 0, "No Cycles", "Don't do anything"},
814                 {FCM_EXTRAPOLATE_CYCLIC, "REPEAT", 0, "Repeat Motion", "Repeat keyframe range as-is"},
815                 {FCM_EXTRAPOLATE_CYCLIC_OFFSET, "REPEAT_OFFSET", 0, "Repeat with Offset",
816                                                 "Repeat keyframe range, but with offset based on gradient between "
817                                                 "start and end values"},
818                 {FCM_EXTRAPOLATE_MIRROR, "MIRROR", 0, "Repeat Mirrored",
819                                          "Alternate between forward and reverse playback of keyframe range"},
820                 {0, NULL, 0, NULL, NULL}
821         };
822         
823         srna = RNA_def_struct(brna, "FModifierCycles", "FModifier");
824         RNA_def_struct_ui_text(srna, "Cycles F-Modifier", "Repeat the values of the modified F-Curve");
825         RNA_def_struct_sdna_from(srna, "FMod_Cycles", "data");
826         
827         /* before */
828         prop = RNA_def_property(srna, "mode_before", PROP_ENUM, PROP_NONE);
829         RNA_def_property_enum_sdna(prop, NULL, "before_mode");
830         RNA_def_property_enum_items(prop, prop_type_items);
831         RNA_def_property_ui_text(prop, "Before Mode", "Cycling mode to use before first keyframe");
832         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
833         
834         prop = RNA_def_property(srna, "cycles_before", PROP_INT, PROP_NONE);
835         RNA_def_property_int_sdna(prop, NULL, "before_cycles");
836         RNA_def_property_ui_text(prop, "Before Cycles",
837                                  "Maximum number of cycles to allow before first keyframe (0 = infinite)");
838         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
839         
840         /* after */
841         prop = RNA_def_property(srna, "mode_after", PROP_ENUM, PROP_NONE);
842         RNA_def_property_enum_sdna(prop, NULL, "after_mode");
843         RNA_def_property_enum_items(prop, prop_type_items);
844         RNA_def_property_ui_text(prop, "After Mode", "Cycling mode to use after last keyframe");
845         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
846         
847         prop = RNA_def_property(srna, "cycles_after", PROP_INT, PROP_NONE);
848         RNA_def_property_int_sdna(prop, NULL, "after_cycles");
849         RNA_def_property_ui_text(prop, "After Cycles",
850                                  "Maximum number of cycles to allow after last keyframe (0 = infinite)");
851         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
852 }
853
854 /* --------- */
855
856 static void rna_def_fmodifier_python(BlenderRNA *brna)
857 {
858         StructRNA *srna;
859         /*PropertyRNA *prop; */
860         
861         srna = RNA_def_struct(brna, "FModifierPython", "FModifier");
862         RNA_def_struct_ui_text(srna, "Python F-Modifier", "Perform user-defined operation on the modified F-Curve");
863         RNA_def_struct_sdna_from(srna, "FMod_Python", "data");
864 }
865
866 /* --------- */
867
868 static void rna_def_fmodifier_limits(BlenderRNA *brna)
869 {
870         StructRNA *srna;
871         PropertyRNA *prop;
872         
873         srna = RNA_def_struct(brna, "FModifierLimits", "FModifier");
874         RNA_def_struct_ui_text(srna, "Limit F-Modifier", "Limit the time/value ranges of the modified F-Curve");
875         RNA_def_struct_sdna_from(srna, "FMod_Limits", "data");
876         
877         prop = RNA_def_property(srna, "use_min_x", PROP_BOOLEAN, PROP_NONE);
878         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMIN);
879         RNA_def_property_ui_text(prop, "Minimum X", "Use the minimum X value");
880         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
881         
882         prop = RNA_def_property(srna, "use_min_y", PROP_BOOLEAN, PROP_NONE);
883         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMIN);
884         RNA_def_property_ui_text(prop, "Minimum Y", "Use the minimum Y value");
885         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
886         
887         prop = RNA_def_property(srna, "use_max_x", PROP_BOOLEAN, PROP_NONE);
888         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_XMAX);
889         RNA_def_property_ui_text(prop, "Maximum X", "Use the maximum X value");
890         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
891         
892         prop = RNA_def_property(srna, "use_max_y", PROP_BOOLEAN, PROP_NONE);
893         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_LIMIT_YMAX);
894         RNA_def_property_ui_text(prop, "Maximum Y", "Use the maximum Y value");
895         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
896         
897         prop = RNA_def_property(srna, "min_x", PROP_FLOAT, PROP_NONE);
898         RNA_def_property_float_sdna(prop, NULL, "rect.xmin");
899         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierLimits_minx_range");
900         RNA_def_property_ui_text(prop, "Minimum X", "Lowest X value to allow");
901         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
902         
903         prop = RNA_def_property(srna, "min_y", PROP_FLOAT, PROP_NONE);
904         RNA_def_property_float_sdna(prop, NULL, "rect.ymin");
905         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierLimits_miny_range");
906         RNA_def_property_ui_text(prop, "Minimum Y", "Lowest Y value to allow");
907         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
908         
909         prop = RNA_def_property(srna, "max_x", PROP_FLOAT, PROP_NONE);
910         RNA_def_property_float_sdna(prop, NULL, "rect.xmax");
911         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierLimits_maxx_range");
912         RNA_def_property_ui_text(prop, "Maximum X", "Highest X value to allow");
913         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
914         
915         prop = RNA_def_property(srna, "max_y", PROP_FLOAT, PROP_NONE);
916         RNA_def_property_float_sdna(prop, NULL, "rect.ymax");
917         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierLimits_maxy_range");
918         RNA_def_property_ui_text(prop, "Maximum Y", "Highest Y value to allow");
919         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
920 }
921
922 /* --------- */
923
924 static void rna_def_fmodifier_noise(BlenderRNA *brna)
925 {
926         StructRNA *srna;
927         PropertyRNA *prop;
928         
929         static EnumPropertyItem prop_modification_items[] = {
930                 {FCM_NOISE_MODIF_REPLACE, "REPLACE", 0, "Replace", ""},
931                 {FCM_NOISE_MODIF_ADD, "ADD", 0, "Add", ""},
932                 {FCM_NOISE_MODIF_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
933                 {FCM_NOISE_MODIF_MULTIPLY, "MULTIPLY", 0, "Multiply", ""},
934                 {0, NULL, 0, NULL, NULL}
935         };
936         
937         srna = RNA_def_struct(brna, "FModifierNoise", "FModifier");
938         RNA_def_struct_ui_text(srna, "Noise F-Modifier", "Give randomness to the modified F-Curve");
939         RNA_def_struct_sdna_from(srna, "FMod_Noise", "data");
940         
941         prop = RNA_def_property(srna, "blend_type", PROP_ENUM, PROP_NONE);
942         RNA_def_property_enum_sdna(prop, NULL, "modification");
943         RNA_def_property_enum_items(prop, prop_modification_items);
944         RNA_def_property_ui_text(prop, "Blend Type", "Method of modifying the existing F-Curve");
945         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
946         
947         prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
948         RNA_def_property_float_sdna(prop, NULL, "size");
949         RNA_def_property_ui_text(prop, "Scale", "Scaling (in time) of the noise");
950         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
951         
952         prop = RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
953         RNA_def_property_float_sdna(prop, NULL, "strength");
954         RNA_def_property_ui_text(prop, "Strength",
955                                  "Amplitude of the noise - the amount that it modifies the underlying curve");
956         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
957         
958         prop = RNA_def_property(srna, "phase", PROP_FLOAT, PROP_NONE);
959         RNA_def_property_float_sdna(prop, NULL, "phase");
960         RNA_def_property_ui_text(prop, "Phase", "A random seed for the noise effect");
961         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
962         
963         prop = RNA_def_property(srna, "depth", PROP_INT, PROP_UNSIGNED);
964         RNA_def_property_int_sdna(prop, NULL, "depth");
965         RNA_def_property_ui_text(prop, "Depth", "Amount of fine level detail present in the noise");
966         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
967
968 }
969
970 /* --------- */
971
972 static void rna_def_fmodifier_stepped(BlenderRNA *brna)
973 {
974         StructRNA *srna;
975         PropertyRNA *prop;
976         
977         srna = RNA_def_struct(brna, "FModifierStepped", "FModifier");
978         RNA_def_struct_ui_text(srna, "Stepped Interpolation F-Modifier",
979                                "Hold each interpolated value from the F-Curve for several frames without "
980                                "changing the timing");
981         RNA_def_struct_sdna_from(srna, "FMod_Stepped", "data");
982         
983         /* properties */
984         prop = RNA_def_property(srna, "frame_step", PROP_FLOAT, PROP_NONE);
985         RNA_def_property_float_sdna(prop, NULL, "step_size");
986         RNA_def_property_ui_text(prop, "Step Size", "Number of frames to hold each value");
987         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
988         
989         prop = RNA_def_property(srna, "frame_offset", PROP_FLOAT, PROP_NONE);
990         RNA_def_property_float_sdna(prop, NULL, "offset");
991         RNA_def_property_ui_text(prop, "Offset",
992                                  "Reference number of frames before frames get held "
993                                  "(use to get hold for '1-3' vs '5-7' holding patterns)");
994         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
995         
996         prop = RNA_def_property(srna, "use_frame_start", PROP_BOOLEAN, PROP_NONE);
997         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_STEPPED_NO_BEFORE);
998         RNA_def_property_ui_text(prop, "Use Start Frame", "Restrict modifier to only act after its 'start' frame");
999         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1000         
1001         prop = RNA_def_property(srna, "use_frame_end", PROP_BOOLEAN, PROP_NONE);
1002         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCM_STEPPED_NO_AFTER);
1003         RNA_def_property_ui_text(prop, "Use End Frame", "Restrict modifier to only act before its 'end' frame");
1004         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1005         
1006         prop = RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_NONE);
1007         RNA_def_property_float_sdna(prop, NULL, "start_frame");
1008         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierStepped_start_frame_range");
1009         RNA_def_property_ui_text(prop, "Start Frame", "Frame that modifier's influence starts (if applicable)");
1010         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1011         
1012         prop = RNA_def_property(srna, "frame_end", PROP_FLOAT, PROP_NONE);
1013         RNA_def_property_float_sdna(prop, NULL, "end_frame");
1014         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifierStepped_end_frame_range");
1015         RNA_def_property_ui_text(prop, "End Frame", "Frame that modifier's influence ends (if applicable)");
1016         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1017 }
1018
1019 /* --------- */
1020
1021
1022 static void rna_def_fmodifier(BlenderRNA *brna)
1023 {
1024         StructRNA *srna;
1025         PropertyRNA *prop;
1026         
1027         /* base struct definition */
1028         srna = RNA_def_struct(brna, "FModifier", NULL);
1029         RNA_def_struct_refine_func(srna, "rna_FModifierType_refine");
1030         RNA_def_struct_ui_text(srna, "F-Modifier", "Modifier for values of F-Curve");
1031         
1032 #if 0 /* XXX not used yet */
1033           /* name */
1034         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1035         RNA_def_struct_name_property(srna, prop);
1036         RNA_def_property_ui_text(prop, "Name", "Short description of F-Curve Modifier");
1037 #endif /* XXX not used yet */
1038         
1039         /* type */
1040         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1041         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1042         RNA_def_property_enum_items(prop, fmodifier_type_items);
1043         RNA_def_property_ui_text(prop, "Type", "F-Curve Modifier Type");
1044         
1045         /* settings */
1046         prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
1047         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_EXPANDED);
1048         RNA_def_property_ui_text(prop, "Expanded", "F-Curve Modifier's panel is expanded in UI");
1049         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);
1050         
1051         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
1052         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_MUTED);
1053         RNA_def_property_ui_text(prop, "Muted", "F-Curve Modifier will not be evaluated");
1054         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1055         RNA_def_property_ui_icon(prop, ICON_MUTE_IPO_OFF, 1);
1056         
1057         prop = RNA_def_property(srna, "is_valid", PROP_BOOLEAN, PROP_NONE);
1058         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1059         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", FMODIFIER_FLAG_DISABLED);
1060         RNA_def_property_ui_text(prop, "Disabled", "F-Curve Modifier has invalid settings and will not be evaluated");
1061         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1062         
1063         /* TODO: setting this to true must ensure that all others in stack are turned off too... */
1064         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
1065         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_ACTIVE);
1066         RNA_def_property_ui_text(prop, "Active", "F-Curve Modifier is the one being edited ");
1067         RNA_def_property_boolean_funcs(prop, NULL, "rna_FModifier_active_set");
1068         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, "rna_FModifier_active_update");
1069         RNA_def_property_ui_icon(prop, ICON_RADIOBUT_OFF, 1);
1070         
1071         /* restricted range */
1072         prop = RNA_def_property(srna, "use_restricted_range", PROP_BOOLEAN, PROP_NONE);
1073         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_RANGERESTRICT);
1074         RNA_def_property_ui_text(prop, "Restrict Frame Range",
1075                                  "F-Curve Modifier is only applied for the specified frame range to help "
1076                                  "mask off effects in order to chain them");
1077         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1078         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1); /* XXX: depends on UI implementation */
1079         
1080         prop = RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_NONE);
1081         RNA_def_property_float_sdna(prop, NULL, "sfra");
1082         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifier_start_frame_range");
1083         RNA_def_property_ui_text(prop, "Start Frame",
1084                                  "Frame that modifier's influence starts (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, "frame_end", PROP_FLOAT, PROP_NONE);
1088         RNA_def_property_float_sdna(prop, NULL, "efra");
1089         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifier_end_frame_range");
1090         RNA_def_property_ui_text(prop, "End Frame",
1091                                  "Frame that modifier's influence ends (if Restrict Frame Range is in use)");
1092         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1093         
1094         prop = RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
1095         RNA_def_property_float_sdna(prop, NULL, "blendin");
1096         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifier_blending_range");
1097         RNA_def_property_ui_text(prop, "Blend In", "Number of frames from start frame for influence to take effect");
1098         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1099         
1100         prop = RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
1101         RNA_def_property_float_sdna(prop, NULL, "blendout");
1102         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_FModifier_blending_range");
1103         RNA_def_property_ui_text(prop, "Blend Out", "Number of frames from end frame for influence to fade out");
1104         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1105         
1106         /* influence */
1107         prop = RNA_def_property(srna, "use_influence", PROP_BOOLEAN, PROP_NONE);
1108         RNA_def_property_boolean_sdna(prop, NULL, "flag", FMODIFIER_FLAG_USEINFLUENCE);
1109         RNA_def_property_ui_text(prop, "Use Influence", "F-Curve Modifier's effects will be tempered by a default factor");
1110         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1111         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1); /* XXX: depends on UI implementation */
1112         
1113         prop = RNA_def_property(srna, "influence", PROP_FLOAT, PROP_FACTOR);
1114         RNA_def_property_float_sdna(prop, NULL, "influence");
1115         RNA_def_property_range(prop, 0.0f, 1.0f);
1116         RNA_def_property_float_default(prop, 1.0f);
1117         RNA_def_property_ui_text(prop, "Influence",
1118                                  "Amount of influence F-Curve Modifier will have when not fading in/out");
1119         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1120 }
1121
1122 /* *********************** */
1123
1124 static void rna_def_drivertarget(BlenderRNA *brna)
1125 {
1126         StructRNA *srna;
1127         PropertyRNA *prop;
1128         
1129         static EnumPropertyItem prop_trans_chan_items[] = {
1130                 {DTAR_TRANSCHAN_LOCX, "LOC_X", 0, "X Location", ""},
1131                 {DTAR_TRANSCHAN_LOCY, "LOC_Y", 0, "Y Location", ""},
1132                 {DTAR_TRANSCHAN_LOCZ, "LOC_Z", 0, "Z Location", ""},
1133                 {DTAR_TRANSCHAN_ROTX, "ROT_X", 0, "X Rotation", ""},
1134                 {DTAR_TRANSCHAN_ROTY, "ROT_Y", 0, "Y Rotation", ""},
1135                 {DTAR_TRANSCHAN_ROTZ, "ROT_Z", 0, "Z Rotation", ""},
1136                 {DTAR_TRANSCHAN_SCALEX, "SCALE_X", 0, "X Scale", ""},
1137                 {DTAR_TRANSCHAN_SCALEY, "SCALE_Y", 0, "Y Scale", ""},
1138                 {DTAR_TRANSCHAN_SCALEZ, "SCALE_Z", 0, "Z Scale", ""},
1139                 {0, NULL, 0, NULL, NULL}
1140         };
1141                 
1142         static EnumPropertyItem prop_local_space_items[] = {
1143                 {0, "WORLD_SPACE", 0, "World Space", "Transforms include effects of parenting/restpose and constraints"},
1144                 {DTAR_FLAG_LOCALSPACE, "TRANSFORM_SPACE", 0, "Transform Space",
1145                                        "Transforms don't include parenting/restpose or constraints"},
1146                 {DTAR_FLAG_LOCALSPACE | DTAR_FLAG_LOCAL_CONSTS, "LOCAL_SPACE", 0, "Local Space",
1147                                                                 "Transforms include effects of constraints but not "
1148                                                                 "parenting/restpose"},
1149                 {0, NULL, 0, NULL, NULL}
1150         };
1151         
1152         srna = RNA_def_struct(brna, "DriverTarget", NULL);
1153         RNA_def_struct_ui_text(srna, "Driver Target", "Source of input values for driver variables");
1154         
1155         /* Target Properties - ID-block to Drive */
1156         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
1157         RNA_def_property_struct_type(prop, "ID");
1158         RNA_def_property_flag(prop, PROP_EDITABLE);
1159         RNA_def_property_editable_func(prop, "rna_DriverTarget_id_editable");
1160         /* note: custom set function is ONLY to avoid rna setting a user for this. */
1161         RNA_def_property_pointer_funcs(prop, NULL, "rna_DriverTarget_id_set", "rna_DriverTarget_id_typef", NULL);
1162         RNA_def_property_ui_text(prop, "ID",
1163                                  "ID-block that the specific property used can be found from "
1164                                  "(id_type property must be set first)");
1165         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1166         
1167         prop = RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
1168         RNA_def_property_enum_sdna(prop, NULL, "idtype");
1169         RNA_def_property_enum_items(prop, id_type_items);
1170         RNA_def_property_enum_default(prop, ID_OB);
1171         RNA_def_property_enum_funcs(prop, NULL, "rna_DriverTarget_id_type_set", NULL);
1172         RNA_def_property_editable_func(prop, "rna_DriverTarget_id_type_editable");
1173         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
1174         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1175         
1176         /* Target Properties - Property to Drive */
1177         prop = RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
1178         RNA_def_property_string_funcs(prop, "rna_DriverTarget_RnaPath_get", "rna_DriverTarget_RnaPath_length",
1179                                       "rna_DriverTarget_RnaPath_set");
1180         RNA_def_property_ui_text(prop, "Data Path", "RNA Path (from ID-block) to property used");
1181         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1182         
1183         prop = RNA_def_property(srna, "bone_target", PROP_STRING, PROP_NONE);
1184         RNA_def_property_string_sdna(prop, NULL, "pchan_name");
1185         RNA_def_property_ui_text(prop, "Bone Name", "Name of PoseBone to use as target");
1186         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1187         
1188         prop = RNA_def_property(srna, "transform_type", PROP_ENUM, PROP_NONE);
1189         RNA_def_property_enum_sdna(prop, NULL, "transChan");
1190         RNA_def_property_enum_items(prop, prop_trans_chan_items);
1191         RNA_def_property_ui_text(prop, "Type", "Driver variable type");
1192         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1193         
1194         prop = RNA_def_property(srna, "transform_space", PROP_ENUM, PROP_NONE);
1195         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1196         RNA_def_property_enum_items(prop, prop_local_space_items);
1197         RNA_def_property_ui_text(prop, "Transform Space", "Space in which transforms are used");
1198         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_data");
1199 }
1200
1201 static void rna_def_drivervar(BlenderRNA *brna)
1202 {
1203         StructRNA *srna;
1204         PropertyRNA *prop;
1205         
1206         static EnumPropertyItem prop_type_items[] = {
1207                 {DVAR_TYPE_SINGLE_PROP, "SINGLE_PROP", 0, "Single Property", "Use the value from some RNA property (Default)"},
1208                 {DVAR_TYPE_TRANSFORM_CHAN, "TRANSFORMS", 0, "Transform Channel",
1209                                            "Final transformation value of object or bone"},
1210                 {DVAR_TYPE_ROT_DIFF, "ROTATION_DIFF", 0, "Rotational Difference", "Use the angle between two bones"},
1211                 {DVAR_TYPE_LOC_DIFF, "LOC_DIFF", 0, "Distance", "Distance between two bones or objects"},
1212                 {0, NULL, 0, NULL, NULL}
1213         };
1214                 
1215         
1216         srna = RNA_def_struct(brna, "DriverVariable", NULL);
1217         RNA_def_struct_sdna(srna, "DriverVar");
1218         RNA_def_struct_ui_text(srna, "Driver Variable", "Variable from some source/target for driver relationship");
1219         
1220         /* Variable Name */
1221         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1222         RNA_def_struct_name_property(srna, prop);
1223         RNA_def_property_ui_text(prop, "Name",
1224                                  "Name to use in scripted expressions/functions (no spaces or dots are allowed, "
1225                                  "and must start with a letter)");
1226         RNA_def_property_update(prop, 0, "rna_DriverTarget_update_name"); /* XXX */
1227         
1228         /* Enums */
1229         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1230         RNA_def_property_enum_items(prop, prop_type_items);
1231         RNA_def_property_enum_funcs(prop, NULL, "rna_DriverVariable_type_set", NULL);
1232         RNA_def_property_ui_text(prop, "Type", "Driver variable type");
1233         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data"); /* XXX */
1234         
1235         /* Targets */
1236         /* TODO: for nicer api, only expose the relevant props via subclassing,
1237          *       instead of exposing the collection of targets */
1238         prop = RNA_def_property(srna, "targets", PROP_COLLECTION, PROP_NONE);
1239         RNA_def_property_collection_sdna(prop, NULL, "targets", "num_targets");
1240         RNA_def_property_struct_type(prop, "DriverTarget");
1241         RNA_def_property_ui_text(prop, "Targets", "Sources of input data for evaluating this variable");
1242 }
1243
1244
1245 /* channeldriver.variables.* */
1246 static void rna_def_channeldriver_variables(BlenderRNA *brna, PropertyRNA *cprop)
1247 {
1248         StructRNA *srna;
1249 /*      PropertyRNA *prop; */
1250         
1251         FunctionRNA *func;
1252         PropertyRNA *parm;
1253         
1254         RNA_def_property_srna(cprop, "ChannelDriverVariables");
1255         srna = RNA_def_struct(brna, "ChannelDriverVariables", NULL);
1256         RNA_def_struct_sdna(srna, "ChannelDriver");
1257         RNA_def_struct_ui_text(srna, "ChannelDriver Variables", "Collection of channel driver Variables");
1258         
1259         
1260         /* add variable */
1261         func = RNA_def_function(srna, "new", "rna_Driver_new_variable");
1262         RNA_def_function_ui_description(func, "Add a new variable for the driver");
1263         /* return type */
1264         parm = RNA_def_pointer(func, "var", "DriverVariable", "", "Newly created Driver Variable");
1265         RNA_def_function_return(func, parm);
1266
1267         /* remove variable */
1268         func = RNA_def_function(srna, "remove", "rna_Driver_remove_variable");
1269         RNA_def_function_ui_description(func, "Remove an existing variable from the driver");
1270         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1271         /* target to remove */
1272         parm = RNA_def_pointer(func, "variable", "DriverVariable", "", "Variable to remove from the driver");
1273         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
1274         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
1275 }
1276
1277 static void rna_def_channeldriver(BlenderRNA *brna)
1278 {
1279         StructRNA *srna;
1280         PropertyRNA *prop;
1281         
1282         static EnumPropertyItem prop_type_items[] = {
1283                 {DRIVER_TYPE_AVERAGE, "AVERAGE", 0, "Averaged Value", ""},
1284                 {DRIVER_TYPE_SUM, "SUM", 0, "Sum Values", ""},
1285                 {DRIVER_TYPE_PYTHON, "SCRIPTED", 0, "Scripted Expression", ""},
1286                 {DRIVER_TYPE_MIN, "MIN", 0, "Minimum Value", ""},
1287                 {DRIVER_TYPE_MAX, "MAX", 0, "Maximum Value", ""},
1288                 {0, NULL, 0, NULL, NULL}
1289         };
1290
1291         srna = RNA_def_struct(brna, "Driver", NULL);
1292         RNA_def_struct_sdna(srna, "ChannelDriver");
1293         RNA_def_struct_ui_text(srna, "Driver", "Driver for the value of a setting based on an external value");
1294         RNA_def_struct_ui_icon(srna, ICON_DRIVER);
1295
1296         /* Enums */
1297         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1298         RNA_def_property_enum_items(prop, prop_type_items);
1299         RNA_def_property_ui_text(prop, "Type", "Driver type");
1300         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_data");
1301
1302         /* String values */
1303         prop = RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
1304         RNA_def_property_ui_text(prop, "Expression", "Expression to use for Scripted Expression");
1305         RNA_def_property_update(prop, 0, "rna_ChannelDriver_update_expr");
1306
1307         /* Collections */
1308         prop = RNA_def_property(srna, "variables", PROP_COLLECTION, PROP_NONE);
1309         RNA_def_property_collection_sdna(prop, NULL, "variables", NULL);
1310         RNA_def_property_struct_type(prop, "DriverVariable");
1311         RNA_def_property_ui_text(prop, "Variables", "Properties acting as inputs for this driver");
1312         rna_def_channeldriver_variables(brna, prop);
1313         
1314         /* Settings */
1315         prop = RNA_def_property(srna, "show_debug_info", PROP_BOOLEAN, PROP_NONE);
1316         RNA_def_property_boolean_sdna(prop, NULL, "flag", DRIVER_FLAG_SHOWDEBUG);
1317         RNA_def_property_ui_text(prop, "Show Debug Info",
1318                                  "Show intermediate values for the driver calculations to allow debugging of drivers");
1319         
1320         /* State Info (for Debugging) */
1321         prop = RNA_def_property(srna, "is_valid", PROP_BOOLEAN, PROP_NONE);
1322         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", DRIVER_FLAG_INVALID);
1323         RNA_def_property_ui_text(prop, "Invalid", "Driver could not be evaluated in past, so should be skipped");
1324         
1325         
1326         /* Functions */
1327         RNA_api_drivers(srna);
1328 }
1329
1330 /* *********************** */
1331
1332 static void rna_def_fpoint(BlenderRNA *brna)
1333 {
1334         StructRNA *srna;
1335         PropertyRNA *prop;
1336         
1337         srna = RNA_def_struct(brna, "FCurveSample", NULL);
1338         RNA_def_struct_sdna(srna, "FPoint");
1339         RNA_def_struct_ui_text(srna, "F-Curve Sample", "Sample point for F-Curve");
1340         
1341         /* Boolean values */
1342         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
1343         RNA_def_property_boolean_sdna(prop, NULL, "flag", 1);
1344         RNA_def_property_ui_text(prop, "Select", "Selection status");
1345         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
1346         
1347         /* Vector value */
1348         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_COORDS); /* keyframes are dimensionless */
1349         RNA_def_property_float_sdna(prop, NULL, "vec");
1350         RNA_def_property_array(prop, 2);
1351         RNA_def_property_ui_text(prop, "Point", "Point coordinates");
1352         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1353 }
1354
1355
1356 /* duplicate of BezTriple in rna_curve.c
1357  * but with F-Curve specific options updates/functionality
1358  */
1359 static void rna_def_fkeyframe(BlenderRNA *brna)
1360 {
1361         StructRNA *srna;
1362         PropertyRNA *prop;
1363         
1364         srna = RNA_def_struct(brna, "Keyframe", NULL);
1365         RNA_def_struct_sdna(srna, "BezTriple");
1366         RNA_def_struct_ui_text(srna, "Keyframe", "Bezier curve point with two handles defining a Keyframe on an F-Curve");
1367         
1368         /* Boolean values */
1369         prop = RNA_def_property(srna, "select_left_handle", PROP_BOOLEAN, PROP_NONE);
1370         RNA_def_property_boolean_sdna(prop, NULL, "f1", 0);
1371         RNA_def_property_ui_text(prop, "Handle 1 selected", "Left handle selection status");
1372         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
1373         
1374         prop = RNA_def_property(srna, "select_right_handle", PROP_BOOLEAN, PROP_NONE);
1375         RNA_def_property_boolean_sdna(prop, NULL, "f3", 0);
1376         RNA_def_property_ui_text(prop, "Handle 2 selected", "Right handle selection status");
1377         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
1378         
1379         prop = RNA_def_property(srna, "select_control_point", PROP_BOOLEAN, PROP_NONE);
1380         RNA_def_property_boolean_sdna(prop, NULL, "f2", 0);
1381         RNA_def_property_ui_text(prop, "Select", "Control point selection status");
1382         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
1383         
1384         /* Enums */
1385         prop = RNA_def_property(srna, "handle_left_type", PROP_ENUM, PROP_NONE);
1386         RNA_def_property_enum_sdna(prop, NULL, "h1");
1387         RNA_def_property_enum_items(prop, keyframe_handle_type_items);
1388         RNA_def_property_ui_text(prop, "Left Handle Type", "Handle types");
1389         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1390         
1391         prop = RNA_def_property(srna, "handle_right_type", PROP_ENUM, PROP_NONE);
1392         RNA_def_property_enum_sdna(prop, NULL, "h2");
1393         RNA_def_property_enum_items(prop, keyframe_handle_type_items);
1394         RNA_def_property_ui_text(prop, "Right Handle Type", "Handle types");
1395         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1396         
1397         prop = RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
1398         RNA_def_property_enum_sdna(prop, NULL, "ipo");
1399         RNA_def_property_enum_items(prop, beztriple_interpolation_mode_items);
1400         RNA_def_property_ui_text(prop, "Interpolation",
1401                                  "Interpolation method to use for segment of the F-Curve from "
1402                                  "this Keyframe until the next Keyframe");
1403         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1404         
1405         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1406         RNA_def_property_enum_sdna(prop, NULL, "hide");
1407         RNA_def_property_enum_items(prop, beztriple_keyframe_type_items);
1408         RNA_def_property_ui_text(prop, "Type", "Type of keyframe (for visual purposes only)");
1409         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1410         
1411         /* Vector values */
1412         prop = RNA_def_property(srna, "handle_left", PROP_FLOAT, PROP_COORDS); /* keyframes are dimensionless */
1413         RNA_def_property_array(prop, 2);
1414         RNA_def_property_float_funcs(prop, "rna_FKeyframe_handle1_get", "rna_FKeyframe_handle1_set", NULL);
1415         RNA_def_property_ui_text(prop, "Left Handle", "Coordinates of the left handle (before the control point)");
1416         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1417         
1418         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_COORDS); /* keyframes are dimensionless */
1419         RNA_def_property_array(prop, 2);
1420         RNA_def_property_float_funcs(prop, "rna_FKeyframe_ctrlpoint_get", "rna_FKeyframe_ctrlpoint_set", NULL);
1421         RNA_def_property_ui_text(prop, "Control Point", "Coordinates of the control point");
1422         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1423         
1424         prop = RNA_def_property(srna, "handle_right", PROP_FLOAT, PROP_COORDS); /* keyframes are dimensionless */
1425         RNA_def_property_array(prop, 2);
1426         RNA_def_property_float_funcs(prop, "rna_FKeyframe_handle2_get", "rna_FKeyframe_handle2_set", NULL);
1427         RNA_def_property_ui_text(prop, "Right Handle", "Coordinates of the right handle (after the control point)");
1428         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1429 }
1430
1431 static void rna_def_fcurve_modifiers(BlenderRNA *brna, PropertyRNA *cprop)
1432 {
1433         /* add modifiers */
1434         StructRNA *srna;
1435         PropertyRNA *prop;
1436
1437         FunctionRNA *func;
1438         PropertyRNA *parm;
1439
1440         RNA_def_property_srna(cprop, "FCurveModifiers");
1441         srna = RNA_def_struct(brna, "FCurveModifiers", NULL);
1442         RNA_def_struct_sdna(srna, "FCurve");
1443         RNA_def_struct_ui_text(srna, "F-Curve Modifiers", "Collection of F-Curve Modifiers");
1444
1445
1446         /* Collection active property */
1447         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1448         RNA_def_property_struct_type(prop, "FModifier");
1449         RNA_def_property_pointer_funcs(prop, "rna_FCurve_active_modifier_get",
1450                                        "rna_FCurve_active_modifier_set", NULL, NULL);
1451         RNA_def_property_flag(prop, PROP_EDITABLE);
1452         RNA_def_property_ui_text(prop, "Active F-Curve Modifier", "Active F-Curve Modifier");
1453
1454         /* Constraint collection */
1455         func = RNA_def_function(srna, "new", "rna_FCurve_modifiers_new");
1456         RNA_def_function_ui_description(func, "Add a constraint to this object");
1457         /* return type */
1458         parm = RNA_def_pointer(func, "fmodifier", "FModifier", "", "New fmodifier");
1459         RNA_def_function_return(func, parm);
1460         /* object to add */
1461         parm = RNA_def_enum(func, "type", fmodifier_type_items, 1, "", "Constraint type to add");
1462         RNA_def_property_flag(parm, PROP_REQUIRED);
1463
1464         func = RNA_def_function(srna, "remove", "rna_FCurve_modifiers_remove");
1465         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1466         RNA_def_function_ui_description(func, "Remove a modifier from this F-Curve");
1467         /* modifier to remove */
1468         parm = RNA_def_pointer(func, "modifier", "FModifier", "", "Removed modifier");
1469         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
1470         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
1471 }
1472
1473 /* fcurve.keyframe_points */
1474 static void rna_def_fcurve_keyframe_points(BlenderRNA *brna, PropertyRNA *cprop)
1475 {
1476         StructRNA *srna;
1477
1478         FunctionRNA *func;
1479         PropertyRNA *parm;
1480
1481         static EnumPropertyItem keyframe_flag_items[] = {
1482                 {INSERTKEY_REPLACE, "REPLACE", 0, "Replace", "Don't add any new keyframes, but just replace existing ones"},
1483                 {INSERTKEY_NEEDED, "NEEDED", 0, "Needed", "Only adds keyframes that are needed"},
1484                 {INSERTKEY_FAST, "FAST", 0, "Fast", "Fast keyframe insertion to avoid recalculating the curve each time"},
1485                 {0, NULL, 0, NULL, NULL}
1486         };
1487
1488         RNA_def_property_srna(cprop, "FCurveKeyframePoints");
1489         srna = RNA_def_struct(brna, "FCurveKeyframePoints", NULL);
1490         RNA_def_struct_sdna(srna, "FCurve");
1491         RNA_def_struct_ui_text(srna, "Keyframe Points", "Collection of keyframe points");
1492
1493         func = RNA_def_function(srna, "insert", "rna_FKeyframe_points_insert");
1494         RNA_def_function_ui_description(func, "Add a keyframe point to a F-Curve");
1495         parm = RNA_def_float(func, "frame", 0.0f, -FLT_MAX, FLT_MAX, "",
1496                              "X Value of this keyframe point", -FLT_MAX, FLT_MAX);
1497         RNA_def_property_flag(parm, PROP_REQUIRED);
1498         parm = RNA_def_float(func, "value", 0.0f, -FLT_MAX, FLT_MAX, "",
1499                              "Y Value of this keyframe point", -FLT_MAX, FLT_MAX);
1500         RNA_def_property_flag(parm, PROP_REQUIRED);
1501
1502         RNA_def_enum_flag(func, "options", keyframe_flag_items, 0, "", "Keyframe options");
1503
1504         parm = RNA_def_pointer(func, "keyframe", "Keyframe", "", "Newly created keyframe");
1505         RNA_def_function_return(func, parm);
1506
1507         func = RNA_def_function(srna, "add", "rna_FKeyframe_points_add");
1508         RNA_def_function_ui_description(func, "Add a keyframe point to a F-Curve");
1509         RNA_def_int(func, "count", 1, 0, INT_MAX, "Number", "Number of points to add to the spline", 0, INT_MAX);
1510
1511         func = RNA_def_function(srna, "remove", "rna_FKeyframe_points_remove");
1512         RNA_def_function_ui_description(func, "Remove keyframe from an F-Curve");
1513         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1514         parm = RNA_def_pointer(func, "keyframe", "Keyframe", "", "Keyframe to remove");
1515         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
1516         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
1517         /* optional */
1518         RNA_def_boolean(func, "fast", 0, "Fast", "Fast keyframe removal to avoid recalculating the curve each time");
1519 }
1520
1521 static void rna_def_fcurve(BlenderRNA *brna)
1522 {
1523         StructRNA *srna;
1524         PropertyRNA *prop;
1525         FunctionRNA *func;
1526         PropertyRNA *parm;
1527
1528         static EnumPropertyItem prop_mode_extend_items[] = {
1529                 {FCURVE_EXTRAPOLATE_CONSTANT, "CONSTANT", 0, "Constant", ""},
1530                 {FCURVE_EXTRAPOLATE_LINEAR, "LINEAR", 0, "Linear", ""},
1531                 {0, NULL, 0, NULL, NULL}
1532         };
1533         static EnumPropertyItem prop_mode_color_items[] = {
1534                 {FCURVE_COLOR_AUTO_RAINBOW, "AUTO_RAINBOW", 0, "Auto Rainbow", ""},
1535                 {FCURVE_COLOR_AUTO_RGB, "AUTO_RGB", 0, "Auto XYZ to RGB", ""},
1536                 {FCURVE_COLOR_CUSTOM, "CUSTOM", 0, "User Defined", ""},
1537                 {0, NULL, 0, NULL, NULL}
1538         };
1539
1540         srna = RNA_def_struct(brna, "FCurve", NULL);
1541         RNA_def_struct_ui_text(srna, "F-Curve", "F-Curve defining values of a period of time");
1542         RNA_def_struct_ui_icon(srna, ICON_ANIM_DATA);
1543
1544         /* Enums */
1545         prop = RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
1546         RNA_def_property_enum_sdna(prop, NULL, "extend");
1547         RNA_def_property_enum_items(prop, prop_mode_extend_items);
1548         RNA_def_property_ui_text(prop, "Extrapolation", "");
1549         /* XXX need an update callback for this so that animation gets evaluated */
1550         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1551
1552         /* Pointers */
1553         prop = RNA_def_property(srna, "driver", PROP_POINTER, PROP_NONE);
1554         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1555         RNA_def_property_ui_text(prop, "Driver", "Channel Driver (only set for Driver F-Curves)");
1556         
1557         prop = RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
1558         RNA_def_property_pointer_sdna(prop, NULL, "grp");
1559         RNA_def_property_flag(prop, PROP_EDITABLE);
1560         RNA_def_property_ui_text(prop, "Group", "Action Group that this F-Curve belongs to");
1561         RNA_def_property_pointer_funcs(prop, NULL, "rna_FCurve_group_set", NULL, NULL);
1562         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1563
1564         /* Path + Array Index */
1565         prop = RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
1566         RNA_def_property_string_funcs(prop, "rna_FCurve_RnaPath_get", "rna_FCurve_RnaPath_length",
1567                                       "rna_FCurve_RnaPath_set");
1568         RNA_def_property_ui_text(prop, "Data Path", "RNA Path to property affected by F-Curve");
1569         /* XXX need an update callback for this to that animation gets evaluated */
1570         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1571
1572         /* called 'index' when given as function arg */
1573         prop = RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
1574         RNA_def_property_ui_text(prop, "RNA Array Index",
1575                                  "Index to the specific property affected by F-Curve if applicable");
1576         /* XXX need an update callback for this so that animation gets evaluated */
1577         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1578         
1579         /* Color */
1580         prop = RNA_def_property(srna, "color_mode", PROP_ENUM, PROP_NONE);
1581         RNA_def_property_enum_items(prop, prop_mode_color_items);
1582         RNA_def_property_ui_text(prop, "Color Mode", "Method used to determine color of F-Curve in Graph Editor");
1583         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1584         
1585         prop = RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
1586         RNA_def_property_array(prop, 3);
1587         RNA_def_property_range(prop, 0.0f, 1.0f);
1588         RNA_def_property_ui_text(prop, "Color", "Color of the F-Curve in the Graph Editor");
1589         RNA_def_property_update(prop, NC_ANIMATION, NULL);
1590         
1591         /* Flags */
1592         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
1593         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_SELECTED);
1594         RNA_def_property_ui_text(prop, "Select", "F-Curve is selected for editing");
1595         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
1596         
1597         prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
1598         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_PROTECTED);
1599         RNA_def_property_ui_text(prop, "Lock", "F-Curve's settings cannot be edited");
1600         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
1601         
1602         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
1603         RNA_def_property_boolean_sdna(prop, NULL, "flag", FCURVE_MUTED);
1604         RNA_def_property_ui_text(prop, "Muted", "F-Curve is not evaluated");
1605         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
1606         
1607         prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
1608         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", FCURVE_VISIBLE);
1609         RNA_def_property_ui_text(prop, "Hide", "F-Curve and its keyframes are hidden in the Graph Editor graphs");
1610         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_GRAPH, NULL);
1611
1612         /* State Info (for Debugging) */
1613         prop = RNA_def_property(srna, "is_valid", PROP_BOOLEAN, PROP_NONE);
1614         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", FCURVE_DISABLED);
1615         RNA_def_property_ui_text(prop, "Valid",
1616                                  "False when F-Curve could not be evaluated in past, so should be skipped "
1617                                  "when evaluating");
1618         RNA_def_property_update(prop, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
1619         
1620         /* Collections */
1621         prop = RNA_def_property(srna, "sampled_points", PROP_COLLECTION, PROP_NONE);
1622         RNA_def_property_collection_sdna(prop, NULL, "fpt", "totvert");
1623         RNA_def_property_struct_type(prop, "FCurveSample");
1624         RNA_def_property_ui_text(prop, "Sampled Points", "Sampled animation data");
1625
1626         prop = RNA_def_property(srna, "keyframe_points", PROP_COLLECTION, PROP_NONE);
1627         RNA_def_property_collection_sdna(prop, NULL, "bezt", "totvert");
1628         RNA_def_property_struct_type(prop, "Keyframe");
1629         RNA_def_property_ui_text(prop, "Keyframes", "User-editable keyframes");
1630         rna_def_fcurve_keyframe_points(brna, prop);
1631         
1632         prop = RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
1633         RNA_def_property_struct_type(prop, "FModifier");
1634         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the shape of the F-Curve");
1635         rna_def_fcurve_modifiers(brna, prop);
1636
1637         /* Functions */
1638         func = RNA_def_function(srna, "evaluate", "evaluate_fcurve"); /* calls the C/API direct */
1639         RNA_def_function_ui_description(func, "Evaluate F-Curve");
1640         parm = RNA_def_float(func, "frame", 1.0f, -FLT_MAX, FLT_MAX, "Frame",
1641                              "Evaluate F-Curve at given frame", -FLT_MAX, FLT_MAX);
1642         RNA_def_property_flag(parm, PROP_REQUIRED);
1643         /* return value */
1644         parm = RNA_def_float(func, "position", 0, -FLT_MAX, FLT_MAX, "Position", "F-Curve position", -FLT_MAX, FLT_MAX);
1645         RNA_def_function_return(func, parm);
1646
1647         func = RNA_def_function(srna, "range", "rna_fcurve_range");
1648         RNA_def_function_ui_description(func, "Get the time extents for F-Curve");
1649         /* return value */
1650         parm = RNA_def_float_vector(func, "range", 2, NULL, -FLT_MAX, FLT_MAX, "Range",
1651                                     "Min/Max values", -FLT_MAX, FLT_MAX);
1652         RNA_def_property_flag(parm, PROP_THICK_WRAP);
1653         RNA_def_function_output(func, parm);
1654 }
1655
1656 /* *********************** */
1657
1658 void RNA_def_fcurve(BlenderRNA *brna)
1659 {
1660         rna_def_fcurve(brna);
1661         rna_def_fkeyframe(brna);
1662         rna_def_fpoint(brna);
1663         
1664         rna_def_drivertarget(brna);
1665         rna_def_drivervar(brna);
1666         rna_def_channeldriver(brna);
1667         
1668         rna_def_fmodifier(brna);
1669         
1670         rna_def_fmodifier_generator(brna);
1671         rna_def_fmodifier_function_generator(brna);
1672
1673         rna_def_fmodifier_envelope(brna);
1674         rna_def_fmodifier_envelope_ctrl(brna);
1675
1676         rna_def_fmodifier_cycles(brna);
1677         rna_def_fmodifier_python(brna);
1678         rna_def_fmodifier_limits(brna);
1679         rna_def_fmodifier_noise(brna);
1680         rna_def_fmodifier_stepped(brna);
1681 }
1682
1683
1684 #endif