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