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