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