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