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