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