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