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