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