use static functions where possible for some local functions.
[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_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_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
61 {
62         KS_Path *ksp= (KS_Path *)ptr->data;
63
64         if (ksp->rna_path)
65                 strcpy(value, ksp->rna_path);
66         else
67                 strcpy(value, "");
68 }
69
70 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
71 {
72         KS_Path *ksp= (KS_Path *)ptr->data;
73         
74         if (ksp->rna_path)
75                 return strlen(ksp->rna_path);
76         else
77                 return 0;
78 }
79
80 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
81 {
82         KS_Path *ksp= (KS_Path *)ptr->data;
83
84         if (ksp->rna_path)
85                 MEM_freeN(ksp->rna_path);
86         
87         if (strlen(value))
88                 ksp->rna_path= BLI_strdup(value);
89         else 
90                 ksp->rna_path= NULL;
91 }
92
93 #else
94
95
96 static void rna_def_keyingset_path(BlenderRNA *brna)
97 {
98         StructRNA *srna;
99         PropertyRNA *prop;
100         
101         srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
102         RNA_def_struct_sdna(srna, "KS_Path");
103         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set.");
104         
105         /* ID */
106         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
107         RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only).");
108         
109         /* Group */
110         prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
111         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to.");
112         
113         /* Grouping */
114         prop= RNA_def_property(srna, "grouping", PROP_ENUM, PROP_NONE);
115         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
116         RNA_def_property_enum_items(prop, keyingset_path_grouping_items);
117         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use.");
118         
119         /* Path + Array Index */
120         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
121         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
122         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
123         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property setting.");
124         
125         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
126         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
127         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable.");
128         
129         /* Flags */
130         prop= RNA_def_property(srna, "entire_array", PROP_BOOLEAN, PROP_NONE);
131         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
132         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.");
133 }
134
135 static void rna_def_keyingset(BlenderRNA *brna)
136 {
137         StructRNA *srna;
138         PropertyRNA *prop;
139         
140         srna= RNA_def_struct(brna, "KeyingSet", NULL);
141         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together.");
142         
143         /* Name */
144         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
145         RNA_def_property_ui_text(prop, "Name", "");
146         RNA_def_struct_name_property(srna, prop);
147         
148         /* Paths */
149         prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
150         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
151         RNA_def_property_struct_type(prop, "KeyingSetPath");
152         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together.");
153         
154         /* Flags */
155         prop= RNA_def_property(srna, "builtin", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
157         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_BUILTIN);
158         RNA_def_property_ui_text(prop, "Built-In", "Keying Set is a built-in to Blender.");
159         
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         /* Keying Set API */
174         RNA_api_keyingset(srna);
175 }
176
177 /* --- */
178
179 void rna_def_animdata_common(StructRNA *srna)
180 {
181         PropertyRNA *prop;
182         
183         prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
184         RNA_def_property_pointer_sdna(prop, NULL, "adt");
185         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
186         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock."); 
187 }
188
189 void rna_def_animdata(BlenderRNA *brna)
190 {
191         StructRNA *srna;
192         PropertyRNA *prop;
193         
194         srna= RNA_def_struct(brna, "AnimData", NULL);
195         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
196         
197         /* NLA */
198         prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
199         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
200         RNA_def_property_struct_type(prop, "NlaTrack");
201         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
202         
203         /* Active Action */
204         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
205         RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");
206         RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
207         
208         /* Active Action Settings */
209         prop= RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
210         RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
211         RNA_def_property_enum_items(prop, nla_mode_extend_items);
212         RNA_def_property_ui_text(prop, "Action Extrapolation", "Action to take for gaps past the Active Action's range (when evaluating with NLA).");
213         
214         prop= RNA_def_property(srna, "action_blending", PROP_ENUM, PROP_NONE);
215         RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
216         RNA_def_property_enum_items(prop, nla_mode_blend_items);
217         RNA_def_property_ui_text(prop, "Action Blending", "Method used for combining Active Action's result with result of NLA stack.");
218         
219         prop= RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_NONE);
220         RNA_def_property_float_sdna(prop, NULL, "act_influence");
221         RNA_def_property_float_default(prop, 1.0f);
222         RNA_def_property_range(prop, 0.0f, 1.0f);
223         RNA_def_property_ui_text(prop, "Action Influence", "Amount the Active Action contributes to the result of the NLA stack.");
224         
225         /* Drivers */
226         prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
227         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
228         RNA_def_property_struct_type(prop, "FCurve");
229         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
230         
231         /* General Settings */
232         prop= RNA_def_property(srna, "nla_enabled", PROP_BOOLEAN, PROP_NONE);
233         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
234         RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block.");
235 }
236
237 /* --- */
238
239 void RNA_def_animation(BlenderRNA *brna)
240 {
241         rna_def_animdata(brna);
242         
243         rna_def_keyingset(brna);
244         rna_def_keyingset_path(brna);
245 }
246
247 #endif