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