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