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