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