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