NLA Tweaks:
[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 (2008), Roland Hess
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.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 #ifdef RNA_RUNTIME
40
41 static int rna_AnimData_action_editable(PointerRNA *ptr)
42 {
43         AnimData *adt= (AnimData *)ptr->data;
44         
45         /* active action is only editable when it is not a tweaking strip */
46         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
47                 return 0;
48         else
49                 return 1;
50 }
51
52 static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
53 {
54         KS_Path *ksp= (KS_Path *)ptr->data;
55
56         if (ksp->rna_path)
57                 strcpy(value, ksp->rna_path);
58         else
59                 strcpy(value, "");
60 }
61
62 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
63 {
64         KS_Path *ksp= (KS_Path *)ptr->data;
65         
66         if (ksp->rna_path)
67                 return strlen(ksp->rna_path);
68         else
69                 return 0;
70 }
71
72 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
73 {
74         KS_Path *ksp= (KS_Path *)ptr->data;
75
76         if (ksp->rna_path)
77                 MEM_freeN(ksp->rna_path);
78         
79         if (strlen(value))
80                 ksp->rna_path= BLI_strdup(value);
81         else 
82                 ksp->rna_path= NULL;
83 }
84
85 #else
86
87
88 void rna_def_keyingset_path(BlenderRNA *brna)
89 {
90         StructRNA *srna;
91         PropertyRNA *prop;
92         
93         static EnumPropertyItem prop_mode_grouping_items[] = {
94                 {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
95                 {KSP_GROUP_NONE, "NONE", 0, "None", ""},
96                 {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
97                 {KSP_GROUP_TEMPLATE_ITEM, "TEMPLATE", 0, "Innermost Context-Item Name", ""},
98                 {0, NULL, 0, NULL, NULL}};
99         
100         srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
101         RNA_def_struct_sdna(srna, "KS_Path");
102         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set.");
103         
104         /* ID */
105         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
106         RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only).");
107         
108         /* Group */
109         prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
110         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to.");
111         
112         /* Grouping */
113         prop= RNA_def_property(srna, "grouping", PROP_ENUM, PROP_NONE);
114         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
115         RNA_def_property_enum_items(prop, prop_mode_grouping_items);
116         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use.");
117         
118         /* Path + Array Index */
119         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
120         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
121         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
122         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property setting.");
123         
124         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
125         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
126         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable.");
127         
128         /* Flags */
129         prop= RNA_def_property(srna, "entire_array", PROP_BOOLEAN, PROP_NONE);
130         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
131         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.");
132 }
133
134 void rna_def_keyingset(BlenderRNA *brna)
135 {
136         StructRNA *srna;
137         PropertyRNA *prop;
138         
139         srna= RNA_def_struct(brna, "KeyingSet", NULL);
140         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together.");
141         
142         /* Name */
143         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
144         RNA_def_property_ui_text(prop, "Name", "");
145         RNA_def_struct_name_property(srna, prop);
146         
147         /* Paths */
148         prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
149         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
150         RNA_def_property_struct_type(prop, "KeyingSetPath");
151         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together.");
152         
153         /* Flags */
154         prop= RNA_def_property(srna, "builtin", PROP_BOOLEAN, PROP_NONE);
155         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
156         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_BUILTIN);
157         RNA_def_property_ui_text(prop, "Built-In", "Keying Set is a built-in to Blender.");
158         
159                 /* TODO: for now, this is editable, but do we really want this to happen? */
160         prop= RNA_def_property(srna, "absolute", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
162         RNA_def_property_ui_text(prop, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
163         
164         /* Keyframing Flags */
165         prop= RNA_def_property(srna, "insertkey_needed", PROP_BOOLEAN, PROP_NONE);
166         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_NEEDED);
167         RNA_def_property_ui_text(prop, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
168         
169         prop= RNA_def_property(srna, "insertkey_visual", PROP_BOOLEAN, PROP_NONE);
170         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_MATRIX);
171         RNA_def_property_ui_text(prop, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
172         
173         
174 }
175
176 /* --- */
177
178 void rna_def_animdata_common(StructRNA *srna)
179 {
180         PropertyRNA *prop;
181         
182         prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
183         RNA_def_property_pointer_sdna(prop, NULL, "adt");
184         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
185         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock."); 
186 }
187
188 void rna_def_animdata(BlenderRNA *brna)
189 {
190         StructRNA *srna;
191         PropertyRNA *prop;
192         
193         srna= RNA_def_struct(brna, "AnimData", NULL);
194         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
195         
196         /* NLA */
197         prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
198         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
199         RNA_def_property_struct_type(prop, "NlaTrack");
200         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
201         
202         /* Active Action */
203         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
204         RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");
205         RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
206         
207         /* Active Action Settings */
208         prop= RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
209         RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
210         RNA_def_property_enum_items(prop, nla_mode_extend_items);
211         RNA_def_property_ui_text(prop, "Action Extrapolation", "Action to take for gaps past the Active Action's range (when evaluating with NLA).");
212         
213         prop= RNA_def_property(srna, "action_blending", PROP_ENUM, PROP_NONE);
214         RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
215         RNA_def_property_enum_items(prop, nla_mode_blend_items);
216         RNA_def_property_ui_text(prop, "Action Blending", "Method used for combining Active Action's result with result of NLA stack.");
217         
218         prop= RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_NONE);
219         RNA_def_property_float_sdna(prop, NULL, "act_influence");
220         RNA_def_property_float_default(prop, 1.0f);
221         RNA_def_property_range(prop, 0.0f, 1.0f);
222         RNA_def_property_ui_text(prop, "Action Influence", "Amount the Active Action contributes to the result of the NLA stack.");
223         
224         /* Drivers */
225         prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
226         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
227         RNA_def_property_struct_type(prop, "FCurve");
228         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
229         
230         /* General Settings */
231         prop= RNA_def_property(srna, "nla_enabled", PROP_BOOLEAN, PROP_NONE);
232         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
233         RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block.");
234 }
235
236 /* --- */
237
238 void RNA_def_animation(BlenderRNA *brna)
239 {
240         rna_def_animdata(brna);
241         
242         rna_def_keyingset(brna);
243         rna_def_keyingset_path(brna);
244 }
245
246 #endif