Keyframing Bugfixes and Feature Requests:
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_types.h"
30 #include "RNA_enum_types.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_action_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "MEM_guardedalloc.h"
39
40 /* exported for use in API */
41 EnumPropertyItem keyingset_path_grouping_items[] = {
42         {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
43         {KSP_GROUP_NONE, "NONE", 0, "None", ""},
44         {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
45         {KSP_GROUP_TEMPLATE_ITEM, "TEMPLATE", 0, "Innermost Context-Item Name", ""},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 static int rna_AnimData_action_editable(PointerRNA *ptr)
51 {
52         AnimData *adt= (AnimData *)ptr->data;
53         
54         /* active action is only editable when it is not a tweaking strip */
55         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
56                 return 0;
57         else
58                 return 1;
59 }
60
61 static void rna_AnimData_action_set(PointerRNA *ptr, PointerRNA value)
62 {
63         AnimData *adt= (AnimData*)(ptr->data);
64         adt->action= value.data;
65 }
66
67 /* ****************************** */
68
69 static StructRNA *rna_ksPath_id_typef(PointerRNA *ptr)
70 {
71         KS_Path *ksp= (KS_Path*)ptr->data;
72         return ID_code_to_RNA_type(ksp->idtype);
73 }
74
75 static int rna_ksPath_id_editable(PointerRNA *ptr)
76 {
77         KS_Path *ksp= (KS_Path*)ptr->data;
78         return (ksp->idtype)? PROP_EDITABLE : 0;
79 }
80
81 static void rna_ksPath_id_type_set(PointerRNA *ptr, int value)
82 {
83         KS_Path *data= (KS_Path*)(ptr->data);
84         
85         /* set the driver type, then clear the id-block if the type is invalid */
86         data->idtype= value;
87         if ((data->id) && (GS(data->id->name) != data->idtype))
88                 data->id= NULL;
89 }
90
91 static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
92 {
93         KS_Path *ksp= (KS_Path *)ptr->data;
94
95         if (ksp->rna_path)
96                 strcpy(value, ksp->rna_path);
97         else
98                 strcpy(value, "");
99 }
100
101 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
102 {
103         KS_Path *ksp= (KS_Path *)ptr->data;
104         
105         if (ksp->rna_path)
106                 return strlen(ksp->rna_path);
107         else
108                 return 0;
109 }
110
111 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
112 {
113         KS_Path *ksp= (KS_Path *)ptr->data;
114
115         if (ksp->rna_path)
116                 MEM_freeN(ksp->rna_path);
117         
118         if (strlen(value))
119                 ksp->rna_path= BLI_strdup(value);
120         else 
121                 ksp->rna_path= NULL;
122 }
123
124 /* ****************************** */
125
126 static int rna_KeyingSet_active_ksPath_editable(PointerRNA *ptr)
127 {
128         KeyingSet *ks= (KeyingSet *)ptr->data;
129         
130         /* only editable if there are some paths to change to */
131         return (ks->paths.first != NULL);
132 }
133
134 static PointerRNA rna_KeyingSet_active_ksPath_get(PointerRNA *ptr)
135 {
136         KeyingSet *ks= (KeyingSet *)ptr->data;
137         return rna_pointer_inherit_refine(ptr, &RNA_KeyingSetPath, BLI_findlink(&ks->paths, ks->active_path-1));
138 }
139
140 static void rna_KeyingSet_active_ksPath_set(PointerRNA *ptr, PointerRNA value)
141 {
142         KeyingSet *ks= (KeyingSet *)ptr->data;
143         KS_Path *ksp= (KS_Path*)value.data;
144         ks->active_path= BLI_findindex(&ks->paths, ksp) + 1;
145 }
146
147 static int rna_KeyingSet_active_ksPath_index_get(PointerRNA *ptr)
148 {
149         KeyingSet *ks= (KeyingSet *)ptr->data;
150         return MAX2(ks->active_path-1, 0);
151 }
152
153 static void rna_KeyingSet_active_ksPath_index_set(PointerRNA *ptr, int value)
154 {
155         KeyingSet *ks= (KeyingSet *)ptr->data;
156         ks->active_path= value+1;
157 }
158
159 static void rna_KeyingSet_active_ksPath_index_range(PointerRNA *ptr, int *min, int *max)
160 {
161         KeyingSet *ks= (KeyingSet *)ptr->data;
162
163         *min= 0;
164         *max= BLI_countlist(&ks->paths)-1;
165         *max= MAX2(0, *max);
166 }
167
168 #else
169
170
171 static void rna_def_keyingset_path(BlenderRNA *brna)
172 {
173         StructRNA *srna;
174         PropertyRNA *prop;
175         
176         srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
177         RNA_def_struct_sdna(srna, "KS_Path");
178         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set.");
179         
180         /* ID */
181         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
182         RNA_def_property_struct_type(prop, "ID");
183         RNA_def_property_flag(prop, PROP_EDITABLE);
184         RNA_def_property_editable_func(prop, "rna_ksPath_id_editable");
185         RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_ksPath_id_typef");
186         RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only).");
187         
188         prop= RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
189         RNA_def_property_enum_sdna(prop, NULL, "idtype");
190         RNA_def_property_enum_items(prop, id_type_items);
191         RNA_def_property_enum_default(prop, ID_OB);
192         RNA_def_property_enum_funcs(prop, NULL, "rna_ksPath_id_type_set", NULL);
193         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used.");
194         
195         /* Group */
196         prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
197         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to.");
198         
199         /* Grouping */
200         prop= RNA_def_property(srna, "grouping", PROP_ENUM, PROP_NONE);
201         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
202         RNA_def_property_enum_items(prop, keyingset_path_grouping_items);
203         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use.");
204         
205         /* Path + Array Index */
206         prop= RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
207         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
208         RNA_def_property_ui_text(prop, "Data Path", "Path to property setting.");
209         RNA_def_struct_name_property(srna, prop); // XXX this is the best indicator for now...
210         
211         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
212         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable.");
213         
214         /* Flags */
215         prop= RNA_def_property(srna, "entire_array", PROP_BOOLEAN, PROP_NONE);
216         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
217         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.");
218 }
219
220 static void rna_def_keyingset(BlenderRNA *brna)
221 {
222         StructRNA *srna;
223         PropertyRNA *prop;
224         
225         srna= RNA_def_struct(brna, "KeyingSet", NULL);
226         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together.");
227         
228         /* Name */
229         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
230         RNA_def_property_ui_text(prop, "Name", "");
231         RNA_def_struct_name_property(srna, prop);
232         
233         /* Paths */
234         prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
235         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
236         RNA_def_property_struct_type(prop, "KeyingSetPath");
237         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together.");
238         
239         prop= RNA_def_property(srna, "active_path", PROP_POINTER, PROP_NONE);
240         RNA_def_property_struct_type(prop, "KeyingSetPath");
241         RNA_def_property_flag(prop, PROP_EDITABLE);
242         RNA_def_property_editable_func(prop, "rna_KeyingSet_active_ksPath_editable");
243         RNA_def_property_pointer_funcs(prop, "rna_KeyingSet_active_ksPath_get", "rna_KeyingSet_active_ksPath_set", NULL);
244         RNA_def_property_ui_text(prop, "Active Keying Set", "Active Keying Set used to insert/delete keyframes.");
245         
246         prop= RNA_def_property(srna, "active_path_index", PROP_INT, PROP_NONE);
247         RNA_def_property_int_sdna(prop, NULL, "active_path");
248         RNA_def_property_int_funcs(prop, "rna_KeyingSet_active_ksPath_index_get", "rna_KeyingSet_active_ksPath_index_set", "rna_KeyingSet_active_ksPath_index_range");
249         RNA_def_property_ui_text(prop, "Active Path Index", "Current Keying Set index.");
250         
251         /* Flags */
252         prop= RNA_def_property(srna, "builtin", PROP_BOOLEAN, PROP_NONE);
253         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
254         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_BUILTIN);
255         RNA_def_property_ui_text(prop, "Built-In", "Keying Set is a built-in to Blender.");
256         
257         prop= RNA_def_property(srna, "absolute", PROP_BOOLEAN, PROP_NONE);
258         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
259         RNA_def_property_ui_text(prop, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
260         
261         /* Keyframing Flags */
262         prop= RNA_def_property(srna, "insertkey_needed", PROP_BOOLEAN, PROP_NONE);
263         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_NEEDED);
264         RNA_def_property_ui_text(prop, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
265         
266         prop= RNA_def_property(srna, "insertkey_visual", PROP_BOOLEAN, PROP_NONE);
267         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_MATRIX);
268         RNA_def_property_ui_text(prop, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
269         
270         prop= RNA_def_property(srna, "insertkey_xyz_to_rgb", PROP_BOOLEAN, PROP_NONE);
271         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_XYZ2RGB);
272         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.");
273         
274         /* Keying Set API */
275         RNA_api_keyingset(srna);
276 }
277
278 /* --- */
279
280 void rna_def_animdata_common(StructRNA *srna)
281 {
282         PropertyRNA *prop;
283         
284         prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
285         RNA_def_property_pointer_sdna(prop, NULL, "adt");
286         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
287         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock."); 
288 }
289
290 void rna_def_animdata(BlenderRNA *brna)
291 {
292         StructRNA *srna;
293         PropertyRNA *prop;
294         
295         srna= RNA_def_struct(brna, "AnimData", NULL);
296         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
297         
298         /* NLA */
299         prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
300         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
301         RNA_def_property_struct_type(prop, "NlaTrack");
302         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
303         
304         /* Active Action */
305         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
306         RNA_def_property_pointer_funcs(prop, NULL, "rna_AnimData_action_set", NULL);
307         RNA_def_property_flag(prop, PROP_EDITABLE); /* this flag as well as the dynamic test must be defined for this to be editable... */
308         RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
309         RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");
310
311         
312         /* Active Action Settings */
313         prop= RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
314         RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
315         RNA_def_property_enum_items(prop, nla_mode_extend_items);
316         RNA_def_property_ui_text(prop, "Action Extrapolation", "Action to take for gaps past the Active Action's range (when evaluating with NLA).");
317         
318         prop= RNA_def_property(srna, "action_blending", PROP_ENUM, PROP_NONE);
319         RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
320         RNA_def_property_enum_items(prop, nla_mode_blend_items);
321         RNA_def_property_ui_text(prop, "Action Blending", "Method used for combining Active Action's result with result of NLA stack.");
322         
323         prop= RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_NONE);
324         RNA_def_property_float_sdna(prop, NULL, "act_influence");
325         RNA_def_property_float_default(prop, 1.0f);
326         RNA_def_property_range(prop, 0.0f, 1.0f);
327         RNA_def_property_ui_text(prop, "Action Influence", "Amount the Active Action contributes to the result of the NLA stack.");
328         
329         /* Drivers */
330         prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
331         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
332         RNA_def_property_struct_type(prop, "FCurve");
333         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
334         
335         /* General Settings */
336         prop= RNA_def_property(srna, "nla_enabled", PROP_BOOLEAN, PROP_NONE);
337         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
338         RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block.");
339 }
340
341 /* --- */
342
343 void RNA_def_animation(BlenderRNA *brna)
344 {
345         rna_def_animdata(brna);
346         
347         rna_def_keyingset(brna);
348         rna_def_keyingset_path(brna);
349 }
350
351 #endif