Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_animation.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_animation.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "DNA_anim_types.h"
30 #include "DNA_action_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BLI_utildefines.h"
34
35 #include "BLT_translation.h"
36
37 #include "MEM_guardedalloc.h"
38
39 #include "RNA_access.h"
40 #include "RNA_define.h"
41 #include "RNA_enum_types.h"
42
43 #include "rna_internal.h"
44
45 #include "WM_types.h"
46
47 #include "ED_keyframing.h"
48
49 /* exported for use in API */
50 const EnumPropertyItem rna_enum_keyingset_path_grouping_items[] = {
51         {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
52         {KSP_GROUP_NONE, "NONE", 0, "None", ""},
53         {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
54         {0, NULL, 0, NULL, NULL}
55 };
56
57 /* It would be cool to get rid of this 'INSERTKEY_' prefix in 'py strings' values, but it would break existing
58  * exported keyingset... :/
59  */
60 const EnumPropertyItem rna_enum_keying_flag_items[] = {
61         {INSERTKEY_NEEDED, "INSERTKEY_NEEDED", 0, "Only Needed",
62                            "Only insert keyframes where they're needed in the relevant F-Curves"},
63         {INSERTKEY_MATRIX, "INSERTKEY_VISUAL", 0, "Visual Keying",
64                            "Insert keyframes based on 'visual transforms'"},
65         {INSERTKEY_XYZ2RGB, "INSERTKEY_XYZ_TO_RGB", 0, "XYZ=RGB Colors",
66                             "Color for newly added transformation F-Curves (Location, Rotation, Scale) "
67                             "and also Color is based on the transform axis"},
68         {0, NULL, 0, NULL, NULL}
69 };
70
71 #ifdef RNA_RUNTIME
72
73 #include "BLI_math_base.h"
74
75 #include "BKE_animsys.h"
76 #include "BKE_fcurve.h"
77 #include "BKE_nla.h"
78
79 #include "DEG_depsgraph.h"
80
81 #include "DNA_object_types.h"
82
83 #include "WM_api.h"
84
85 static void rna_AnimData_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
86 {
87         ID *id = ptr->id.data;
88         
89         /* tag for refresh so that scheduled updates (e.g. action changed) will 
90          * get computed and reflected in the scene [#34869] 
91          */
92         DEG_id_tag_update(id, OB_RECALC_OB | OB_RECALC_DATA);
93 }
94
95 static int rna_AnimData_action_editable(PointerRNA *ptr, const char **UNUSED(r_info))
96 {
97         AnimData *adt = (AnimData *)ptr->data;
98         
99         /* active action is only editable when it is not a tweaking strip */
100         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
101                 return 0;
102         else
103                 return PROP_EDITABLE;
104 }
105
106 static void rna_AnimData_action_set(PointerRNA *ptr, PointerRNA value)
107 {
108         ID *ownerId = (ID *)ptr->id.data;
109         AnimData *adt;
110         
111         /* set action */
112         BKE_animdata_set_action(NULL, ownerId, value.data);
113         
114         /* force action to get evaluated [#34869] */
115         adt = BKE_animdata_from_id(ownerId);
116         if (adt) {
117                 adt->recalc |= ADT_RECALC_ANIM;
118                 DEG_id_tag_update(ownerId, OB_RECALC_TIME);
119         }
120 }
121
122 static void rna_AnimData_tweakmode_set(PointerRNA *ptr, const int value)
123 {
124         AnimData *adt = (AnimData *)ptr->data;
125
126         /* NOTE: technically we should also set/unset SCE_NLA_EDIT_ON flag on the
127          * scene which is used to make polling tests faster, but this flag is weak
128          * and can easily break e.g. by changing layer visibility. This needs to be
129          * dealt with at some point. */
130
131         if (value) {
132                 BKE_nla_tweakmode_enter(adt);
133         }
134         else {
135                 BKE_nla_tweakmode_exit(adt);
136         }
137 }
138
139 /* ****************************** */
140
141 /* wrapper for poll callback */
142 static int RKS_POLL_rna_internal(KeyingSetInfo *ksi, bContext *C)
143 {
144         extern FunctionRNA rna_KeyingSetInfo_poll_func;
145
146         PointerRNA ptr;
147         ParameterList list;
148         FunctionRNA *func;
149         void *ret;
150         int ok;
151
152         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
153         func = &rna_KeyingSetInfo_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
154
155         RNA_parameter_list_create(&list, &ptr, func);
156         {
157                 /* hook up arguments */
158                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
159                 RNA_parameter_set_lookup(&list, "context", &C);
160                 
161                 /* execute the function */
162                 ksi->ext.call(C, &ptr, func, &list);
163                 
164                 /* read the result */
165                 RNA_parameter_get_lookup(&list, "ok", &ret);
166                 ok = *(int *)ret;
167         }
168         RNA_parameter_list_free(&list);
169         
170         return ok;
171 }
172
173 /* wrapper for iterator callback */
174 static void RKS_ITER_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks)
175 {
176         extern FunctionRNA rna_KeyingSetInfo_iterator_func;
177
178         PointerRNA ptr;
179         ParameterList list;
180         FunctionRNA *func;
181
182         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
183         func = &rna_KeyingSetInfo_iterator_func; /* RNA_struct_find_function(&ptr, "poll"); */
184
185         RNA_parameter_list_create(&list, &ptr, func);
186         {
187                 /* hook up arguments */
188                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
189                 RNA_parameter_set_lookup(&list, "context", &C);
190                 RNA_parameter_set_lookup(&list, "ks", &ks);
191                 
192                 /* execute the function */
193                 ksi->ext.call(C, &ptr, func, &list);
194         }
195         RNA_parameter_list_free(&list);
196 }
197
198 /* wrapper for generator callback */
199 static void RKS_GEN_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks, PointerRNA *data)
200 {
201         extern FunctionRNA rna_KeyingSetInfo_generate_func;
202
203         PointerRNA ptr;
204         ParameterList list;
205         FunctionRNA *func;
206
207         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
208         func = &rna_KeyingSetInfo_generate_func; /* RNA_struct_find_generate(&ptr, "poll"); */
209
210         RNA_parameter_list_create(&list, &ptr, func);
211         {
212                 /* hook up arguments */
213                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
214                 RNA_parameter_set_lookup(&list, "context", &C);
215                 RNA_parameter_set_lookup(&list, "ks", &ks);
216                 RNA_parameter_set_lookup(&list, "data", data);
217                 
218                 /* execute the function */
219                 ksi->ext.call(C, &ptr, func, &list);
220         }
221         RNA_parameter_list_free(&list);
222 }
223
224 /* ------ */
225
226 /* XXX: the exact purpose of this is not too clear... maybe we want to revise this at some point? */
227 static StructRNA *rna_KeyingSetInfo_refine(PointerRNA *ptr)
228 {
229         KeyingSetInfo *ksi = (KeyingSetInfo *)ptr->data;
230         return (ksi->ext.srna) ? ksi->ext.srna : &RNA_KeyingSetInfo;
231 }
232
233 static void rna_KeyingSetInfo_unregister(Main *bmain, StructRNA *type)
234 {
235         KeyingSetInfo *ksi = RNA_struct_blender_type_get(type);
236
237         if (ksi == NULL)
238                 return;
239         
240         /* free RNA data referencing this */
241         RNA_struct_free_extension(type, &ksi->ext);
242         RNA_struct_free(&BLENDER_RNA, type);
243         
244         WM_main_add_notifier(NC_WINDOW, NULL);
245
246         /* unlink Blender-side data */
247         ANIM_keyingset_info_unregister(bmain, ksi);
248 }
249
250 static StructRNA *rna_KeyingSetInfo_register(
251         Main *bmain, ReportList *reports, void *data, const char *identifier,
252         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
253 {
254         KeyingSetInfo dummyksi = {NULL};
255         KeyingSetInfo *ksi;
256         PointerRNA dummyptr = {{NULL}};
257         int have_function[3];
258
259         /* setup dummy type info to store static properties in */
260         /* TODO: perhaps we want to get users to register as if they're using 'KeyingSet' directly instead? */
261         RNA_pointer_create(NULL, &RNA_KeyingSetInfo, &dummyksi, &dummyptr);
262         
263         /* validate the python class */
264         if (validate(&dummyptr, data, have_function) != 0)
265                 return NULL;
266         
267         if (strlen(identifier) >= sizeof(dummyksi.idname)) {
268                 BKE_reportf(reports, RPT_ERROR, "Registering keying set info class: '%s' is too long, maximum length is %d",
269                             identifier, (int)sizeof(dummyksi.idname));
270                 return NULL;
271         }
272         
273         /* check if we have registered this info before, and remove it */
274         ksi = ANIM_keyingset_info_find_name(dummyksi.idname);
275         if (ksi && ksi->ext.srna) {
276                 rna_KeyingSetInfo_unregister(bmain, ksi->ext.srna);
277         }
278
279         /* create a new KeyingSetInfo type */
280         ksi = MEM_callocN(sizeof(KeyingSetInfo), "python keying set info");
281         memcpy(ksi, &dummyksi, sizeof(KeyingSetInfo));
282         
283         /* set RNA-extensions info */
284         ksi->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ksi->idname, &RNA_KeyingSetInfo);
285         ksi->ext.data = data;
286         ksi->ext.call = call;
287         ksi->ext.free = free;
288         RNA_struct_blender_type_set(ksi->ext.srna, ksi);
289         
290         /* set callbacks */
291         /* NOTE: we really should have all of these...  */
292         ksi->poll = (have_function[0]) ? RKS_POLL_rna_internal : NULL;
293         ksi->iter = (have_function[1]) ? RKS_ITER_rna_internal : NULL;
294         ksi->generate = (have_function[2]) ? RKS_GEN_rna_internal : NULL;
295         
296         /* add and register with other info as needed */
297         ANIM_keyingset_info_register(ksi);
298         
299         WM_main_add_notifier(NC_WINDOW, NULL);
300
301         /* return the struct-rna added */
302         return ksi->ext.srna;
303 }
304
305 /* ****************************** */
306
307 static StructRNA *rna_ksPath_id_typef(PointerRNA *ptr)
308 {
309         KS_Path *ksp = (KS_Path *)ptr->data;
310         return ID_code_to_RNA_type(ksp->idtype);
311 }
312
313 static int rna_ksPath_id_editable(PointerRNA *ptr, const char **UNUSED(r_info))
314 {
315         KS_Path *ksp = (KS_Path *)ptr->data;
316         return (ksp->idtype) ? PROP_EDITABLE : 0;
317 }
318
319 static void rna_ksPath_id_type_set(PointerRNA *ptr, int value)
320 {
321         KS_Path *data = (KS_Path *)(ptr->data);
322         
323         /* set the driver type, then clear the id-block if the type is invalid */
324         data->idtype = value;
325         if ((data->id) && (GS(data->id->name) != data->idtype))
326                 data->id = NULL;
327 }
328
329 static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
330 {
331         KS_Path *ksp = (KS_Path *)ptr->data;
332
333         if (ksp->rna_path)
334                 strcpy(value, ksp->rna_path);
335         else
336                 value[0] = '\0';
337 }
338
339 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
340 {
341         KS_Path *ksp = (KS_Path *)ptr->data;
342         
343         if (ksp->rna_path)
344                 return strlen(ksp->rna_path);
345         else
346                 return 0;
347 }
348
349 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
350 {
351         KS_Path *ksp = (KS_Path *)ptr->data;
352
353         if (ksp->rna_path)
354                 MEM_freeN(ksp->rna_path);
355         
356         if (value[0])
357                 ksp->rna_path = BLI_strdup(value);
358         else
359                 ksp->rna_path = NULL;
360 }
361
362 /* ****************************** */
363
364 static void rna_KeyingSet_name_set(PointerRNA *ptr, const char *value)
365 {
366         KeyingSet *ks = (KeyingSet *)ptr->data;
367         
368         /* update names of corresponding groups if name changes */
369         if (!STREQ(ks->name, value)) {
370                 KS_Path *ksp;
371                 
372                 for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
373                         if ((ksp->groupmode == KSP_GROUP_KSNAME) && (ksp->id)) {
374                                 AnimData *adt = BKE_animdata_from_id(ksp->id);
375                                 
376                                 /* TODO: NLA strips? */
377                                 if (adt && adt->action) {
378                                         bActionGroup *agrp;
379                                         
380                                         /* lazy check - should really find the F-Curve for the affected path and check its group 
381                                          * but this way should be faster and work well for most cases, as long as there are no
382                                          * conflicts
383                                          */
384                                         for (agrp = adt->action->groups.first; agrp; agrp = agrp->next) {
385                                                 if (STREQ(ks->name, agrp->name)) {
386                                                         /* there should only be one of these in the action, so can stop... */
387                                                         BLI_strncpy(agrp->name, value, sizeof(agrp->name));
388                                                         break;
389                                                 }
390                                         }
391                                 }
392                         }
393                 }
394         }
395         
396         /* finally, update name to new value */
397         BLI_strncpy(ks->name, value, sizeof(ks->name));
398 }
399
400
401 static int rna_KeyingSet_active_ksPath_editable(PointerRNA *ptr, const char **UNUSED(r_info))
402 {
403         KeyingSet *ks = (KeyingSet *)ptr->data;
404         
405         /* only editable if there are some paths to change to */
406         return (BLI_listbase_is_empty(&ks->paths) == false) ? PROP_EDITABLE : 0;
407 }
408
409 static PointerRNA rna_KeyingSet_active_ksPath_get(PointerRNA *ptr)
410 {
411         KeyingSet *ks = (KeyingSet *)ptr->data;
412         return rna_pointer_inherit_refine(ptr, &RNA_KeyingSetPath, BLI_findlink(&ks->paths, ks->active_path - 1));
413 }
414
415 static void rna_KeyingSet_active_ksPath_set(PointerRNA *ptr, PointerRNA value)
416 {
417         KeyingSet *ks = (KeyingSet *)ptr->data;
418         KS_Path *ksp = (KS_Path *)value.data;
419         ks->active_path = BLI_findindex(&ks->paths, ksp) + 1;
420 }
421
422 static int rna_KeyingSet_active_ksPath_index_get(PointerRNA *ptr)
423 {
424         KeyingSet *ks = (KeyingSet *)ptr->data;
425         return MAX2(ks->active_path - 1, 0);
426 }
427
428 static void rna_KeyingSet_active_ksPath_index_set(PointerRNA *ptr, int value)
429 {
430         KeyingSet *ks = (KeyingSet *)ptr->data;
431         ks->active_path = value + 1;
432 }
433
434 static void rna_KeyingSet_active_ksPath_index_range(PointerRNA *ptr, int *min, int *max,
435                                                     int *UNUSED(softmin), int *UNUSED(softmax))
436 {
437         KeyingSet *ks = (KeyingSet *)ptr->data;
438
439         *min = 0;
440         *max = max_ii(0, BLI_listbase_count(&ks->paths) - 1);
441 }
442
443 static PointerRNA rna_KeyingSet_typeinfo_get(PointerRNA *ptr)
444 {
445         KeyingSet *ks = (KeyingSet *)ptr->data;
446         KeyingSetInfo *ksi = NULL;
447         
448         /* keying set info is only for builtin Keying Sets */
449         if ((ks->flag & KEYINGSET_ABSOLUTE) == 0)
450                 ksi = ANIM_keyingset_info_find_name(ks->typeinfo);
451         return rna_pointer_inherit_refine(ptr, &RNA_KeyingSetInfo, ksi);
452 }
453
454
455
456 static KS_Path *rna_KeyingSet_paths_add(KeyingSet *keyingset, ReportList *reports,
457                                         ID *id, const char rna_path[], int index, int group_method, const char group_name[])
458 {
459         KS_Path *ksp = NULL;
460         short flag = 0;
461         
462         /* special case when index = -1, we key the whole array (as with other places where index is used) */
463         if (index == -1) {
464                 flag |= KSP_FLAG_WHOLE_ARRAY;
465                 index = 0;
466         }
467         
468         /* if data is valid, call the API function for this */
469         if (keyingset) {
470                 ksp = BKE_keyingset_add_path(keyingset, id, group_name, rna_path, index, flag, group_method);
471                 keyingset->active_path = BLI_listbase_count(&keyingset->paths);
472         }
473         else {
474                 BKE_report(reports, RPT_ERROR, "Keying set path could not be added");
475         }
476         
477         /* return added path */
478         return ksp;
479 }
480
481 static void rna_KeyingSet_paths_remove(KeyingSet *keyingset, ReportList *reports, PointerRNA *ksp_ptr)
482 {
483         KS_Path *ksp = ksp_ptr->data;
484
485         /* if data is valid, call the API function for this */
486         if ((keyingset && ksp) == false) {
487                 BKE_report(reports, RPT_ERROR, "Keying set path could not be removed");
488                 return;
489         }
490
491         /* remove the active path from the KeyingSet */
492         BKE_keyingset_free_path(keyingset, ksp);
493         RNA_POINTER_INVALIDATE(ksp_ptr);
494
495         /* the active path number will most likely have changed */
496         /* TODO: we should get more fancy and actually check if it was removed, but this will do for now */
497         keyingset->active_path = 0;
498 }
499
500 static void rna_KeyingSet_paths_clear(KeyingSet *keyingset, ReportList *reports)
501 {
502         /* if data is valid, call the API function for this */
503         if (keyingset) {
504                 KS_Path *ksp, *kspn;
505                 
506                 /* free each path as we go to avoid looping twice */
507                 for (ksp = keyingset->paths.first; ksp; ksp = kspn) {
508                         kspn = ksp->next;
509                         BKE_keyingset_free_path(keyingset, ksp);
510                 }
511                         
512                 /* reset the active path, since there aren't any left */
513                 keyingset->active_path = 0;
514         }
515         else {
516                 BKE_report(reports, RPT_ERROR, "Keying set paths could not be removed");
517         }
518 }
519
520 /* needs wrapper function to push notifier */
521 static NlaTrack *rna_NlaTrack_new(AnimData *adt, bContext *C, NlaTrack *track)
522 {
523         NlaTrack *new_track = BKE_nlatrack_add(adt, track);
524
525         WM_event_add_notifier(C, NC_ANIMATION | ND_NLA | NA_ADDED, NULL);
526
527         return new_track;
528 }
529
530 static void rna_NlaTrack_remove(AnimData *adt, bContext *C, ReportList *reports, PointerRNA *track_ptr)
531 {
532         NlaTrack *track = track_ptr->data;
533
534         if (BLI_findindex(&adt->nla_tracks, track) == -1) {
535                 BKE_reportf(reports, RPT_ERROR, "NlaTrack '%s' cannot be removed", track->name);
536                 return;
537         }
538
539         BKE_nlatrack_free(&adt->nla_tracks, track);
540         RNA_POINTER_INVALIDATE(track_ptr);
541
542         WM_event_add_notifier(C, NC_ANIMATION | ND_NLA | NA_REMOVED, NULL);
543 }
544
545 static PointerRNA rna_NlaTrack_active_get(PointerRNA *ptr)
546 {
547         AnimData *adt = (AnimData *)ptr->data;
548         NlaTrack *track = BKE_nlatrack_find_active(&adt->nla_tracks);
549         return rna_pointer_inherit_refine(ptr, &RNA_NlaTrack, track);
550 }
551
552 static void rna_NlaTrack_active_set(PointerRNA *ptr, PointerRNA value)
553 {
554         AnimData *adt = (AnimData *)ptr->data;
555         NlaTrack *track = (NlaTrack *)value.data;
556         BKE_nlatrack_set_active(&adt->nla_tracks, track);
557 }
558
559
560 static FCurve *rna_Driver_from_existing(AnimData *adt, bContext *C, FCurve *src_driver)
561 {
562         /* verify that we've got a driver to duplicate */
563         if (ELEM(NULL, src_driver, src_driver->driver)) {
564                 BKE_report(CTX_wm_reports(C), RPT_ERROR, "No valid driver data to create copy of");
565                 return NULL;
566         }
567         else {
568                 /* just make a copy of the existing one and add to self */
569                 FCurve *new_fcu = copy_fcurve(src_driver);
570                 
571                 /* XXX: if we impose any ordering on these someday, this will be problematic */
572                 BLI_addtail(&adt->drivers, new_fcu);
573                 return new_fcu;
574         }
575 }
576
577 static FCurve *rna_Driver_find(AnimData *adt, ReportList *reports, const char *data_path, int index)
578 {
579         if (data_path[0] == '\0') {
580                 BKE_report(reports, RPT_ERROR, "F-Curve data path empty, invalid argument");
581                 return NULL;
582         }
583
584         /* Returns NULL if not found. */
585         return list_find_fcurve(&adt->drivers, data_path, index);
586 }
587
588 bool rna_AnimaData_override_apply(
589         PointerRNA *ptr_dst, PointerRNA *ptr_src, PointerRNA *ptr_storage,
590         PropertyRNA *prop_dst, PropertyRNA *prop_src, PropertyRNA *UNUSED(prop_storage),
591         const int len_dst, const int len_src, const int len_storage,
592         IDOverrideStaticPropertyOperation *opop)
593 {
594         BLI_assert(len_dst == len_src && (!ptr_storage || len_dst == len_storage) && len_dst == 0);
595         BLI_assert(opop->operation == IDOVERRIDESTATIC_OP_REPLACE && "Unsupported RNA override operation on animdata pointer");
596         UNUSED_VARS_NDEBUG(ptr_storage, len_dst, len_src, len_storage, opop);
597
598         /* AnimData is a special case, since you cannot edit/replace it, it's either existent or not. */
599         AnimData *adt_dst = RNA_property_pointer_get(ptr_dst, prop_dst).data;
600         AnimData *adt_src = RNA_property_pointer_get(ptr_src, prop_src).data;
601
602         if (adt_dst == NULL && adt_src != NULL) {
603                 /* Copy anim data from reference into final local ID. */
604                 BKE_animdata_copy_id(NULL, ptr_dst->id.data, ptr_src->id.data, false, true);
605                 return true;
606         }
607         else if (adt_dst != NULL && adt_src == NULL) {
608                 /* Override has cleared/removed anim data from its reference. */
609                 BKE_animdata_free(ptr_dst->id.data, true);
610                 return true;
611         }
612
613         return false;
614 }
615
616 #else
617
618 /* helper function for Keying Set -> keying settings */
619 static void rna_def_common_keying_flags(StructRNA *srna, short reg)
620 {
621         PropertyRNA *prop;
622         
623         /* override scene/userpref defaults? */
624         prop = RNA_def_property(srna, "use_insertkey_override_needed", PROP_BOOLEAN, PROP_NONE);
625         RNA_def_property_boolean_sdna(prop, NULL, "keyingoverride", INSERTKEY_NEEDED);
626         RNA_def_property_ui_text(prop, "Override Insert Keyframes Default- Only Needed", 
627                                  "Override default setting to only insert keyframes where they're needed in the relevant F-Curves");
628         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
629         
630         prop = RNA_def_property(srna, "use_insertkey_override_visual", PROP_BOOLEAN, PROP_NONE);
631         RNA_def_property_boolean_sdna(prop, NULL, "keyingoverride", INSERTKEY_MATRIX);
632         RNA_def_property_ui_text(prop, "Override Insert Keyframes Default - Visual", 
633                                  "Override default setting to insert keyframes based on 'visual transforms'");
634         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
635         
636         prop = RNA_def_property(srna, "use_insertkey_override_xyz_to_rgb", PROP_BOOLEAN, PROP_NONE);
637         RNA_def_property_boolean_sdna(prop, NULL, "keyingoverride", INSERTKEY_XYZ2RGB);
638         RNA_def_property_ui_text(prop, "Override F-Curve Colors - XYZ to RGB",
639                                 "Override default setting to set color for newly added transformation F-Curves "
640                                 "(Location, Rotation, Scale) to be based on the transform axis");
641         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
642         
643         
644         /* value to override defaults with */
645         prop = RNA_def_property(srna, "use_insertkey_needed", PROP_BOOLEAN, PROP_NONE);
646         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_NEEDED);
647         RNA_def_property_ui_text(prop, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves");
648         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
649         
650         prop = RNA_def_property(srna, "use_insertkey_visual", PROP_BOOLEAN, PROP_NONE);
651         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_MATRIX);
652         RNA_def_property_ui_text(prop, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'");
653         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
654         
655         prop = RNA_def_property(srna, "use_insertkey_xyz_to_rgb", PROP_BOOLEAN, PROP_NONE);
656         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_XYZ2RGB);
657         RNA_def_property_ui_text(prop, "F-Curve Colors - XYZ to RGB", "Color for newly added transformation F-Curves (Location, Rotation, Scale) is based on the transform axis");
658         if (reg) RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
659 }
660
661 /* --- */
662
663 /* To avoid repeating it twice! */
664 #define KEYINGSET_IDNAME_DOC \
665     "If this is set, the Keying Set gets a custom ID, otherwise it takes " \
666     "the name of the class used to define the Keying Set (for example, "   \
667     "if the class name is \"BUILTIN_KSI_location\", and bl_idname is not " \
668     "set by the script, then bl_idname = \"BUILTIN_KSI_location\")"
669
670
671 static void rna_def_keyingset_info(BlenderRNA *brna)
672 {
673         StructRNA *srna;
674         PropertyRNA *prop;
675         FunctionRNA *func;
676         PropertyRNA *parm;
677         
678         srna = RNA_def_struct(brna, "KeyingSetInfo", NULL);
679         RNA_def_struct_sdna(srna, "KeyingSetInfo");
680         RNA_def_struct_ui_text(srna, "Keying Set Info", "Callback function defines for builtin Keying Sets");
681         RNA_def_struct_refine_func(srna, "rna_KeyingSetInfo_refine");
682         RNA_def_struct_register_funcs(srna, "rna_KeyingSetInfo_register", "rna_KeyingSetInfo_unregister", NULL);
683         
684         /* Properties --------------------- */
685         
686         RNA_define_verify_sdna(0); /* not in sdna */
687         
688         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
689         RNA_def_property_string_sdna(prop, NULL, "idname");
690         RNA_def_property_flag(prop, PROP_REGISTER);
691         RNA_def_property_ui_text(prop, "ID Name", KEYINGSET_IDNAME_DOC);
692         
693         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
694         RNA_def_property_string_sdna(prop, NULL, "name");
695         RNA_def_property_ui_text(prop, "UI Name", "");
696         RNA_def_struct_name_property(srna, prop);
697         RNA_def_property_flag(prop, PROP_REGISTER);
698         
699         prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE);
700         RNA_def_property_string_sdna(prop, NULL, "description");
701         RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */
702         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
703         RNA_def_property_ui_text(prop, "Description", "A short description of the keying set");
704         
705         /* Regarding why we don't use rna_def_common_keying_flags() here:
706          * - Using it would keep this case in sync with the other places 
707          *   where these options are exposed (which are optimized for being
708          *   used in the UI).
709          * - Unlike all the other places, this case is used for defining
710          *   new "built in" Keying Sets via the Python API. In that case,
711          *   it makes more sense to expose these in a way more similar to
712          *   other places featuring bl_idname/label/description (i.e. operators)
713          */
714         prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE);
715         RNA_def_property_enum_sdna(prop, NULL, "keyingflag");
716         RNA_def_property_enum_items(prop, rna_enum_keying_flag_items);
717         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG);
718         RNA_def_property_ui_text(prop, "Options",  "Keying Set options to use when inserting keyframes");
719         
720         RNA_define_verify_sdna(1);
721         
722         /* Function Callbacks ------------- */
723         /* poll */
724         func = RNA_def_function(srna, "poll", NULL);
725         RNA_def_function_ui_description(func, "Test if Keying Set can be used or not");
726         RNA_def_function_flag(func, FUNC_REGISTER);
727         RNA_def_function_return(func, RNA_def_boolean(func, "ok", 1, "", ""));
728         parm = RNA_def_pointer(func, "context", "Context", "", "");
729         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
730         
731         /* iterator */
732         func = RNA_def_function(srna, "iterator", NULL);
733         RNA_def_function_ui_description(func, "Call generate() on the structs which have properties to be keyframed");
734         RNA_def_function_flag(func, FUNC_REGISTER);
735         parm = RNA_def_pointer(func, "context", "Context", "", "");
736         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
737         parm = RNA_def_pointer(func, "ks", "KeyingSet", "", "");
738         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
739         
740         /* generate */
741         func = RNA_def_function(srna, "generate", NULL);
742         RNA_def_function_ui_description(func, "Add Paths to the Keying Set to keyframe the properties of the given data");
743         RNA_def_function_flag(func, FUNC_REGISTER);
744         parm = RNA_def_pointer(func, "context", "Context", "", "");
745         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
746         parm = RNA_def_pointer(func, "ks", "KeyingSet", "", "");
747         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
748         parm = RNA_def_pointer(func, "data", "AnyType", "", "");
749         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
750 }
751
752 static void rna_def_keyingset_path(BlenderRNA *brna)
753 {
754         StructRNA *srna;
755         PropertyRNA *prop;
756         
757         srna = RNA_def_struct(brna, "KeyingSetPath", NULL);
758         RNA_def_struct_sdna(srna, "KS_Path");
759         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set");
760         
761         /* ID */
762         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
763         RNA_def_property_struct_type(prop, "ID");
764         RNA_def_property_flag(prop, PROP_EDITABLE);
765         RNA_def_property_editable_func(prop, "rna_ksPath_id_editable");
766         RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_ksPath_id_typef", NULL);
767         RNA_def_property_ui_text(prop, "ID-Block",
768                                  "ID-Block that keyframes for Keying Set should be added to "
769                                  "(for Absolute Keying Sets only)");
770         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
771         
772         prop = RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
773         RNA_def_property_enum_sdna(prop, NULL, "idtype");
774         RNA_def_property_enum_items(prop, rna_enum_id_type_items);
775         RNA_def_property_enum_default(prop, ID_OB);
776         RNA_def_property_enum_funcs(prop, NULL, "rna_ksPath_id_type_set", NULL);
777         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
778         RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_ID);
779         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
780         
781         /* Group */
782         prop = RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
783         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to");
784         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
785         
786         /* Grouping */
787         prop = RNA_def_property(srna, "group_method", PROP_ENUM, PROP_NONE);
788         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
789         RNA_def_property_enum_items(prop, rna_enum_keyingset_path_grouping_items);
790         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use");
791         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
792         
793         /* Path + Array Index */
794         prop = RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
795         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length",
796                                       "rna_ksPath_RnaPath_set");
797         RNA_def_property_ui_text(prop, "Data Path", "Path to property setting");
798         RNA_def_struct_name_property(srna, prop); /* XXX this is the best indicator for now... */
799         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL);
800
801         /* called 'index' when given as function arg */
802         prop = RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
803         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable");
804         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
805         
806         /* Flags */
807         prop = RNA_def_property(srna, "use_entire_array", PROP_BOOLEAN, PROP_NONE);
808         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
809         RNA_def_property_ui_text(prop, "Entire Array",
810                                  "When an 'array/vector' type is chosen (Location, Rotation, Color, etc.), "
811                                  "entire array is to be used");
812         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_EDITED, NULL); /* XXX: maybe a bit too noisy */
813         
814         /* Keyframing Settings */
815         rna_def_common_keying_flags(srna, 0);
816 }
817
818
819 /* keyingset.paths */
820 static void rna_def_keyingset_paths(BlenderRNA *brna, PropertyRNA *cprop)
821 {
822         StructRNA *srna;
823
824         FunctionRNA *func;
825         PropertyRNA *parm;
826         
827         PropertyRNA *prop;
828
829         RNA_def_property_srna(cprop, "KeyingSetPaths");
830         srna = RNA_def_struct(brna, "KeyingSetPaths", NULL);
831         RNA_def_struct_sdna(srna, "KeyingSet");
832         RNA_def_struct_ui_text(srna, "Keying set paths", "Collection of keying set paths");
833
834         
835         /* Add Path */
836         func = RNA_def_function(srna, "add", "rna_KeyingSet_paths_add");
837         RNA_def_function_ui_description(func, "Add a new path for the Keying Set");
838         RNA_def_function_flag(func, FUNC_USE_REPORTS);
839         /* return arg */
840         parm = RNA_def_pointer(func, "ksp", "KeyingSetPath", "New Path", "Path created and added to the Keying Set");
841         RNA_def_function_return(func, parm);
842         /* ID-block for target */
843         parm = RNA_def_pointer(func, "target_id", "ID", "Target ID", "ID data-block for the destination");
844         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
845         /* rna-path */
846         /* XXX hopefully this is long enough */
847         parm = RNA_def_string(func, "data_path", NULL, 256, "Data-Path", "RNA-Path to destination property");
848         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
849         /* index (defaults to -1 for entire array) */
850         RNA_def_int(func, "index", -1, -1, INT_MAX, "Index",
851                     "The index of the destination property (i.e. axis of Location/Rotation/etc.), "
852                     "or -1 for the entire array", 0, INT_MAX);
853         /* grouping */
854         RNA_def_enum(func, "group_method", rna_enum_keyingset_path_grouping_items, KSP_GROUP_KSNAME,
855                      "Grouping Method", "Method used to define which Group-name to use");
856         RNA_def_string(func, "group_name", NULL, 64, "Group Name",
857                        "Name of Action Group to assign destination to (only if grouping mode is to use this name)");
858
859
860         /* Remove Path */
861         func = RNA_def_function(srna, "remove", "rna_KeyingSet_paths_remove");
862         RNA_def_function_ui_description(func, "Remove the given path from the Keying Set");
863         RNA_def_function_flag(func, FUNC_USE_REPORTS);
864         /* path to remove */
865         parm = RNA_def_pointer(func, "path", "KeyingSetPath", "Path", "");
866         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
867         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
868
869
870         /* Remove All Paths */
871         func = RNA_def_function(srna, "clear", "rna_KeyingSet_paths_clear");
872         RNA_def_function_ui_description(func, "Remove all the paths from the Keying Set");
873         RNA_def_function_flag(func, FUNC_USE_REPORTS);
874         
875         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
876         RNA_def_property_struct_type(prop, "KeyingSetPath");
877         RNA_def_property_flag(prop, PROP_EDITABLE);
878         RNA_def_property_editable_func(prop, "rna_KeyingSet_active_ksPath_editable");
879         RNA_def_property_pointer_funcs(prop, "rna_KeyingSet_active_ksPath_get",
880                                        "rna_KeyingSet_active_ksPath_set", NULL, NULL);
881         RNA_def_property_ui_text(prop, "Active Keying Set", "Active Keying Set used to insert/delete keyframes");
882
883         prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
884         RNA_def_property_int_sdna(prop, NULL, "active_path");
885         RNA_def_property_int_funcs(prop, "rna_KeyingSet_active_ksPath_index_get", "rna_KeyingSet_active_ksPath_index_set",
886                                    "rna_KeyingSet_active_ksPath_index_range");
887         RNA_def_property_ui_text(prop, "Active Path Index", "Current Keying Set index");
888 }
889
890 static void rna_def_keyingset(BlenderRNA *brna)
891 {
892         StructRNA *srna;
893         PropertyRNA *prop;
894         
895         srna = RNA_def_struct(brna, "KeyingSet", NULL);
896         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together");
897         
898         /* Id/Label */
899         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
900         RNA_def_property_string_sdna(prop, NULL, "idname");
901         RNA_def_property_flag(prop, PROP_REGISTER);
902         RNA_def_property_ui_text(prop, "ID Name", KEYINGSET_IDNAME_DOC);
903 /*      RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_RENAME, NULL); */ /* NOTE: disabled, as ID name shouldn't be editable */
904         
905         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
906         RNA_def_property_string_sdna(prop, NULL, "name");
907         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_KeyingSet_name_set");
908         RNA_def_property_ui_text(prop, "UI Name", "");
909         RNA_def_struct_ui_icon(srna, ICON_KEYINGSET);
910         RNA_def_struct_name_property(srna, prop);
911         RNA_def_property_update(prop, NC_SCENE | ND_KEYINGSET | NA_RENAME, NULL);
912         
913         prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE);
914         RNA_def_property_string_sdna(prop, NULL, "description");
915         RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */
916         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
917         RNA_def_property_ui_text(prop, "Description", "A short description of the keying set");
918         
919         /* KeyingSetInfo (Type Info) for Builtin Sets only  */
920         prop = RNA_def_property(srna, "type_info", PROP_POINTER, PROP_NONE);
921         RNA_def_property_struct_type(prop, "KeyingSetInfo");
922         RNA_def_property_pointer_funcs(prop, "rna_KeyingSet_typeinfo_get", NULL, NULL, NULL);
923         RNA_def_property_ui_text(prop, "Type Info", "Callback function defines for built-in Keying Sets");
924         
925         /* Paths */
926         prop = RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
927         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
928         RNA_def_property_struct_type(prop, "KeyingSetPath");
929         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together");
930         rna_def_keyingset_paths(brna, prop);
931
932         /* Flags */
933         prop = RNA_def_property(srna, "is_path_absolute", PROP_BOOLEAN, PROP_NONE);
934         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
935         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
936         RNA_def_property_ui_text(prop, "Absolute",
937                                  "Keying Set defines specific paths/settings to be keyframed "
938                                  "(i.e. is not reliant on context info)");
939         
940         /* Keyframing Flags */
941         rna_def_common_keying_flags(srna, 0);
942         
943         
944         /* Keying Set API */
945         RNA_api_keyingset(srna);
946 }
947
948 #undef KEYINGSET_IDNAME_DOC
949 /* --- */
950
951 static void rna_api_animdata_nla_tracks(BlenderRNA *brna, PropertyRNA *cprop)
952 {
953         StructRNA *srna;
954         PropertyRNA *parm;
955         FunctionRNA *func;
956
957         PropertyRNA *prop;
958         
959         RNA_def_property_srna(cprop, "NlaTracks");
960         srna = RNA_def_struct(brna, "NlaTracks", NULL);
961         RNA_def_struct_sdna(srna, "AnimData");
962         RNA_def_struct_ui_text(srna, "NLA Tracks", "Collection of NLA Tracks");
963         
964         func = RNA_def_function(srna, "new", "rna_NlaTrack_new");
965         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
966         RNA_def_function_ui_description(func, "Add a new NLA Track");
967         RNA_def_pointer(func, "prev", "NlaTrack", "", "NLA Track to add the new one after");
968         /* return type */
969         parm = RNA_def_pointer(func, "track", "NlaTrack", "", "New NLA Track");
970         RNA_def_function_return(func, parm);
971         
972         func = RNA_def_function(srna, "remove", "rna_NlaTrack_remove");
973         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
974         RNA_def_function_ui_description(func, "Remove a NLA Track");
975         parm = RNA_def_pointer(func, "track", "NlaTrack", "", "NLA Track to remove");
976         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
977         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
978
979         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
980         RNA_def_property_struct_type(prop, "NlaTrack");
981         RNA_def_property_pointer_funcs(prop, "rna_NlaTrack_active_get", "rna_NlaTrack_active_set", NULL, NULL);
982         RNA_def_property_flag(prop, PROP_EDITABLE);
983         RNA_def_property_ui_text(prop, "Active Constraint", "Active Object constraint");
984         /* XXX: should (but doesn't) update the active track in the NLA window */
985         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_SELECTED, NULL);
986 }
987
988 static void rna_api_animdata_drivers(BlenderRNA *brna, PropertyRNA *cprop)
989 {
990         StructRNA *srna;
991         PropertyRNA *parm;
992         FunctionRNA *func;
993
994         /* PropertyRNA *prop; */
995         
996         RNA_def_property_srna(cprop, "AnimDataDrivers");
997         srna = RNA_def_struct(brna, "AnimDataDrivers", NULL);
998         RNA_def_struct_sdna(srna, "AnimData");
999         RNA_def_struct_ui_text(srna, "Drivers", "Collection of Driver F-Curves");
1000         
1001         /* AnimData.drivers.from_existing(...) */
1002         func = RNA_def_function(srna, "from_existing", "rna_Driver_from_existing");
1003         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1004         RNA_def_function_ui_description(func, "Add a new driver given an existing one");
1005         RNA_def_pointer(func, "src_driver", "FCurve", "", "Existing Driver F-Curve to use as template for a new one");
1006         /* return type */
1007         parm = RNA_def_pointer(func, "driver", "FCurve", "", "New Driver F-Curve");
1008         RNA_def_function_return(func, parm);
1009         
1010         /* AnimData.drivers.find(...) */
1011         func = RNA_def_function(srna, "find", "rna_Driver_find");
1012         RNA_def_function_ui_description(func, "Find a driver F-Curve. Note that this function performs a linear scan "
1013                                         "of all driver F-Curves.");
1014         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1015         parm = RNA_def_string(func, "data_path", NULL, 0, "Data Path", "F-Curve data path");
1016         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1017         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index", 0, INT_MAX);
1018         /* return type */
1019         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "The found F-Curve, or None if it doesn't exist");
1020         RNA_def_function_return(func, parm);
1021 }
1022
1023 void rna_def_animdata_common(StructRNA *srna)
1024 {
1025         PropertyRNA *prop;
1026         
1027         prop = RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
1028         RNA_def_property_pointer_sdna(prop, NULL, "adt");
1029         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1030         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
1031         RNA_def_property_override_funcs(prop, NULL, NULL, "rna_AnimaData_override_apply");
1032         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this data-block");
1033 }
1034
1035 static void rna_def_animdata(BlenderRNA *brna)
1036 {
1037         StructRNA *srna;
1038         PropertyRNA *prop;
1039         
1040         srna = RNA_def_struct(brna, "AnimData", NULL);
1041         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for data-block");
1042         RNA_def_struct_ui_icon(srna, ICON_ANIM_DATA);
1043         
1044         /* NLA */
1045         prop = RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
1046         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
1047         RNA_def_property_struct_type(prop, "NlaTrack");
1048         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers)");
1049
1050         rna_api_animdata_nla_tracks(brna, prop);
1051         
1052         /* Active Action */
1053         prop = RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
1054         /* this flag as well as the dynamic test must be defined for this to be editable... */
1055         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_ID_REFCOUNT);
1056         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
1057         RNA_def_property_pointer_funcs(prop, NULL, "rna_AnimData_action_set", NULL, "rna_Action_id_poll");
1058         RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
1059         RNA_def_property_ui_text(prop, "Action", "Active Action for this data-block");
1060         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA_ACTCHANGE, "rna_AnimData_update");
1061
1062         /* Active Action Settings */
1063         prop = RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
1064         RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
1065         RNA_def_property_enum_items(prop, rna_enum_nla_mode_extend_items);
1066         RNA_def_property_ui_text(prop, "Action Extrapolation",
1067                                  "Action to take for gaps past the Active Action's range (when evaluating with NLA)");
1068         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL);
1069         
1070         prop = RNA_def_property(srna, "action_blend_type", PROP_ENUM, PROP_NONE);
1071         RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
1072         RNA_def_property_enum_items(prop, rna_enum_nla_mode_blend_items);
1073         RNA_def_property_ui_text(prop, "Action Blending",
1074                                  "Method used for combining Active Action's result with result of NLA stack");
1075         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
1076         
1077         prop = RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_FACTOR); 
1078         RNA_def_property_float_sdna(prop, NULL, "act_influence");
1079         RNA_def_property_float_default(prop, 1.0f);
1080         RNA_def_property_range(prop, 0.0f, 1.0f);
1081         RNA_def_property_ui_text(prop, "Action Influence",
1082                                  "Amount the Active Action contributes to the result of the NLA stack");
1083         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
1084         
1085         /* Drivers */
1086         prop = RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
1087         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
1088         RNA_def_property_struct_type(prop, "FCurve");
1089         RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_STATIC);
1090         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this data-block");
1091         
1092         rna_api_animdata_drivers(brna, prop);
1093         
1094         /* General Settings */
1095         prop = RNA_def_property(srna, "use_nla", PROP_BOOLEAN, PROP_NONE);
1096         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
1097         RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block");
1098         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
1099
1100         prop = RNA_def_property(srna, "use_tweak_mode", PROP_BOOLEAN, PROP_NONE);
1101         RNA_def_property_boolean_sdna(prop, NULL, "flag", ADT_NLA_EDIT_ON);
1102         RNA_def_property_boolean_funcs(prop, NULL, "rna_AnimData_tweakmode_set");
1103         RNA_def_property_ui_text(prop, "Use NLA Tweak Mode", "Whether to enable or disable tweak mode in NLA");
1104         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL);
1105 }
1106
1107 /* --- */
1108
1109 void RNA_def_animation(BlenderRNA *brna)
1110 {
1111         rna_def_animdata(brna);
1112         
1113         rna_def_keyingset(brna);
1114         rna_def_keyingset_path(brna);
1115         rna_def_keyingset_info(brna);
1116 }
1117
1118 #endif