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