Icon for LineStyle
[blender.git] / source / blender / makesrna / intern / rna_ID.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_ID.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29
30 #include "DNA_ID.h"
31 #include "DNA_vfont_types.h"
32 #include "DNA_material_types.h"
33 #include "DNA_object_types.h"
34
35 #include "BLI_utildefines.h"
36
37 #include "RNA_access.h"
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "WM_types.h"
42
43 #include "rna_internal.h"
44
45 /* enum of ID-block types
46  * NOTE: need to keep this in line with the other defines for these
47  */
48 EnumPropertyItem id_type_items[] = {
49         {ID_AC, "ACTION", ICON_ACTION, "Action", ""},
50         {ID_AR, "ARMATURE", ICON_ARMATURE_DATA, "Armature", ""},
51         {ID_BR, "BRUSH", ICON_BRUSH_DATA, "Brush", ""},
52         {ID_CA, "CAMERA", ICON_CAMERA_DATA, "Camera", ""},
53         {ID_CU, "CURVE", ICON_CURVE_DATA, "Curve", ""},
54         {ID_VF, "FONT", ICON_FONT_DATA, "Font", ""},
55         {ID_GD, "GREASEPENCIL", ICON_GREASEPENCIL, "Grease Pencil", ""},
56         {ID_GR, "GROUP", ICON_GROUP, "Group", ""},
57         {ID_IM, "IMAGE", ICON_IMAGE_DATA, "Image", ""},
58         {ID_KE, "KEY", ICON_SHAPEKEY_DATA, "Key", ""},
59         {ID_LA, "LAMP", ICON_LAMP_DATA, "Lamp", ""},
60         {ID_LI, "LIBRARY", ICON_LIBRARY_DATA_DIRECT, "Library", ""},
61         {ID_LS, "LINESTYLE", ICON_LINE_DATA, "Line Style", ""},
62         {ID_LT, "LATTICE", ICON_LATTICE_DATA, "Lattice", ""},
63         {ID_MA, "MATERIAL", ICON_MATERIAL_DATA, "Material", ""},
64         {ID_MB, "META", ICON_META_DATA, "MetaBall", ""},
65         {ID_ME, "MESH", ICON_MESH_DATA, "Mesh", ""},
66         {ID_NT, "NODETREE", ICON_NODETREE, "NodeTree", ""},
67         {ID_OB, "OBJECT", ICON_OBJECT_DATA, "Object", ""},
68         {ID_PA, "PARTICLE", ICON_PARTICLE_DATA, "Particle", ""},
69         {ID_SCE, "SCENE", ICON_SCENE_DATA, "Scene", ""},
70         {ID_SCR, "SCREEN", ICON_SPLITSCREEN, "Screen", ""},
71         {ID_SPK, "SPEAKER", ICON_SPEAKER, "Speaker", ""},
72         {ID_SO, "SOUND", ICON_PLAY_AUDIO, "Sound", ""},
73         {ID_TXT, "TEXT", ICON_TEXT, "Text", ""},
74         {ID_TE, "TEXTURE", ICON_TEXTURE_DATA, "Texture", ""},
75         {ID_WO, "WORLD", ICON_WORLD_DATA, "World", ""},
76         {ID_WM, "WINDOWMANAGER", ICON_FULLSCREEN, "Window Manager", ""},
77         {0, NULL, 0, NULL, NULL}
78 };
79
80 #ifdef RNA_RUNTIME
81
82 #include "BKE_font.h"
83 #include "BKE_idprop.h"
84 #include "BKE_library.h"
85 #include "BKE_animsys.h"
86 #include "BKE_material.h"
87 #include "BKE_depsgraph.h"
88
89 #include "WM_api.h"
90
91 /* name functions that ignore the first two ID characters */
92 void rna_ID_name_get(PointerRNA *ptr, char *value)
93 {
94         ID *id = (ID *)ptr->data;
95         BLI_strncpy(value, id->name + 2, sizeof(id->name) - 2);
96 }
97
98 int rna_ID_name_length(PointerRNA *ptr)
99 {
100         ID *id = (ID *)ptr->data;
101         return strlen(id->name + 2);
102 }
103
104 void rna_ID_name_set(PointerRNA *ptr, const char *value)
105 {
106         ID *id = (ID *)ptr->data;
107         BLI_strncpy_utf8(id->name + 2, value, sizeof(id->name) - 2);
108         test_idbutton(id->name);
109 }
110
111 static int rna_ID_name_editable(PointerRNA *ptr)
112 {
113         ID *id = (ID *)ptr->data;
114         
115         if (GS(id->name) == ID_VF) {
116                 VFont *vfont = (VFont *)id;
117                 if (BKE_vfont_is_builtin(vfont))
118                         return FALSE;
119         }
120         
121         return TRUE;
122 }
123
124 short RNA_type_to_ID_code(StructRNA *type)
125 {
126         if (RNA_struct_is_a(type, &RNA_Action)) return ID_AC;
127         if (RNA_struct_is_a(type, &RNA_Armature)) return ID_AR;
128         if (RNA_struct_is_a(type, &RNA_Brush)) return ID_BR;
129         if (RNA_struct_is_a(type, &RNA_Camera)) return ID_CA;
130         if (RNA_struct_is_a(type, &RNA_Curve)) return ID_CU;
131         if (RNA_struct_is_a(type, &RNA_GreasePencil)) return ID_GD;
132         if (RNA_struct_is_a(type, &RNA_Group)) return ID_GR;
133         if (RNA_struct_is_a(type, &RNA_Image)) return ID_IM;
134         if (RNA_struct_is_a(type, &RNA_Key)) return ID_KE;
135         if (RNA_struct_is_a(type, &RNA_Lamp)) return ID_LA;
136         if (RNA_struct_is_a(type, &RNA_Library)) return ID_LI;
137         if (RNA_struct_is_a(type, &RNA_FreestyleLineStyle)) return ID_LS;
138         if (RNA_struct_is_a(type, &RNA_Lattice)) return ID_LT;
139         if (RNA_struct_is_a(type, &RNA_Material)) return ID_MA;
140         if (RNA_struct_is_a(type, &RNA_MetaBall)) return ID_MB;
141         if (RNA_struct_is_a(type, &RNA_NodeTree)) return ID_NT;
142         if (RNA_struct_is_a(type, &RNA_Mesh)) return ID_ME;
143         if (RNA_struct_is_a(type, &RNA_Object)) return ID_OB;
144         if (RNA_struct_is_a(type, &RNA_ParticleSettings)) return ID_PA;
145         if (RNA_struct_is_a(type, &RNA_Scene)) return ID_SCE;
146         if (RNA_struct_is_a(type, &RNA_Screen)) return ID_SCR;
147         if (RNA_struct_is_a(type, &RNA_Speaker)) return ID_SPK;
148         if (RNA_struct_is_a(type, &RNA_Sound)) return ID_SO;
149         if (RNA_struct_is_a(type, &RNA_Text)) return ID_TXT;
150         if (RNA_struct_is_a(type, &RNA_Texture)) return ID_TE;
151         if (RNA_struct_is_a(type, &RNA_VectorFont)) return ID_VF;
152         if (RNA_struct_is_a(type, &RNA_World)) return ID_WO;
153         if (RNA_struct_is_a(type, &RNA_WindowManager)) return ID_WM;
154         if (RNA_struct_is_a(type, &RNA_MovieClip)) return ID_MC;
155         if (RNA_struct_is_a(type, &RNA_Mask)) return ID_MSK;
156
157         return 0;
158 }
159
160 StructRNA *ID_code_to_RNA_type(short idcode)
161 {
162         switch (idcode) {
163                 case ID_AC: return &RNA_Action;
164                 case ID_AR: return &RNA_Armature;
165                 case ID_BR: return &RNA_Brush;
166                 case ID_CA: return &RNA_Camera;
167                 case ID_CU: return &RNA_Curve;
168                 case ID_GD: return &RNA_GreasePencil;
169                 case ID_GR: return &RNA_Group;
170                 case ID_IM: return &RNA_Image;
171                 case ID_KE: return &RNA_Key;
172                 case ID_LA: return &RNA_Lamp;
173                 case ID_LI: return &RNA_Library;
174                 case ID_LS: return &RNA_FreestyleLineStyle;
175                 case ID_LT: return &RNA_Lattice;
176                 case ID_MA: return &RNA_Material;
177                 case ID_MB: return &RNA_MetaBall;
178                 case ID_NT: return &RNA_NodeTree;
179                 case ID_ME: return &RNA_Mesh;
180                 case ID_OB: return &RNA_Object;
181                 case ID_PA: return &RNA_ParticleSettings;
182                 case ID_SCE: return &RNA_Scene;
183                 case ID_SCR: return &RNA_Screen;
184                 case ID_SPK: return &RNA_Speaker;
185                 case ID_SO: return &RNA_Sound;
186                 case ID_TXT: return &RNA_Text;
187                 case ID_TE: return &RNA_Texture;
188                 case ID_VF: return &RNA_VectorFont;
189                 case ID_WO: return &RNA_World;
190                 case ID_WM: return &RNA_WindowManager;
191                 case ID_MC: return &RNA_MovieClip;
192                 case ID_MSK: return &RNA_Mask;
193                 default: return &RNA_ID;
194         }
195 }
196
197 StructRNA *rna_ID_refine(PointerRNA *ptr)
198 {
199         ID *id = (ID *)ptr->data;
200
201         return ID_code_to_RNA_type(GS(id->name));
202 }
203
204 IDProperty *rna_ID_idprops(PointerRNA *ptr, bool create)
205 {
206         return IDP_GetProperties(ptr->data, create);
207 }
208
209 void rna_ID_fake_user_set(PointerRNA *ptr, int value)
210 {
211         ID *id = (ID *)ptr->data;
212
213         if (value && !(id->flag & LIB_FAKEUSER)) {
214                 id->flag |= LIB_FAKEUSER;
215                 id_us_plus(id);
216         }
217         else if (!value && (id->flag & LIB_FAKEUSER)) {
218                 id->flag &= ~LIB_FAKEUSER;
219                 id_us_min(id);
220         }
221 }
222
223 IDProperty *rna_PropertyGroup_idprops(PointerRNA *ptr, bool UNUSED(create))
224 {
225         return ptr->data;
226 }
227
228 void rna_PropertyGroup_unregister(Main *UNUSED(bmain), StructRNA *type)
229 {
230         RNA_struct_free(&BLENDER_RNA, type);
231 }
232
233 StructRNA *rna_PropertyGroup_register(Main *UNUSED(bmain), ReportList *reports, void *data, const char *identifier,
234                                       StructValidateFunc validate, StructCallbackFunc UNUSED(call),
235                                       StructFreeFunc UNUSED(free))
236 {
237         PointerRNA dummyptr;
238
239         /* create dummy pointer */
240         RNA_pointer_create(NULL, &RNA_PropertyGroup, NULL, &dummyptr);
241
242         /* validate the python class */
243         if (validate(&dummyptr, data, NULL) != 0)
244                 return NULL;
245
246         /* note: it looks like there is no length limit on the srna id since its
247          * just a char pointer, but take care here, also be careful that python
248          * owns the string pointer which it could potentially free while blender
249          * is running. */
250         if (BLI_strnlen(identifier, MAX_IDPROP_NAME) == MAX_IDPROP_NAME) {
251                 BKE_reportf(reports, RPT_ERROR, "Registering id property class: '%s' is too long, maximum length is %d",
252                             identifier, MAX_IDPROP_NAME);
253                 return NULL;
254         }
255
256         return RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup);  /* XXX */
257 }
258
259 StructRNA *rna_PropertyGroup_refine(PointerRNA *ptr)
260 {
261         return ptr->type;
262 }
263
264 static ID *rna_ID_copy(ID *id)
265 {
266         ID *newid;
267
268         if (id_copy(id, &newid, false)) {
269                 if (newid) id_us_min(newid);
270                 return newid;
271         }
272         
273         return NULL;
274 }
275
276 static void rna_ID_update_tag(ID *id, ReportList *reports, int flag)
277 {
278         /* XXX, new function for this! */
279 #if 0
280         if (ob->type == OB_FONT) {
281                 Curve *cu = ob->data;
282                 freedisplist(&cu->disp);
283                 BKE_vfont_to_curve(bmain, sce, ob, FO_EDIT, NULL);
284         }
285 #endif
286
287         if (flag == 0) {
288                 /* pass */
289         }
290         else {
291                 /* ensure flag us correct for the type */
292                 switch (GS(id->name)) {
293                         case ID_OB:
294                                 if (flag & ~(OB_RECALC_ALL)) {
295                                         BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with Object ID type");
296                                         return;
297                                 }
298                                 break;
299                                 /* Could add particle updates later */
300 #if 0
301                         case ID_PA:
302                                 if (flag & ~(OB_RECALC_ALL | PSYS_RECALC)) {
303                                         BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with ParticleSettings ID type");
304                                         return;
305                                 }
306                                 break;
307 #endif
308                         default:
309                                 BKE_report(reports, RPT_ERROR, "This ID type is not compatible with any 'refresh' options");
310                                 return;
311                 }
312         }
313
314         DAG_id_tag_update(id, flag);
315 }
316
317 static void rna_ID_user_clear(ID *id)
318 {
319         id->us = 0; /* don't save */
320         id->flag &= ~LIB_FAKEUSER;
321 }
322
323 static void rna_IDPArray_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
324 {
325         IDProperty *prop = (IDProperty *)ptr->data;
326         rna_iterator_array_begin(iter, IDP_IDPArray(prop), sizeof(IDProperty), prop->len, 0, NULL);
327 }
328
329 static int rna_IDPArray_length(PointerRNA *ptr)
330 {
331         IDProperty *prop = (IDProperty *)ptr->data;
332         return prop->len;
333 }
334
335 int rna_IDMaterials_assign_int(PointerRNA *ptr, int key, const PointerRNA *assign_ptr)
336 {
337         ID *id =           ptr->id.data;
338         short *totcol = give_totcolp_id(id);
339         Material *mat_id = assign_ptr->id.data;
340         if (totcol && (key >= 0 && key < *totcol)) {
341                 assign_material_id(id, mat_id, key + 1);
342                 return 1;
343         }
344         else {
345                 return 0;
346         }
347 }
348
349 static void rna_IDMaterials_append_id(ID *id, Material *ma)
350 {
351         BKE_material_append_id(id, ma);
352
353         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
354         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
355 }
356
357 static Material *rna_IDMaterials_pop_id(ID *id, ReportList *reports, int index_i, int remove_material_slot)
358 {
359         Material *ma;
360         short *totcol = give_totcolp_id(id);
361         const short totcol_orig = *totcol;
362         if (index_i < 0) {
363                 index_i += (*totcol);
364         }
365
366         if ((index_i < 0) || (index_i >= (*totcol))) {
367                 BKE_report(reports, RPT_ERROR, "Index out of range");
368                 return NULL;
369         }
370
371         ma = BKE_material_pop_id(id, index_i, remove_material_slot);
372
373         if (*totcol == totcol_orig) {
374                 BKE_report(reports, RPT_ERROR, "No material to removed");
375                 return NULL;
376         }
377
378         DAG_id_tag_update(id, OB_RECALC_DATA);
379         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
380         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
381
382         return ma;
383 }
384
385 static void rna_IDMaterials_clear_id(ID *id, int remove_material_slot)
386 {
387         BKE_material_clear_id(id, remove_material_slot);
388
389         DAG_id_tag_update(id, OB_RECALC_DATA);
390         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
391         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
392 }
393
394 static void rna_Library_filepath_set(PointerRNA *ptr, const char *value)
395 {
396         Library *lib = (Library *)ptr->data;
397         BKE_library_filepath_set(lib, value);
398 }
399
400 #else
401
402 static void rna_def_ID_properties(BlenderRNA *brna)
403 {
404         StructRNA *srna;
405         PropertyRNA *prop;
406
407         /* this is struct is used for holding the virtual
408          * PropertyRNA's for ID properties */
409         srna = RNA_def_struct(brna, "PropertyGroupItem", NULL);
410         RNA_def_struct_sdna(srna, "IDProperty");
411         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties");
412         
413         /* IDP_STRING */
414         prop = RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
415         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
416
417         /* IDP_INT */
418         prop = RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
419         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
420
421         prop = RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
422         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
423         RNA_def_property_array(prop, 1);
424
425         /* IDP_FLOAT */
426         prop = RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
427         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
428
429         prop = RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
430         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
431         RNA_def_property_array(prop, 1);
432
433         /* IDP_DOUBLE */
434         prop = RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
435         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
436
437         prop = RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
438         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
439         RNA_def_property_array(prop, 1);
440
441         /* IDP_GROUP */
442         prop = RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
443         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
444         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
445         RNA_def_property_struct_type(prop, "PropertyGroup");
446
447         prop = RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
448         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
449         RNA_def_property_struct_type(prop, "PropertyGroup");
450
451         prop = RNA_def_property(srna, "idp_array", PROP_COLLECTION, PROP_NONE);
452         RNA_def_property_struct_type(prop, "PropertyGroup");
453         RNA_def_property_collection_funcs(prop, "rna_IDPArray_begin", "rna_iterator_array_next", "rna_iterator_array_end",
454                                           "rna_iterator_array_get", "rna_IDPArray_length", NULL, NULL, NULL);
455         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
456
457         /* never tested, maybe its useful to have this? */
458 #if 0
459         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
460         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
461         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
462         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
463         RNA_def_struct_name_property(srna, prop);
464 #endif
465
466         /* IDP_ID -- not implemented yet in id properties */
467
468         /* ID property groups > level 0, since level 0 group is merged
469          * with native RNA properties. the builtin_properties will take
470          * care of the properties here */
471         srna = RNA_def_struct(brna, "PropertyGroup", NULL);
472         RNA_def_struct_sdna(srna, "IDPropertyGroup");
473         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties");
474         RNA_def_struct_idprops_func(srna, "rna_PropertyGroup_idprops");
475         RNA_def_struct_register_funcs(srna, "rna_PropertyGroup_register", "rna_PropertyGroup_unregister", NULL);
476         RNA_def_struct_refine_func(srna, "rna_PropertyGroup_refine");
477
478         /* important so python types can have their name used in list views
479          * however this isn't prefect because it overrides how python would set the name
480          * when we only really want this so RNA_def_struct_name_property() is set to something useful */
481         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
482         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
483         /*RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
484         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
485         RNA_def_struct_name_property(srna, prop);
486 }
487
488
489 static void rna_def_ID_materials(BlenderRNA *brna)
490 {
491         StructRNA *srna;
492         FunctionRNA *func;
493         PropertyRNA *parm;
494         
495         /* for mesh/mball/curve materials */
496         srna = RNA_def_struct(brna, "IDMaterials", NULL);
497         RNA_def_struct_sdna(srna, "ID");
498         RNA_def_struct_ui_text(srna, "ID Materials", "Collection of materials");
499
500         func = RNA_def_function(srna, "append", "rna_IDMaterials_append_id");
501         RNA_def_function_ui_description(func, "Add a new material to the data block");
502         parm = RNA_def_pointer(func, "material", "Material", "", "Material to add");
503         RNA_def_property_flag(parm, PROP_REQUIRED);
504
505         func = RNA_def_function(srna, "pop", "rna_IDMaterials_pop_id");
506         RNA_def_function_flag(func, FUNC_USE_REPORTS);
507         RNA_def_function_ui_description(func, "Remove a material from the data block");
508         parm = RNA_def_int(func, "index", -1, -MAXMAT, MAXMAT, "", "Index of material to remove", 0, MAXMAT);
509         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
510         parm = RNA_def_pointer(func, "material", "Material", "", "Material to remove");
511         RNA_def_function_return(func, parm);
512
513         func = RNA_def_function(srna, "clear", "rna_IDMaterials_clear_id");
514         RNA_def_function_ui_description(func, "Remove all materials from the data block");
515         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
516 }
517
518 static void rna_def_ID(BlenderRNA *brna)
519 {
520         StructRNA *srna;
521         FunctionRNA *func;
522         PropertyRNA *prop, *parm;
523
524         static EnumPropertyItem update_flag_items[] = {
525                 {OB_RECALC_OB, "OBJECT", 0, "Object", ""},
526                 {OB_RECALC_DATA, "DATA", 0, "Data", ""},
527                 {OB_RECALC_TIME, "TIME", 0, "Time", ""},
528                 {0, NULL, 0, NULL, NULL}
529         };
530
531         srna = RNA_def_struct(brna, "ID", NULL);
532         RNA_def_struct_ui_text(srna, "ID",
533                                "Base type for datablocks, defining a unique name, linking from other libraries "
534                                "and garbage collection");
535         RNA_def_struct_flag(srna, STRUCT_ID | STRUCT_ID_REFCOUNT);
536         RNA_def_struct_refine_func(srna, "rna_ID_refine");
537         RNA_def_struct_idprops_func(srna, "rna_ID_idprops");
538
539         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
540         RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name");
541         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
542         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
543         RNA_def_property_editable_func(prop, "rna_ID_name_editable");
544         RNA_def_property_update(prop, NC_ID | NA_RENAME, NULL);
545         RNA_def_struct_name_property(srna, prop);
546
547         prop = RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
548         RNA_def_property_int_sdna(prop, NULL, "us");
549         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
550         RNA_def_property_ui_text(prop, "Users", "Number of times this datablock is referenced");
551
552         prop = RNA_def_property(srna, "use_fake_user", PROP_BOOLEAN, PROP_NONE);
553         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
554         RNA_def_property_ui_text(prop, "Fake User", "Save this datablock even if it has no users");
555         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
556
557         prop = RNA_def_property(srna, "tag", PROP_BOOLEAN, PROP_NONE);
558         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_DOIT);
559         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
560         RNA_def_property_ui_text(prop, "Tag", "Tools can use this to tag data (initial state is undefined)");
561
562         prop = RNA_def_property(srna, "is_updated", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_ID_RECALC);
564         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
565         RNA_def_property_ui_text(prop, "Is Updated", "Datablock is tagged for recalculation");
566
567         prop = RNA_def_property(srna, "is_updated_data", PROP_BOOLEAN, PROP_NONE);
568         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_ID_RECALC_DATA);
569         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
570         RNA_def_property_ui_text(prop, "Is Updated Data", "Datablock data is tagged for recalculation");
571
572         prop = RNA_def_property(srna, "is_library_indirect", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_INDIRECT);
574         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
575         RNA_def_property_ui_text(prop, "Is Indirect", "Is this ID block linked indirectly");
576
577         prop = RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
578         RNA_def_property_pointer_sdna(prop, NULL, "lib");
579         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
580         RNA_def_property_ui_text(prop, "Library", "Library file the datablock is linked from");
581
582         /* functions */
583         func = RNA_def_function(srna, "copy", "rna_ID_copy");
584         RNA_def_function_ui_description(func, "Create a copy of this datablock (not supported for all datablocks)");
585         parm = RNA_def_pointer(func, "id", "ID", "", "New copy of the ID");
586         RNA_def_function_return(func, parm);
587
588         func = RNA_def_function(srna, "user_clear", "rna_ID_user_clear");
589         RNA_def_function_ui_description(func, "Clear the user count of a datablock so its not saved, "
590                                         "on reload the data will be removed");
591
592         func = RNA_def_function(srna, "animation_data_create", "BKE_id_add_animdata");
593         RNA_def_function_ui_description(func, "Create animation data to this ID, note that not all ID types support this");
594         parm = RNA_def_pointer(func, "anim_data", "AnimData", "", "New animation data or NULL");
595         RNA_def_function_return(func, parm);
596
597         func = RNA_def_function(srna, "animation_data_clear", "BKE_free_animdata");
598         RNA_def_function_ui_description(func, "Clear animation on this this ID");
599
600         func = RNA_def_function(srna, "update_tag", "rna_ID_update_tag");
601         RNA_def_function_flag(func, FUNC_USE_REPORTS);
602         RNA_def_function_ui_description(func, "Tag the ID to update its display data");
603         RNA_def_enum_flag(func, "refresh", update_flag_items, 0, "", "Type of updates to perform");
604 }
605
606 static void rna_def_library(BlenderRNA *brna)
607 {
608         StructRNA *srna;
609         PropertyRNA *prop;
610
611         srna = RNA_def_struct(brna, "Library", "ID");
612         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked");
613         RNA_def_struct_ui_icon(srna, ICON_LIBRARY_DATA_DIRECT);
614
615         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
616         RNA_def_property_string_sdna(prop, NULL, "name");
617         RNA_def_property_ui_text(prop, "File Path", "Path to the library .blend file");
618         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Library_filepath_set");
619         
620         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
621         RNA_def_property_struct_type(prop, "Library");
622         RNA_def_property_ui_text(prop, "Parent", "");
623 }
624 void RNA_def_ID(BlenderRNA *brna)
625 {
626         StructRNA *srna;
627
628         /* built-in unknown type */
629         srna = RNA_def_struct(brna, "UnknownType", NULL);
630         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data");
631
632         /* built-in any type */
633         srna = RNA_def_struct(brna, "AnyType", NULL);
634         RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data");
635
636         rna_def_ID(brna);
637         rna_def_ID_properties(brna);
638         rna_def_ID_materials(brna);
639         rna_def_library(brna);
640 }
641
642 #endif