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