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