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