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