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