RNA
[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 (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
30 #include "rna_internal.h"
31
32 #include "DNA_anim_types.h"
33 #include "DNA_action_types.h"
34 #include "DNA_scene_types.h"
35
36 #include "MEM_guardedalloc.h"
37
38 #ifdef RNA_RUNTIME
39
40 static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
41 {
42         KS_Path *ksp= (KS_Path *)ptr->data;
43
44         if (ksp->rna_path)
45                 strcpy(value, ksp->rna_path);
46         else
47                 strcpy(value, "");
48 }
49
50 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
51 {
52         KS_Path *ksp= (KS_Path *)ptr->data;
53         
54         if (ksp->rna_path)
55                 return strlen(ksp->rna_path);
56         else
57                 return 0;
58 }
59
60 static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
61 {
62         KS_Path *ksp= (KS_Path *)ptr->data;
63
64         if (ksp->rna_path)
65                 MEM_freeN(ksp->rna_path);
66         
67         if (strlen(value))
68                 ksp->rna_path= BLI_strdup(value);
69         else 
70                 ksp->rna_path= NULL;
71 }
72
73 #else
74
75
76 void rna_def_keyingset_path(BlenderRNA *brna)
77 {
78         StructRNA *srna;
79         PropertyRNA *prop;
80         
81         static EnumPropertyItem prop_mode_grouping_items[] = {
82                 {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
83                 {KSP_GROUP_NONE, "NONE", 0, "None", ""},
84                 {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
85                 {KSP_GROUP_TEMPLATE_ITEM, "TEMPLATE", 0, "Innermost Context-Item Name", ""},
86                 {0, NULL, 0, NULL, NULL}};
87         
88         srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
89         RNA_def_struct_sdna(srna, "KS_Path");
90         RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set.");
91         
92         /* ID */
93         prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
94         RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only).");
95         
96         /* Group */
97         prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
98         RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to.");
99         
100         /* Grouping */
101         prop= RNA_def_property(srna, "grouping", PROP_ENUM, PROP_NONE);
102         RNA_def_property_enum_sdna(prop, NULL, "groupmode");
103         RNA_def_property_enum_items(prop, prop_mode_grouping_items);
104         RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use.");
105         
106         /* Path + Array Index */
107         prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
108         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
109         RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
110         RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property setting.");
111         
112         prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
113         //RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now editable
114         RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable.");
115         
116         /* Flags */
117         prop= RNA_def_property(srna, "entire_array", PROP_BOOLEAN, PROP_NONE);
118         RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
119         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.");
120 }
121
122 void rna_def_keyingset(BlenderRNA *brna)
123 {
124         StructRNA *srna;
125         PropertyRNA *prop;
126         
127         srna= RNA_def_struct(brna, "KeyingSet", NULL);
128         RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together.");
129         
130         /* Name */
131         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
132         RNA_def_property_ui_text(prop, "Name", "");
133         RNA_def_struct_name_property(srna, prop);
134         
135         /* Paths */
136         prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
137         RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
138         RNA_def_property_struct_type(prop, "KeyingSetPath");
139         RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together.");
140         
141         /* Flags */
142         prop= RNA_def_property(srna, "builtin", PROP_BOOLEAN, PROP_NONE);
143         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
144         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_BUILTIN);
145         RNA_def_property_ui_text(prop, "Built-In", "Keying Set is a built-in to Blender.");
146         
147                 /* TODO: for now, this is editable, but do we really want this to happen? */
148         prop= RNA_def_property(srna, "absolute", PROP_BOOLEAN, PROP_NONE);
149         RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
150         RNA_def_property_ui_text(prop, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
151         
152         /* Keyframing Flags */
153         prop= RNA_def_property(srna, "insertkey_needed", PROP_BOOLEAN, PROP_NONE);
154         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_NEEDED);
155         RNA_def_property_ui_text(prop, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
156         
157         prop= RNA_def_property(srna, "insertkey_visual", PROP_BOOLEAN, PROP_NONE);
158         RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_MATRIX);
159         RNA_def_property_ui_text(prop, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
160         
161         
162 }
163
164 /* --- */
165
166 void rna_def_animdata_common(StructRNA *srna)
167 {
168         PropertyRNA *prop;
169         
170         prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
171         RNA_def_property_pointer_sdna(prop, NULL, "adt");
172         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
173         RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock."); 
174 }
175
176 void rna_def_animdata(BlenderRNA *brna)
177 {
178         StructRNA *srna;
179         PropertyRNA *prop;
180         
181         srna= RNA_def_struct(brna, "AnimData", NULL);
182         RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
183         
184         /* NLA */
185         prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
186         RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
187         RNA_def_property_struct_type(prop, "UnknownType"); // XXX!
188         RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
189         
190         /* Action */
191         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
192         RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");  
193         
194         /* Drivers */
195         prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
196         RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
197         RNA_def_property_struct_type(prop, "FCurve");
198         RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
199         
200         /* Settings */
201 }
202
203 /* --- */
204
205 void RNA_def_animation(BlenderRNA *brna)
206 {
207         rna_def_animdata(brna);
208         
209         rna_def_keyingset(brna);
210         rna_def_keyingset_path(brna);
211 }
212
213 #endif