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