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