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