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