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