Patch [#24763] NLA Track & Strip methods
[blender.git] / source / blender / makesrna / intern / rna_animation.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2009), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_access.h"
28 #include "RNA_define.h"
29 #include "RNA_enum_types.h"
30
31 #include "rna_internal.h"
32
33 #include "DNA_anim_types.h"
34 #include "DNA_action_types.h"
35 #include "DNA_scene_types.h"
36
37 #include "MEM_guardedalloc.h"
38
39 #include "ED_keyframing.h"
40
41 /* exported for use in API */
42 EnumPropertyItem keyingset_path_grouping_items[] = {
43         {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
44         {KSP_GROUP_NONE, "NONE", 0, "None", ""},
45         {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 #include "BKE_animsys.h"
51 #include "BKE_nla.h"
52
53 #include "WM_api.h"
54 #include "WM_types.h"
55
56 static int rna_AnimData_action_editable(PointerRNA *ptr)
57 {
58         AnimData *adt= (AnimData *)ptr->data;
59         
60         /* active action is only editable when it is not a tweaking strip */
61         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
62                 return 0;
63         else
64                 return 1;
65 }
66
67 /* ****************************** */
68
69 /* wrapper for poll callback */
70 static int RKS_POLL_rna_internal(KeyingSetInfo *ksi, bContext *C)
71 {
72         PointerRNA ptr;
73         ParameterList list;
74         FunctionRNA *func;
75         void *ret;
76         int ok;
77
78         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
79         func= RNA_struct_find_function(&ptr, "poll");
80
81         RNA_parameter_list_create(&list, &ptr, func);
82                 /* hook up arguments */
83                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
84                 RNA_parameter_set_lookup(&list, "context", &C);
85                 
86                 /* execute the function */
87                 ksi->ext.call(C, &ptr, func, &list);
88                 
89                 /* read the result */
90                 RNA_parameter_get_lookup(&list, "ok", &ret);
91                 ok= *(int*)ret;
92         RNA_parameter_list_free(&list);
93         
94         return ok;
95 }
96
97 /* wrapper for iterator callback */
98 static void RKS_ITER_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks)
99 {
100         PointerRNA ptr;
101         ParameterList list;
102         FunctionRNA *func;
103
104         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
105         func= RNA_struct_find_function(&ptr, "iterator");
106
107         RNA_parameter_list_create(&list, &ptr, func);
108                 /* hook up arguments */
109                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
110                 RNA_parameter_set_lookup(&list, "context", &C);
111                 RNA_parameter_set_lookup(&list, "ks", &ks);
112                 
113                 /* execute the function */
114                 ksi->ext.call(C, &ptr, func, &list);
115         RNA_parameter_list_free(&list);
116 }
117
118 /* wrapper for generator callback */
119 static void RKS_GEN_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks, PointerRNA *data)
120 {
121         PointerRNA ptr;
122         ParameterList list;
123         FunctionRNA *func;
124
125         RNA_pointer_create(NULL, ksi->ext.srna, ksi, &ptr);
126         func= RNA_struct_find_function(&ptr, "generate");
127
128         RNA_parameter_list_create(&list, &ptr, func);
129                 /* hook up arguments */
130                 RNA_parameter_set_lookup(&list, "ksi", &ksi);
131                 RNA_parameter_set_lookup(&list, "context", &C);
132                 RNA_parameter_set_lookup(&list, "ks", &ks);
133                 RNA_parameter_set_lookup(&list, "data", data);
134                 
135                 /* execute the function */
136                 ksi->ext.call(C, &ptr, func, &list);
137         RNA_parameter_list_free(&list);
138 }
139
140 /* ------ */
141
142 // XXX: the exact purpose of this is not too clear... maybe we want to revise this at some point?
143 static StructRNA *rna_KeyingSetInfo_refine(PointerRNA *ptr)
144 {
145         KeyingSetInfo *ksi= (KeyingSetInfo *)ptr->data;
146         return (ksi->ext.srna)? ksi->ext.srna: &RNA_KeyingSetInfo;
147 }
148
149 static void rna_KeyingSetInfo_unregister(const bContext *C, StructRNA *type)
150 {
151         KeyingSetInfo *ksi= RNA_struct_blender_type_get(type);
152
153         if (ksi == NULL)
154                 return;
155         
156         /* free RNA data referencing this */
157         RNA_struct_free_extension(type, &ksi->ext);
158         RNA_struct_free(&BLENDER_RNA, type);
159         
160         /* unlink Blender-side data */
161         ANIM_keyingset_info_unregister(C, ksi);
162 }
163
164 static StructRNA *rna_KeyingSetInfo_register(bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
165 {
166         KeyingSetInfo dummyksi = {0};
167         KeyingSetInfo *ksi;
168         PointerRNA dummyptr = {{0}};
169         int have_function[3];
170
171         /* setup dummy type info to store static properties in */
172         // TODO: perhaps we want to get users to register as if they're using 'KeyingSet' directly instead?
173         RNA_pointer_create(NULL, &RNA_KeyingSetInfo, &dummyksi, &dummyptr);
174         
175         /* validate the python class */
176         if (validate(&dummyptr, data, have_function) != 0)
177                 return NULL;
178         
179         if (strlen(identifier) >= sizeof(dummyksi.idname)) {
180                 BKE_reportf(reports, RPT_ERROR, "registering keying set info class: '%s' is too long, maximum length is %d.", identifier, (int)sizeof(dummyksi.idname));
181                 return NULL;
182         }
183         
184         /* check if we have registered this info before, and remove it */
185         ksi = ANIM_keyingset_info_find_named(dummyksi.idname);
186         if (ksi && ksi->ext.srna)
187                 rna_KeyingSetInfo_unregister(C, ksi->ext.srna);
188         
189         /* create a new KeyingSetInfo type */
190         ksi= MEM_callocN(sizeof(KeyingSetInfo), "python keying set info");
191         memcpy(ksi, &dummyksi, sizeof(KeyingSetInfo));
192         
193         /* set RNA-extensions info */
194         ksi->ext.srna= RNA_def_struct(&BLENDER_RNA, ksi->idname, "KeyingSetInfo"); 
195         ksi->ext.data= data;
196         ksi->ext.call= call;
197         ksi->ext.free= free;
198         RNA_struct_blender_type_set(ksi->ext.srna, ksi);
199         
200         /* set callbacks */
201         // NOTE: we really should have all of these... 
202         ksi->poll= (have_function[0])? RKS_POLL_rna_internal: NULL;
203         ksi->iter= (have_function[1])? RKS_ITER_rna_internal: NULL;
204         ksi->generate= (have_function[2])? RKS_GEN_rna_internal: NULL;
205         
206         /* add and register with other info as needed */
207         ANIM_keyingset_info_register(ksi);
208         
209         /* return the struct-rna added */
210         return ksi->ext.srna;
211 }
212
213 /* ****************************** */
214
215 static StructRNA *rna_ksPath_id_typef(PointerRNA *ptr)
216 {
217         KS_Path *ksp= (KS_Path*)ptr->data;
218         return ID_code_to_RNA_type(ksp->idtype);
219 }
220
221 static int rna_ksPath_id_editable(PointerRNA *ptr)
222 {
223         KS_Path *ksp= (KS_Path*)ptr->data;
224         return (ksp->idtype)? PROP_EDITABLE : 0;
225 }
226
227 static void rna_ksPath_id_type_set(PointerRNA *ptr, int value)
228 {
229         KS_Path *data= (KS_Path*)(ptr->data);
230         
231         /* set the driver type, then clear the id-block if the type is invalid */
232         data->idtype= value;
233         if ((data->id) && (GS(data->id->name) != data->idtype))
234                 data->id= NULL;
235 }
236
237 static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
238 {
239         KS_Path *ksp= (KS_Path *)ptr->data;
240
241         if (ksp->rna_path)
242                 strcpy(value, ksp->rna_path);
243         else
244                 strcpy(value, "");
245 }
246
247 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
248 {
249         KS_Path *ksp= (KS_Path *)ptr->data;
250         
251         if (ksp->rna_path)
252                 return strlen(ksp->rna_path);
253         else
254                 return 0;
255 }
256
257 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
258 {
259         KS_Path *ksp= (KS_Path *)ptr->data;
260
261         if (ksp->rna_path)
262                 MEM_freeN(ksp->rna_path);
263         
264         if (strlen(value))
265                 ksp->rna_path= BLI_strdup(value);
266         else 
267                 ksp->rna_path= NULL;
268 }
269
270 /* ****************************** */
271
272 static int rna_KeyingSet_active_ksPath_editable(PointerRNA *ptr)
273 {
274         KeyingSet *ks= (KeyingSet *)ptr->data;
275         
276         /* only editable if there are some paths to change to */
277         return (ks->paths.first != NULL);
278 }
279
280 static PointerRNA rna_KeyingSet_active_ksPath_get(PointerRNA *ptr)
281 {
282         KeyingSet *ks= (KeyingSet *)ptr->data;
283         return rna_pointer_inherit_refine(ptr, &RNA_KeyingSetPath, BLI_findlink(&ks->paths, ks->active_path-1));
284 }
285
286 static void rna_KeyingSet_active_ksPath_set(PointerRNA *ptr, PointerRNA value)
287 {
288         KeyingSet *ks= (KeyingSet *)ptr->data;
289         KS_Path *ksp= (KS_Path*)value.data;
290         ks->active_path= BLI_findindex(&ks->paths, ksp) + 1;
291 }
292
293 static int rna_KeyingSet_active_ksPath_index_get(PointerRNA *ptr)
294 {
295         KeyingSet *ks= (KeyingSet *)ptr->data;
296         return MAX2(ks->active_path-1, 0);
297 }
298
299 static void rna_KeyingSet_active_ksPath_index_set(PointerRNA *ptr, int value)
300 {
301         KeyingSet *ks= (KeyingSet *)ptr->data;
302         ks->active_path= value+1;
303 }
304
305 static void rna_KeyingSet_active_ksPath_index_range(PointerRNA *ptr, int *min, int *max)
306 {
307         KeyingSet *ks= (KeyingSet *)ptr->data;
308
309         *min= 0;
310         *max= BLI_countlist(&ks->paths)-1;
311         *max= MAX2(0, *max);
312 }
313
314 static PointerRNA rna_KeyingSet_typeinfo_get(PointerRNA *ptr)
315 {
316         KeyingSet *ks= (KeyingSet *)ptr->data;
317         KeyingSetInfo *ksi = NULL;
318         
319         /* keying set info is only for builtin Keying Sets */
320         if ((ks->flag & KEYINGSET_ABSOLUTE)==0)
321                 ksi = ANIM_keyingset_info_find_named(ks->typeinfo);
322         return rna_pointer_inherit_refine(ptr, &RNA_KeyingSetInfo, ksi);
323 }
324
325
326
327 static KS_Path *rna_KeyingSet_paths_add(KeyingSet *keyingset, ReportList *reports, 
328                 ID *id, const char rna_path[], int index, int group_method, const char group_name[])
329 {
330         KS_Path *ksp = NULL;
331         short flag = 0;
332         
333         /* special case when index = -1, we key the whole array (as with other places where index is used) */
334         if (index == -1) {
335                 flag |= KSP_FLAG_WHOLE_ARRAY;
336                 index = 0;
337         }
338         
339         /* if data is valid, call the API function for this */
340         if (keyingset) {
341                 ksp= BKE_keyingset_add_path(keyingset, id, group_name, rna_path, index, flag, group_method);
342                 keyingset->active_path= BLI_countlist(&keyingset->paths); 
343         }
344         else {
345                 BKE_report(reports, RPT_ERROR, "Keying Set Path could not be added.");
346         }
347         
348         /* return added path */
349         return ksp;
350 }
351
352 static void rna_KeyingSet_paths_remove(KeyingSet *keyingset, ReportList *reports, KS_Path *ksp)
353 {
354         /* if data is valid, call the API function for this */
355         if (keyingset && ksp) {
356                 /* remove the active path from the KeyingSet */
357                 BKE_keyingset_free_path(keyingset, ksp);
358                         
359                 /* the active path number will most likely have changed */
360                 // TODO: we should get more fancy and actually check if it was removed, but this will do for now
361                 keyingset->active_path = 0;
362         }
363         else {
364                 BKE_report(reports, RPT_ERROR, "Keying Set Path could not be removed.");
365         }
366 }
367
368 static void rna_KeyingSet_paths_clear(KeyingSet *keyingset, ReportList *reports)
369 {
370         /* if data is valid, call the API function for this */
371         if (keyingset) {
372                 KS_Path *ksp, *kspn;
373                 
374                 /* free each path as we go to avoid looping twice */
375                 for (ksp= keyingset->paths.first; ksp; ksp= kspn) {
376                         kspn= ksp->next;
377                         BKE_keyingset_free_path(keyingset, ksp);
378                 }
379                         
380                 /* reset the active path, since there aren't any left */
381                 keyingset->active_path = 0;
382         }
383         else {
384                 BKE_report(reports, RPT_ERROR, "Keying Set Paths could not be removed.");
385         }
386 }
387
388 /* needs wrapper function to push notifier */
389 static NlaTrack *rna_NlaTrack_new(AnimData *adt, bContext *C, NlaTrack *track)
390 {
391         NlaTrack *new_track = add_nlatrack(adt, track);
392
393         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_ADDED, NULL);
394
395         return new_track;
396 }
397
398 static void rna_NlaTrack_remove(AnimData *adt, bContext *C, NlaTrack *track)
399 {
400         free_nlatrack(&adt->nla_tracks, track);
401
402         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_REMOVED, NULL);
403 }
404
405 static NlaTrack *rna_NlaTrack_active(AnimData *adt, bContext *C, NlaTrack *track)
406 {
407         if (track != NULL) {
408                 BKE_nlatrack_set_active(&adt->nla_tracks, track);
409                 /* XXX: should (but doesn't) update the active track in the NLA window */
410                 WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_SELECTED, NULL);
411         }
412         return BKE_nlatrack_find_active(&adt->nla_tracks);
413 }
414
415 #else
416
417 /* helper function for Keying Set -> keying settings */
418 static void rna_def_common_keying_flags(StructRNA *srna, short reg)
419 {
420         PropertyRNA *prop;
421
422         static EnumPropertyItem keying_flag_items[] = {
423                         {INSERTKEY_NEEDED, "INSERTKEY_NEEDED", 0, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves"},
424                         {INSERTKEY_MATRIX, "INSERTKEY_VISUAL", 0, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'"},
425                         {INSERTKEY_XYZ2RGB, "INSERTKEY_XYZ_TO_RGB", 0, "F-Curve Colors - XYZ to RGB", "Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis"},
426                         {0, NULL, 0, NULL, NULL}};
427
428         prop= RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE);
429         RNA_def_property_enum_sdna(prop, NULL, "keyingflag");
430         RNA_def_property_enum_items(prop, keying_flag_items);
431         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL|PROP_ENUM_FLAG);
432         RNA_def_property_ui_text(prop, "Options",  "Keying set options");
433 }
434
435 /* --- */
436
437 static void rna_def_keyingset_info(BlenderRNA *brna)
438 {
439         StructRNA *srna;
440         PropertyRNA *prop;
441         FunctionRNA *func;
442         PropertyRNA *parm;
443         
444         srna= RNA_def_struct(brna, "KeyingSetInfo", NULL);
445         RNA_def_struct_sdna(srna, "KeyingSetInfo");
446         RNA_def_struct_ui_text(srna, "Keying Set Info", "Callback function defines for builtin Keying Sets");
447         RNA_def_struct_refine_func(srna, "rna_KeyingSetInfo_refine");
448         RNA_def_struct_register_funcs(srna, "rna_KeyingSetInfo_register", "rna_KeyingSetInfo_unregister");
449         
450         /* Properties --------------------- */
451         
452         RNA_define_verify_sdna(0); // not in sdna
453                 
454         prop= RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
455         RNA_def_property_string_sdna(prop, NULL, "idname");
456         RNA_def_property_flag(prop, PROP_REGISTER);
457                 
458         /* Name */
459         prop= RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
460         RNA_def_property_string_sdna(prop, NULL, "name");
461         RNA_def_property_ui_text(prop, "Name", "");
462         RNA_def_struct_name_property(srna, prop);
463         RNA_def_property_flag(prop, PROP_REGISTER);
464         
465         rna_def_common_keying_flags(srna, 1); /* '1' arg here is to indicate that we need these to be set on registering */
466         
467         RNA_define_verify_sdna(1);
468         
469         /* Function Callbacks ------------- */
470                 /* poll */
471         func= RNA_def_function(srna, "poll", NULL);
472         RNA_def_function_ui_description(func, "Test if Keying Set can be used or not");
473         RNA_def_function_flag(func, FUNC_REGISTER);
474         RNA_def_function_return(func, RNA_def_boolean(func, "ok", 1, "", ""));
475         parm= RNA_def_pointer(func, "context", "Context", "", "");
476         RNA_def_property_flag(parm, PROP_REQUIRED);
477         
478                 /* iterator */
479         func= RNA_def_function(srna, "iterator", NULL);
480         RNA_def_function_ui_description(func, "Call generate() on the structs which have properties to be keyframed");
481         RNA_def_function_flag(func, FUNC_REGISTER);
482         parm= RNA_def_pointer(func, "context", "Context", "", "");
483         RNA_def_property_flag(parm, PROP_REQUIRED);
484         parm= RNA_def_pointer(func, "ks", "KeyingSet", "", "");
485         RNA_def_property_flag(parm, PROP_REQUIRED);
486         
487                 /* generate */
488         func= RNA_def_function(srna, "generate", NULL);
489         RNA_def_function_ui_description(func, "Add Paths to the Keying Set to keyframe the properties of the given data");
490         RNA_def_function_flag(func, FUNC_REGISTER);
491         parm= RNA_def_pointer(func, "context", "Context", "", "");
492         RNA_def_property_flag(parm, PROP_REQUIRED);
493         parm= RNA_def_pointer(func, "ks", "KeyingSet", "", "");
494         RNA_def_property_flag(parm, PROP_REQUIRED);
495         parm= RNA_def_pointer(func, "data", "AnyType", "", ""); 
496         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
497 }
498
499 static void rna_def_keyingset_path(BlenderRNA *brna)
500 {
501         StructRNA *srna;
502         PropertyRNA *prop;
503         
504         srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
505         RNA_def_struct_sdna(srna, "KS_Path");
506         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set");
507         
508         /* ID */
509         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
510         RNA_def_property_struct_type(prop, "ID");
511         RNA_def_property_flag(prop, PROP_EDITABLE);
512         RNA_def_property_editable_func(prop, "rna_ksPath_id_editable");
513         RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_ksPath_id_typef", NULL);
514         RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only)");
515         
516         prop= RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
517         RNA_def_property_enum_sdna(prop, NULL, "idtype");
518         RNA_def_property_enum_items(prop, id_type_items);
519         RNA_def_property_enum_default(prop, ID_OB);
520         RNA_def_property_enum_funcs(prop, NULL, "rna_ksPath_id_type_set", NULL);
521         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
522         
523         /* Group */
524         prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
525         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to");
526         
527         /* Grouping */
528         prop= RNA_def_property(srna, "group_method", PROP_ENUM, PROP_NONE);
529         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
530         RNA_def_property_enum_items(prop, keyingset_path_grouping_items);
531         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use");
532         
533         /* Path + Array Index */
534         prop= RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
535         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
536         RNA_def_property_ui_text(prop, "Data Path", "Path to property setting");
537         RNA_def_struct_name_property(srna, prop); // XXX this is the best indicator for now...
538         
539         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
540         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable");
541         
542         /* Flags */
543         prop= RNA_def_property(srna, "use_entire_array", PROP_BOOLEAN, PROP_NONE);
544         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
545         RNA_def_property_ui_text(prop, "Entire Array", "When an 'array/vector' type is chosen (Location, Rotation, Color, etc.), entire array is to be used");
546         
547         /* Keyframing Settings */
548         rna_def_common_keying_flags(srna, 0);
549 }
550
551
552 /* keyingset.paths */
553 static void rna_def_keyingset_paths(BlenderRNA *brna, PropertyRNA *cprop)
554 {
555         StructRNA *srna;
556
557         FunctionRNA *func;
558         PropertyRNA *parm;
559         
560         PropertyRNA *prop;
561
562         RNA_def_property_srna(cprop, "KeyingSetPaths");
563         srna= RNA_def_struct(brna, "KeyingSetPaths", NULL);
564         RNA_def_struct_sdna(srna, "KeyingSet");
565         RNA_def_struct_ui_text(srna, "Keying set paths", "Collection of keying set paths");
566
567         
568         /* Add Path */
569         func= RNA_def_function(srna, "add", "rna_KeyingSet_paths_add");
570         RNA_def_function_ui_description(func, "Add a new path for the Keying Set.");
571         RNA_def_function_flag(func, FUNC_USE_REPORTS);
572                 /* return arg */
573         parm= RNA_def_pointer(func, "ksp", "KeyingSetPath", "New Path", "Path created and added to the Keying Set");
574                 RNA_def_function_return(func, parm);
575                 /* ID-block for target */
576         parm= RNA_def_pointer(func, "target_id", "ID", "Target ID", "ID-Datablock for the destination."); 
577                 RNA_def_property_flag(parm, PROP_REQUIRED);
578                 /* rna-path */
579         parm= RNA_def_string(func, "data_path", "", 256, "Data-Path", "RNA-Path to destination property."); // xxx hopefully this is long enough
580                 RNA_def_property_flag(parm, PROP_REQUIRED);
581                 /* index (defaults to -1 for entire array) */
582         RNA_def_int(func, "index", -1, -1, INT_MAX, "Index", "The index of the destination property (i.e. axis of Location/Rotation/etc.), or -1 for the entire array.", 0, INT_MAX);
583                 /* grouping */
584         RNA_def_enum(func, "group_method", keyingset_path_grouping_items, KSP_GROUP_KSNAME, "Grouping Method", "Method used to define which Group-name to use.");
585         RNA_def_string(func, "group_name", "", 64, "Group Name", "Name of Action Group to assign destination to (only if grouping mode is to use this name).");
586
587
588         /* Remove Path */
589         func= RNA_def_function(srna, "remove", "rna_KeyingSet_paths_remove");
590         RNA_def_function_ui_description(func, "Remove the given path from the Keying Set.");
591         RNA_def_function_flag(func, FUNC_USE_REPORTS);
592                 /* path to remove */
593         parm= RNA_def_pointer(func, "path", "KeyingSetPath", "Path", ""); 
594                 RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
595
596
597         /* Remove All Paths */
598         func= RNA_def_function(srna, "clear", "rna_KeyingSet_paths_clear");
599         RNA_def_function_ui_description(func, "Remove all the paths from the Keying Set.");
600         RNA_def_function_flag(func, FUNC_USE_REPORTS);
601         
602         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
603         RNA_def_property_struct_type(prop, "KeyingSetPath");
604         RNA_def_property_flag(prop, PROP_EDITABLE);
605         RNA_def_property_editable_func(prop, "rna_KeyingSet_active_ksPath_editable");
606         RNA_def_property_pointer_funcs(prop, "rna_KeyingSet_active_ksPath_get", "rna_KeyingSet_active_ksPath_set", NULL, NULL);
607         RNA_def_property_ui_text(prop, "Active Keying Set", "Active Keying Set used to insert/delete keyframes");
608
609         prop= RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
610         RNA_def_property_int_sdna(prop, NULL, "active_path");
611         RNA_def_property_int_funcs(prop, "rna_KeyingSet_active_ksPath_index_get", "rna_KeyingSet_active_ksPath_index_set", "rna_KeyingSet_active_ksPath_index_range");
612         RNA_def_property_ui_text(prop, "Active Path Index", "Current Keying Set index");
613 }
614
615 static void rna_def_keyingset(BlenderRNA *brna)
616 {
617         StructRNA *srna;
618         PropertyRNA *prop;
619         
620         srna= RNA_def_struct(brna, "KeyingSet", NULL);
621         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together");
622         
623         /* Name */
624         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
625         RNA_def_property_ui_text(prop, "Name", "");
626         RNA_def_struct_ui_icon(srna, ICON_KEY_HLT); // TODO: we need a dedicated icon
627         RNA_def_struct_name_property(srna, prop);
628         
629         /* KeyingSetInfo (Type Info) for Builtin Sets only  */
630         prop= RNA_def_property(srna, "type_info", PROP_POINTER, PROP_NONE);
631         RNA_def_property_struct_type(prop, "KeyingSetInfo");
632         RNA_def_property_pointer_funcs(prop, "rna_KeyingSet_typeinfo_get", NULL, NULL, NULL);
633         RNA_def_property_ui_text(prop, "Type Info", "Callback function defines for built-in Keying Sets");
634         
635         /* Paths */
636         prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
637         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
638         RNA_def_property_struct_type(prop, "KeyingSetPath");
639         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together");
640         rna_def_keyingset_paths(brna, prop);
641
642         /* Flags */
643         prop= RNA_def_property(srna, "is_path_absolute", PROP_BOOLEAN, PROP_NONE);
644         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
645         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
646         RNA_def_property_ui_text(prop, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)"); 
647         
648         /* Keyframing Flags */
649         rna_def_common_keying_flags(srna, 0);
650         
651         
652         /* Keying Set API */
653         RNA_api_keyingset(srna);
654 }
655
656 /* --- */
657
658 static void rna_api_animdata_nla_tracks(BlenderRNA *brna, PropertyRNA *cprop)
659 {
660         StructRNA *srna;
661         PropertyRNA *parm;
662         FunctionRNA *func;
663         
664         RNA_def_property_srna(cprop, "NlaTracks");
665         srna= RNA_def_struct(brna, "NlaTracks", NULL);
666         RNA_def_struct_sdna(srna, "AnimData");
667         RNA_def_struct_ui_text(srna, "NLA Tracks", "Collection of NLA Tracks");
668         
669         func = RNA_def_function(srna, "new", "rna_NlaTrack_new");
670         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
671         RNA_def_function_ui_description(func, "Add a new NLA Tracks");
672         parm = RNA_def_pointer(func, "prev", "NlaTrack", "", "NLA Track to add the new one after.");
673         /* return type */
674         parm = RNA_def_pointer(func, "track", "NlaTrack", "", "New NLA Track.");
675         RNA_def_function_return(func, parm);
676         
677         func = RNA_def_function(srna, "remove", "rna_NlaTrack_remove");
678         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
679         RNA_def_function_ui_description(func, "Remove a NLA Track.");
680         parm = RNA_def_pointer(func, "track", "NlaTrack", "", "NLA Track to remove.");
681         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
682         
683         func = RNA_def_function(srna, "active", "rna_NlaTrack_active");
684         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
685         RNA_def_function_ui_description(func, "Set active NLA Track");
686         parm = RNA_def_pointer(func, "track", "NlaTrack", "", "NLA Track set active.");
687         /* return type */
688         parm = RNA_def_pointer(func, "active_track", "NlaTrack", "", "Active NLA Track.");
689         RNA_def_function_return(func, parm);
690 }
691
692 void rna_def_animdata_common(StructRNA *srna)
693 {
694         PropertyRNA *prop;
695         
696         prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
697         RNA_def_property_pointer_sdna(prop, NULL, "adt");
698         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
699         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock");  
700 }
701
702 void rna_def_animdata(BlenderRNA *brna)
703 {
704         StructRNA *srna;
705         PropertyRNA *prop;
706         
707         srna= RNA_def_struct(brna, "AnimData", NULL);
708         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock");
709         
710         /* NLA */
711         prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
712         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
713         RNA_def_property_struct_type(prop, "NlaTrack");
714         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers)");
715
716         rna_api_animdata_nla_tracks(brna, prop);
717         
718         /* Active Action */
719         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
720         RNA_def_property_flag(prop, PROP_EDITABLE); /* this flag as well as the dynamic test must be defined for this to be editable... */
721         RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
722         RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock");
723
724         /* Active Action Settings */
725         prop= RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
726         RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
727         RNA_def_property_enum_items(prop, nla_mode_extend_items);
728         RNA_def_property_ui_text(prop, "Action Extrapolation", "Action to take for gaps past the Active Action's range (when evaluating with NLA)");
729         
730         prop= RNA_def_property(srna, "action_blend_type", PROP_ENUM, PROP_NONE);
731         RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
732         RNA_def_property_enum_items(prop, nla_mode_blend_items);
733         RNA_def_property_ui_text(prop, "Action Blending", "Method used for combining Active Action's result with result of NLA stack");
734         
735         prop= RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_NONE);
736         RNA_def_property_float_sdna(prop, NULL, "act_influence");
737         RNA_def_property_float_default(prop, 1.0f);
738         RNA_def_property_range(prop, 0.0f, 1.0f);
739         RNA_def_property_ui_text(prop, "Action Influence", "Amount the Active Action contributes to the result of the NLA stack");
740         
741         /* Drivers */
742         prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
743         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
744         RNA_def_property_struct_type(prop, "FCurve");
745         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock");
746         
747         /* General Settings */
748         prop= RNA_def_property(srna, "use_nla", PROP_BOOLEAN, PROP_NONE);
749         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
750         RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block");
751 }
752
753 /* --- */
754
755 void RNA_def_animation(BlenderRNA *brna)
756 {
757         rna_def_animdata(brna);
758         
759         rna_def_keyingset(brna);
760         rna_def_keyingset_path(brna);
761         rna_def_keyingset_info(brna);
762 }
763
764 #endif