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