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