RNA: ID properties were not being shown as RNA properties anymore, fixed.
[blender.git] / source / blender / makesrna / intern / rna_ID.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).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26 #include <stdio.h>
27
28 #include "RNA_define.h"
29 #include "RNA_types.h"
30
31 #include "DNA_ID.h"
32
33 #ifdef RNA_RUNTIME
34
35 #include "BKE_idprop.h"
36 #include "BKE_library.h"
37
38 /* name functions that ignore the first two ID characters */
39 void rna_ID_name_get(PointerRNA *ptr, char *value)
40 {
41         ID *id= (ID*)ptr->data;
42         BLI_strncpy(value, id->name+2, sizeof(id->name)-2);
43 }
44
45 int rna_ID_name_length(PointerRNA *ptr)
46 {
47         ID *id= (ID*)ptr->data;
48         return strlen(id->name+2);
49 }
50
51 void rna_ID_name_set(PointerRNA *ptr, const char *value)
52 {
53         ID *id= (ID*)ptr->data;
54         BLI_strncpy(id->name+2, value, sizeof(id->name)-2);
55         test_idbutton(id->name+2);
56 }
57
58 StructRNA *rna_ID_refine(PointerRNA *ptr)
59 {
60         ID *id= (ID*)ptr->data;
61
62         switch(GS(id->name)) {
63                 case ID_AC: return &RNA_Action;
64                 case ID_AR: return &RNA_Armature;
65                 case ID_BR: return &RNA_Brush;
66                 case ID_CA: return &RNA_Camera;
67                 case ID_CU: return &RNA_Curve;
68                 case ID_GR: return &RNA_Group;
69                 case ID_IM: return &RNA_Image;
70                 //case ID_IP: return &RNA_Ipo;
71                 case ID_KE: return &RNA_Key;
72                 case ID_LA: return &RNA_Lamp;
73                 case ID_LI: return &RNA_Library;
74                 case ID_LT: return &RNA_Lattice;
75                 case ID_MA: return &RNA_Material;
76                 case ID_MB: return &RNA_MetaBall;
77                 case ID_NT: return &RNA_NodeTree;
78                 case ID_ME: return &RNA_Mesh;
79                 case ID_OB: return &RNA_Object;
80                 case ID_PA: return &RNA_ParticleSettings;
81                 case ID_SCE: return &RNA_Scene;
82                 case ID_SCR: return &RNA_Screen;
83                 case ID_SO: return &RNA_Sound;
84                 case ID_TXT: return &RNA_Text;
85                 case ID_TE: return &RNA_Texture;
86                 case ID_VF: return &RNA_VectorFont;
87                 case ID_WO: return &RNA_World;
88                 case ID_WM: return &RNA_WindowManager;
89                 default: return &RNA_ID;
90         }
91 }
92
93 void rna_ID_fake_user_set(PointerRNA *ptr, int value)
94 {
95         ID *id= (ID*)ptr->data;
96
97         if(value && !(id->flag & LIB_FAKEUSER)) {
98                 id->flag |= LIB_FAKEUSER;
99                 id->us++;
100         }
101         else if(!value && (id->flag & LIB_FAKEUSER)) {
102                 id->flag &= ~LIB_FAKEUSER;
103                 id->us--;
104         }
105 }
106
107 #else
108
109 static void rna_def_ID_properties(BlenderRNA *brna)
110 {
111         StructRNA *srna;
112         PropertyRNA *prop;
113
114         /* this is struct is used for holding the virtual
115          * PropertyRNA's for ID properties */
116         srna= RNA_def_struct(brna, "IDProperty", NULL);
117         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties.");
118         
119         /* IDP_STRING */
120         prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
121         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
122
123         /* IDP_INT */
124         prop= RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
125         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
126
127         prop= RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
128         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
129         RNA_def_property_array(prop, 1);
130
131         /* IDP_FLOAT */
132         prop= RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
133         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
134
135         prop= RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
136         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
137         RNA_def_property_array(prop, 1);
138
139         /* IDP_DOUBLE */
140         prop= RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
141         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
142
143         prop= RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
144         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
145         RNA_def_property_array(prop, 1);
146
147         /* IDP_GROUP */
148         prop= RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
149         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
150         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
151         RNA_def_property_struct_type(prop, "IDPropertyGroup");
152
153         prop= RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
154         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
155         RNA_def_property_struct_type(prop, "IDPropertyGroup");
156
157         /* IDP_ID -- not implemented yet in id properties */
158
159         /* ID property groups > level 0, since level 0 group is merged
160          * with native RNA properties. the builtin_properties will take
161          * care of the properties here */
162         srna= RNA_def_struct(brna, "IDPropertyGroup", NULL);
163         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties.");
164 }
165
166 static void rna_def_ID(BlenderRNA *brna)
167 {
168         StructRNA *srna;
169         PropertyRNA *prop;
170         FunctionRNA *func;
171
172         srna= RNA_def_struct(brna, "ID", NULL);
173         RNA_def_struct_ui_text(srna, "ID", "Base type for datablocks, defining a unique name, linking from other libraries and garbage collection.");
174         RNA_def_struct_flag(srna, STRUCT_ID);
175         RNA_def_struct_refine_func(srna, "rna_ID_refine");
176
177         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
178         RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name.");
179         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
180         RNA_def_property_string_maxlength(prop, sizeof(((ID*)NULL)->name)-2);
181         RNA_def_struct_name_property(srna, prop);
182
183         prop= RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
184         RNA_def_property_int_sdna(prop, NULL, "us");
185         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
186         RNA_def_property_ui_text(prop, "Users", "Number of times this datablock is referenced.");
187
188         prop= RNA_def_property(srna, "fake_user", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
190         RNA_def_property_ui_text(prop, "Fake User", "Saves this datablock even if it has no users");
191         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
192
193         prop= RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
194         RNA_def_property_pointer_sdna(prop, NULL, "lib");
195         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
196         RNA_def_property_ui_text(prop, "Library", "Library file the datablock is linked from.");
197
198         /* XXX temporary for testing */
199         func= RNA_def_function(srna, "rename", "rename_id");
200         RNA_def_function_ui_description(func, "Rename this ID datablock.");
201         prop= RNA_def_string(func, "name", "", 0, "", "New name for the datablock.");
202         RNA_def_property_flag(prop, PROP_REQUIRED);
203 }
204
205 static void rna_def_library(BlenderRNA *brna)
206 {
207         StructRNA *srna;
208         PropertyRNA *prop;
209
210         srna= RNA_def_struct(brna, "Library", "ID");
211         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked.");
212
213         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
214         RNA_def_property_string_sdna(prop, NULL, "name");
215         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
216         RNA_def_property_ui_text(prop, "Filename", "Path to the library .blend file.");
217 }
218 void RNA_def_ID(BlenderRNA *brna)
219 {
220         StructRNA *srna;
221
222         /* built-in unknown type */
223         srna= RNA_def_struct(brna, "UnknownType", NULL);
224         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data.");
225
226         /* built-in any type */
227         srna= RNA_def_struct(brna, "AnyType", NULL);
228         RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data.");
229
230         rna_def_ID(brna);
231         rna_def_ID_properties(brna);
232         rna_def_library(brna);
233 }
234
235 #endif
236