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