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