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