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