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