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