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