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