RNA: sync API changes from 2.8
[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 "BKE_icons.h"
38 #include "BKE_object.h"
39
40 #include "RNA_access.h"
41 #include "RNA_define.h"
42 #include "RNA_enum_types.h"
43
44 #include "WM_types.h"
45
46 #include "rna_internal.h"
47
48 /* enum of ID-block types
49  * NOTE: need to keep this in line with the other defines for these
50  */
51 const EnumPropertyItem rna_enum_id_type_items[] = {
52         {ID_AC, "ACTION", ICON_ACTION, "Action", ""},
53         {ID_AR, "ARMATURE", ICON_ARMATURE_DATA, "Armature", ""},
54         {ID_BR, "BRUSH", ICON_BRUSH_DATA, "Brush", ""},
55         {ID_CA, "CAMERA", ICON_CAMERA_DATA, "Camera", ""},
56         {ID_CF, "CACHEFILE", ICON_FILE, "Cache File", ""},
57         {ID_CU, "CURVE", ICON_CURVE_DATA, "Curve", ""},
58         {ID_VF, "FONT", ICON_FONT_DATA, "Font", ""},
59         {ID_GD, "GREASEPENCIL", ICON_GREASEPENCIL, "Grease Pencil", ""},
60         {ID_GR, "GROUP", ICON_GROUP, "Group", ""},
61         {ID_IM, "IMAGE", ICON_IMAGE_DATA, "Image", ""},
62         {ID_KE, "KEY", ICON_SHAPEKEY_DATA, "Key", ""},
63         {ID_LA, "LAMP", ICON_LAMP_DATA, "Lamp", ""},
64         {ID_LI, "LIBRARY", ICON_LIBRARY_DATA_DIRECT, "Library", ""},
65         {ID_LS, "LINESTYLE", ICON_LINE_DATA, "Line Style", ""},
66         {ID_LT, "LATTICE", ICON_LATTICE_DATA, "Lattice", ""},
67         {ID_MSK, "MASK", ICON_MOD_MASK, "Mask", ""},
68         {ID_MA, "MATERIAL", ICON_MATERIAL_DATA, "Material", ""},
69         {ID_MB, "META", ICON_META_DATA, "Metaball", ""},
70         {ID_ME, "MESH", ICON_MESH_DATA, "Mesh", ""},
71         {ID_MC, "MOVIECLIP", ICON_CLIP, "Movie Clip", ""},
72         {ID_NT, "NODETREE", ICON_NODETREE, "Node Tree", ""},
73         {ID_OB, "OBJECT", ICON_OBJECT_DATA, "Object", ""},
74         {ID_PC, "PAINTCURVE", ICON_CURVE_BEZCURVE, "Paint Curve", ""},
75         {ID_PAL, "PALETTE", ICON_COLOR, "Palette", ""},
76         {ID_PA, "PARTICLE", ICON_PARTICLE_DATA, "Particle", ""},
77         {ID_SCE, "SCENE", ICON_SCENE_DATA, "Scene", ""},
78         {ID_SCR, "SCREEN", ICON_SPLITSCREEN, "Screen", ""},
79         {ID_SO, "SOUND", ICON_PLAY_AUDIO, "Sound", ""},
80         {ID_SPK, "SPEAKER", ICON_SPEAKER, "Speaker", ""},
81         {ID_TXT, "TEXT", ICON_TEXT, "Text", ""},
82         {ID_TE, "TEXTURE", ICON_TEXTURE_DATA, "Texture", ""},
83         {ID_WM, "WINDOWMANAGER", ICON_FULLSCREEN, "Window Manager", ""},
84         {ID_WO, "WORLD", ICON_WORLD_DATA, "World", ""},
85         {0, NULL, 0, NULL, NULL}
86 };
87
88 #ifdef RNA_RUNTIME
89
90 #include "DNA_anim_types.h"
91
92 #include "BLI_listbase.h"
93
94 #include "BKE_font.h"
95 #include "BKE_idprop.h"
96 #include "BKE_library.h"
97 #include "BKE_library_query.h"
98 #include "BKE_library_remap.h"
99 #include "BKE_animsys.h"
100 #include "BKE_material.h"
101 #include "BKE_depsgraph.h"
102 #include "BKE_global.h"  /* XXX, remove me */
103
104 #include "WM_api.h"
105
106 /* name functions that ignore the first two ID characters */
107 void rna_ID_name_get(PointerRNA *ptr, char *value)
108 {
109         ID *id = (ID *)ptr->data;
110         BLI_strncpy(value, id->name + 2, sizeof(id->name) - 2);
111 }
112
113 int rna_ID_name_length(PointerRNA *ptr)
114 {
115         ID *id = (ID *)ptr->data;
116         return strlen(id->name + 2);
117 }
118
119 void rna_ID_name_set(PointerRNA *ptr, const char *value)
120 {
121         ID *id = (ID *)ptr->data;
122         BLI_strncpy_utf8(id->name + 2, value, sizeof(id->name) - 2);
123         BLI_libblock_ensure_unique_name(G.main, id->name);
124 }
125
126 static int rna_ID_name_editable(PointerRNA *ptr, const char **UNUSED(r_info))
127 {
128         ID *id = (ID *)ptr->data;
129         
130         if (GS(id->name) == ID_VF) {
131                 VFont *vfont = (VFont *)id;
132                 if (BKE_vfont_is_builtin(vfont))
133                         return false;
134         }
135         
136         return PROP_EDITABLE;
137 }
138
139 short RNA_type_to_ID_code(const StructRNA *type)
140 {
141         const StructRNA *base_type = RNA_struct_base_child_of(type, &RNA_ID);
142         if (UNLIKELY(base_type == NULL)) {
143                 return 0;
144         }
145         if (base_type == &RNA_Action) return ID_AC;
146         if (base_type == &RNA_Armature) return ID_AR;
147         if (base_type == &RNA_Brush) return ID_BR;
148         if (base_type == &RNA_CacheFile) return ID_CF;
149         if (base_type == &RNA_Camera) return ID_CA;
150         if (base_type == &RNA_Curve) return ID_CU;
151         if (base_type == &RNA_GreasePencil) return ID_GD;
152         if (base_type == &RNA_Group) return ID_GR;
153         if (base_type == &RNA_Image) return ID_IM;
154         if (base_type == &RNA_Key) return ID_KE;
155         if (base_type == &RNA_Lamp) return ID_LA;
156         if (base_type == &RNA_Library) return ID_LI;
157         if (base_type == &RNA_FreestyleLineStyle) return ID_LS;
158         if (base_type == &RNA_Lattice) return ID_LT;
159         if (base_type == &RNA_Material) return ID_MA;
160         if (base_type == &RNA_MetaBall) return ID_MB;
161         if (base_type == &RNA_MovieClip) return ID_MC;
162         if (base_type == &RNA_Mesh) return ID_ME;
163         if (base_type == &RNA_Mask) return ID_MSK;
164         if (base_type == &RNA_NodeTree) return ID_NT;
165         if (base_type == &RNA_Object) return ID_OB;
166         if (base_type == &RNA_ParticleSettings) return ID_PA;
167         if (base_type == &RNA_Palette) return ID_PAL;
168         if (base_type == &RNA_PaintCurve) return ID_PC;
169         if (base_type == &RNA_Scene) return ID_SCE;
170         if (base_type == &RNA_Screen) return ID_SCR;
171         if (base_type == &RNA_Sound) return ID_SO;
172         if (base_type == &RNA_Speaker) return ID_SPK;
173         if (base_type == &RNA_Texture) return ID_TE;
174         if (base_type == &RNA_Text) return ID_TXT;
175         if (base_type == &RNA_VectorFont) return ID_VF;
176         if (base_type == &RNA_World) return ID_WO;
177         if (base_type == &RNA_WindowManager) return ID_WM;
178
179         return 0;
180 }
181
182 StructRNA *ID_code_to_RNA_type(short idcode)
183 {
184         /* Note, this switch doesn't use a 'default',
185          * so adding new ID's causes a warning. */
186         switch ((ID_Type)idcode) {
187                 case ID_AC: return &RNA_Action;
188                 case ID_AR: return &RNA_Armature;
189                 case ID_BR: return &RNA_Brush;
190                 case ID_CA: return &RNA_Camera;
191                 case ID_CF: return &RNA_CacheFile;
192                 case ID_CU: return &RNA_Curve;
193                 case ID_GD: return &RNA_GreasePencil;
194                 case ID_GR: return &RNA_Group;
195                 case ID_IM: return &RNA_Image;
196                 case ID_KE: return &RNA_Key;
197                 case ID_LA: return &RNA_Lamp;
198                 case ID_LI: return &RNA_Library;
199                 case ID_LS: return &RNA_FreestyleLineStyle;
200                 case ID_LT: return &RNA_Lattice;
201                 case ID_MA: return &RNA_Material;
202                 case ID_MB: return &RNA_MetaBall;
203                 case ID_MC: return &RNA_MovieClip;
204                 case ID_ME: return &RNA_Mesh;
205                 case ID_MSK: return &RNA_Mask;
206                 case ID_NT: return &RNA_NodeTree;
207                 case ID_OB: return &RNA_Object;
208                 case ID_PA: return &RNA_ParticleSettings;
209                 case ID_PAL: return &RNA_Palette;
210                 case ID_PC: return &RNA_PaintCurve;
211                 case ID_SCE: return &RNA_Scene;
212                 case ID_SCR: return &RNA_Screen;
213                 case ID_SO: return &RNA_Sound;
214                 case ID_SPK: return &RNA_Speaker;
215                 case ID_TE: return &RNA_Texture;
216                 case ID_TXT: return &RNA_Text;
217                 case ID_VF: return &RNA_VectorFont;
218                 case ID_WM: return &RNA_WindowManager;
219                 case ID_WO: return &RNA_World;
220
221                 /* deprecated */
222                 case ID_IP: break;
223         }
224
225         return &RNA_ID;
226 }
227
228 StructRNA *rna_ID_refine(PointerRNA *ptr)
229 {
230         ID *id = (ID *)ptr->data;
231
232         return ID_code_to_RNA_type(GS(id->name));
233 }
234
235 IDProperty *rna_ID_idprops(PointerRNA *ptr, bool create)
236 {
237         return IDP_GetProperties(ptr->data, create);
238 }
239
240 void rna_ID_fake_user_set(PointerRNA *ptr, int value)
241 {
242         ID *id = (ID *)ptr->data;
243
244         if (value) {
245                 id_fake_user_set(id);
246         }
247         else {
248                 id_fake_user_clear(id);
249         }
250 }
251
252 IDProperty *rna_PropertyGroup_idprops(PointerRNA *ptr, bool UNUSED(create))
253 {
254         return ptr->data;
255 }
256
257 void rna_PropertyGroup_unregister(Main *UNUSED(bmain), StructRNA *type)
258 {
259         RNA_struct_free(&BLENDER_RNA, type);
260 }
261
262 StructRNA *rna_PropertyGroup_register(
263         Main *UNUSED(bmain), ReportList *reports, void *data, const char *identifier,
264         StructValidateFunc validate, StructCallbackFunc UNUSED(call),
265         StructFreeFunc UNUSED(free))
266 {
267         PointerRNA dummyptr;
268
269         /* create dummy pointer */
270         RNA_pointer_create(NULL, &RNA_PropertyGroup, NULL, &dummyptr);
271
272         /* validate the python class */
273         if (validate(&dummyptr, data, NULL) != 0)
274                 return NULL;
275
276         /* note: it looks like there is no length limit on the srna id since its
277          * just a char pointer, but take care here, also be careful that python
278          * owns the string pointer which it could potentially free while blender
279          * is running. */
280         if (BLI_strnlen(identifier, MAX_IDPROP_NAME) == MAX_IDPROP_NAME) {
281                 BKE_reportf(reports, RPT_ERROR, "Registering id property class: '%s' is too long, maximum length is %d",
282                             identifier, MAX_IDPROP_NAME);
283                 return NULL;
284         }
285
286         return RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup);  /* XXX */
287 }
288
289 StructRNA *rna_PropertyGroup_refine(PointerRNA *ptr)
290 {
291         return ptr->type;
292 }
293
294 static ID *rna_ID_copy(ID *id, Main *bmain)
295 {
296         ID *newid;
297
298         if (id_copy(bmain, id, &newid, false)) {
299                 if (newid) id_us_min(newid);
300                 return newid;
301         }
302         
303         return NULL;
304 }
305
306 static void rna_ID_update_tag(ID *id, ReportList *reports, int flag)
307 {
308         /* XXX, new function for this! */
309 #if 0
310         if (ob->type == OB_FONT) {
311                 Curve *cu = ob->data;
312                 freedisplist(&cu->disp);
313                 BKE_vfont_to_curve(bmain, sce, ob, FO_EDIT, NULL);
314         }
315 #endif
316
317         if (flag == 0) {
318                 /* pass */
319         }
320         else {
321                 /* ensure flag us correct for the type */
322                 switch (GS(id->name)) {
323                         case ID_OB:
324                                 if (flag & ~(OB_RECALC_ALL)) {
325                                         BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with Object ID type");
326                                         return;
327                                 }
328                                 break;
329                                 /* Could add particle updates later */
330 #if 0
331                         case ID_PA:
332                                 if (flag & ~(OB_RECALC_ALL | PSYS_RECALC)) {
333                                         BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with ParticleSettings ID type");
334                                         return;
335                                 }
336                                 break;
337 #endif
338                         default:
339                                 BKE_report(reports, RPT_ERROR, "This ID type is not compatible with any 'refresh' options");
340                                 return;
341                 }
342         }
343
344         DAG_id_tag_update(id, flag);
345 }
346
347 static void rna_ID_user_clear(ID *id)
348 {
349         id_fake_user_clear(id);
350         id->us = 0; /* don't save */
351 }
352
353 static void rna_ID_user_remap(ID *id, Main *bmain, ID *new_id)
354 {
355         if ((GS(id->name) == GS(new_id->name)) && (id != new_id)) {
356                 /* For now, do not allow remapping data in linked data from here... */
357                 BKE_libblock_remap(bmain, id, new_id, ID_REMAP_SKIP_INDIRECT_USAGE | ID_REMAP_SKIP_NEVER_NULL_USAGE);
358         }
359 }
360
361 static struct ID *rna_ID_make_local(struct ID *self, Main *bmain, int clear_proxy)
362 {
363         /* Special case, as we can't rely on id_make_local(); it clears proxies. */
364         if (!clear_proxy && GS(self->name) == ID_OB) {
365                 BKE_object_make_local_ex(bmain, (Object *)self, false, clear_proxy);
366         }
367         else {
368                 id_make_local(bmain, self, false, false);
369         }
370
371         ID *ret_id = self->newid ? self->newid : self;
372         BKE_id_clear_newpoin(self);
373         return ret_id;
374 }
375
376
377 static AnimData * rna_ID_animation_data_create(ID *id, Main *bmain)
378 {
379         AnimData *adt = BKE_animdata_add_id(id);
380         DAG_relations_tag_update(bmain);
381         return adt;
382 }
383
384 static void rna_ID_animation_data_free(ID *id, Main *bmain)
385 {
386         BKE_animdata_free(id, true);
387         DAG_relations_tag_update(bmain);
388 }
389
390 static void rna_IDPArray_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
391 {
392         IDProperty *prop = (IDProperty *)ptr->data;
393         rna_iterator_array_begin(iter, IDP_IDPArray(prop), sizeof(IDProperty), prop->len, 0, NULL);
394 }
395
396 static int rna_IDPArray_length(PointerRNA *ptr)
397 {
398         IDProperty *prop = (IDProperty *)ptr->data;
399         return prop->len;
400 }
401
402 int rna_IDMaterials_assign_int(PointerRNA *ptr, int key, const PointerRNA *assign_ptr)
403 {
404         ID *id =           ptr->id.data;
405         short *totcol = give_totcolp_id(id);
406         Material *mat_id = assign_ptr->id.data;
407         if (totcol && (key >= 0 && key < *totcol)) {
408                 assign_material_id(id, mat_id, key + 1);
409                 return 1;
410         }
411         else {
412                 return 0;
413         }
414 }
415
416 static void rna_IDMaterials_append_id(ID *id, Main *bmain, Material *ma)
417 {
418         BKE_material_append_id(bmain, id, ma);
419
420         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
421         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
422 }
423
424 static Material *rna_IDMaterials_pop_id(ID *id, Main *bmain, ReportList *reports, int index_i, int remove_material_slot)
425 {
426         Material *ma;
427         short *totcol = give_totcolp_id(id);
428         const short totcol_orig = *totcol;
429         if (index_i < 0) {
430                 index_i += (*totcol);
431         }
432
433         if ((index_i < 0) || (index_i >= (*totcol))) {
434                 BKE_report(reports, RPT_ERROR, "Index out of range");
435                 return NULL;
436         }
437
438         ma = BKE_material_pop_id(bmain, id, index_i, remove_material_slot);
439
440         if (*totcol == totcol_orig) {
441                 BKE_report(reports, RPT_ERROR, "No material to removed");
442                 return NULL;
443         }
444
445         DAG_id_tag_update(id, OB_RECALC_DATA);
446         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
447         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
448
449         return ma;
450 }
451
452 static void rna_IDMaterials_clear_id(ID *id, int remove_material_slot)
453 {
454         BKE_material_clear_id(G.main, id, remove_material_slot);
455
456         DAG_id_tag_update(id, OB_RECALC_DATA);
457         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
458         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
459 }
460
461 static void rna_Library_filepath_set(PointerRNA *ptr, const char *value)
462 {
463         Library *lib = (Library *)ptr->data;
464         BKE_library_filepath_set(lib, value);
465 }
466
467 /* ***** ImagePreview ***** */
468
469 static void rna_ImagePreview_is_custom_set(PointerRNA *ptr, int value, enum eIconSizes size)
470 {
471         ID *id = ptr->id.data;
472         PreviewImage *prv_img = (PreviewImage *)ptr->data;
473
474         if (id != NULL) {
475                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
476         }
477
478         if ((value && (prv_img->flag[size] & PRV_USER_EDITED)) || (!value && !(prv_img->flag[size] & PRV_USER_EDITED))) {
479                 return;
480         }
481
482         if (value)
483                 prv_img->flag[size] |= PRV_USER_EDITED;
484         else
485                 prv_img->flag[size] &= ~PRV_USER_EDITED;
486
487         prv_img->flag[size] |= PRV_CHANGED;
488
489         BKE_previewimg_clear_single(prv_img, size);
490 }
491
492 static void rna_ImagePreview_size_get(PointerRNA *ptr, int *values, enum eIconSizes size)
493 {
494         ID *id = (ID *)ptr->id.data;
495         PreviewImage *prv_img = (PreviewImage *)ptr->data;
496
497         if (id != NULL) {
498                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
499         }
500
501         BKE_previewimg_ensure(prv_img, size);
502
503         values[0] = prv_img->w[size];
504         values[1] = prv_img->h[size];
505 }
506
507 static void rna_ImagePreview_size_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
508 {
509         ID *id = (ID *)ptr->id.data;
510         PreviewImage *prv_img = (PreviewImage *)ptr->data;
511
512         if (id != NULL) {
513                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
514         }
515
516         BKE_previewimg_clear_single(prv_img, size);
517
518         if (values[0] && values[1]) {
519                 prv_img->rect[size] = MEM_callocN(values[0] * values[1] * sizeof(unsigned int), "prv_rect");
520
521                 prv_img->w[size] = values[0];
522                 prv_img->h[size] = values[1];
523         }
524
525         prv_img->flag[size] |= (PRV_CHANGED | PRV_USER_EDITED);
526 }
527
528
529 static int rna_ImagePreview_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
530 {
531         ID *id = ptr->id.data;
532         PreviewImage *prv_img = (PreviewImage *)ptr->data;
533
534         if (id != NULL) {
535                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
536         }
537
538         BKE_previewimg_ensure(prv_img, size);
539
540         length[0] = prv_img->w[size] * prv_img->h[size];
541
542         return length[0];
543 }
544
545 static void rna_ImagePreview_pixels_get(PointerRNA *ptr, int *values, enum eIconSizes size)
546 {
547         ID *id = ptr->id.data;
548         PreviewImage *prv_img = (PreviewImage *)ptr->data;
549
550         if (id != NULL) {
551                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
552         }
553
554         BKE_previewimg_ensure(prv_img, size);
555
556         memcpy(values, prv_img->rect[size], prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
557 }
558
559 static void rna_ImagePreview_pixels_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
560 {
561         ID *id = ptr->id.data;
562         PreviewImage *prv_img = (PreviewImage *)ptr->data;
563
564         if (id != NULL) {
565                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
566         }
567
568         memcpy(prv_img->rect[size], values, prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
569         prv_img->flag[size] |= PRV_USER_EDITED;
570 }
571
572
573 static int rna_ImagePreview_pixels_float_get_length(
574         PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
575 {
576         ID *id = ptr->id.data;
577         PreviewImage *prv_img = (PreviewImage *)ptr->data;
578
579         BLI_assert(sizeof(unsigned int) == 4);
580
581         if (id != NULL) {
582                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
583         }
584
585         BKE_previewimg_ensure(prv_img, size);
586
587         length[0] = prv_img->w[size] * prv_img->h[size] * 4;
588
589         return length[0];
590 }
591
592 static void rna_ImagePreview_pixels_float_get(PointerRNA *ptr, float *values, enum eIconSizes size)
593 {
594         ID *id = ptr->id.data;
595         PreviewImage *prv_img = (PreviewImage *)ptr->data;
596
597         unsigned char *data = (unsigned char *)prv_img->rect[size];
598         const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
599         size_t i;
600
601         BLI_assert(sizeof(unsigned int) == 4);
602
603         if (id != NULL) {
604                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
605         }
606
607         BKE_previewimg_ensure(prv_img, size);
608
609         for (i = 0; i < len; i++) {
610                 values[i] = data[i] * (1.0f / 255.0f);
611         }
612 }
613
614 static void rna_ImagePreview_pixels_float_set(PointerRNA *ptr, const float *values, enum eIconSizes size)
615 {
616         ID *id = ptr->id.data;
617         PreviewImage *prv_img = (PreviewImage *)ptr->data;
618
619         unsigned char *data = (unsigned char *)prv_img->rect[size];
620         const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
621         size_t i;
622
623         BLI_assert(sizeof(unsigned int) == 4);
624
625         if (id != NULL) {
626                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
627         }
628
629         for (i = 0; i < len; i++) {
630                 data[i] = FTOCHAR(values[i]);
631         }
632         prv_img->flag[size] |= PRV_USER_EDITED;
633 }
634
635
636 static void rna_ImagePreview_is_image_custom_set(PointerRNA *ptr, int value)
637 {
638         rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_PREVIEW);
639 }
640
641 static void rna_ImagePreview_image_size_get(PointerRNA *ptr, int *values)
642 {
643         rna_ImagePreview_size_get(ptr, values, ICON_SIZE_PREVIEW);
644 }
645
646 static void rna_ImagePreview_image_size_set(PointerRNA *ptr, const int *values)
647 {
648         rna_ImagePreview_size_set(ptr, values, ICON_SIZE_PREVIEW);
649 }
650
651 static int rna_ImagePreview_image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
652 {
653         return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_PREVIEW);
654 }
655
656 static void rna_ImagePreview_image_pixels_get(PointerRNA *ptr, int *values)
657 {
658         rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_PREVIEW);
659 }
660
661 static void rna_ImagePreview_image_pixels_set(PointerRNA *ptr, const int *values)
662 {
663         rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_PREVIEW);
664 }
665
666 static int rna_ImagePreview_image_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
667 {
668         return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_PREVIEW);
669 }
670
671 static void rna_ImagePreview_image_pixels_float_get(PointerRNA *ptr, float *values)
672 {
673         rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_PREVIEW);
674 }
675
676 static void rna_ImagePreview_image_pixels_float_set(PointerRNA *ptr, const float *values)
677 {
678         rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_PREVIEW);
679 }
680
681
682 static void rna_ImagePreview_is_icon_custom_set(PointerRNA *ptr, int value)
683 {
684         rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_ICON);
685 }
686
687 static void rna_ImagePreview_icon_size_get(PointerRNA *ptr, int *values)
688 {
689         rna_ImagePreview_size_get(ptr, values, ICON_SIZE_ICON);
690 }
691
692 static void rna_ImagePreview_icon_size_set(PointerRNA *ptr, const int *values)
693 {
694         rna_ImagePreview_size_set(ptr, values, ICON_SIZE_ICON);
695 }
696
697 static int rna_ImagePreview_icon_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
698 {
699         return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_ICON);
700 }
701
702 static void rna_ImagePreview_icon_pixels_get(PointerRNA *ptr, int *values)
703 {
704         rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_ICON);
705 }
706
707 static void rna_ImagePreview_icon_pixels_set(PointerRNA *ptr, const int *values)
708 {
709         rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_ICON);
710 }
711
712 static int rna_ImagePreview_icon_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
713 {
714         return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_ICON);
715 }
716
717 static void rna_ImagePreview_icon_pixels_float_get(PointerRNA *ptr, float *values)
718 {
719         rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_ICON);
720 }
721
722 static void rna_ImagePreview_icon_pixels_float_set(PointerRNA *ptr, const float *values)
723 {
724         rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_ICON);
725 }
726
727
728 static int rna_ImagePreview_icon_id_get(PointerRNA *ptr)
729 {
730         /* Using a callback here allows us to only generate icon matching that preview when icon_id is requested. */
731         return BKE_icon_preview_ensure(ptr->id.data, (PreviewImage *)(ptr->data));
732 }
733 static void rna_ImagePreview_icon_reload(PreviewImage *prv)
734 {
735         /* will lazy load on next use, but only in case icon is not user-modified! */
736         if (!(prv->flag[ICON_SIZE_ICON] & PRV_USER_EDITED) && !(prv->flag[ICON_SIZE_PREVIEW] & PRV_USER_EDITED)) {
737                 BKE_previewimg_clear(prv);
738         }
739 }
740
741 static PointerRNA rna_IDPreview_get(PointerRNA *ptr)
742 {
743         ID *id = (ID *)ptr->data;
744         PreviewImage *prv_img = BKE_previewimg_id_ensure(id);
745
746         return rna_pointer_inherit_refine(ptr, &RNA_ImagePreview, prv_img);
747 }
748
749 #else
750
751 static void rna_def_ID_properties(BlenderRNA *brna)
752 {
753         StructRNA *srna;
754         PropertyRNA *prop;
755
756         /* this is struct is used for holding the virtual
757          * PropertyRNA's for ID properties */
758         srna = RNA_def_struct(brna, "PropertyGroupItem", NULL);
759         RNA_def_struct_sdna(srna, "IDProperty");
760         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties");
761         
762         /* IDP_STRING */
763         prop = RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
764         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
765
766         /* IDP_INT */
767         prop = RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
768         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
769
770         prop = RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
771         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
772         RNA_def_property_array(prop, 1);
773
774         /* IDP_FLOAT */
775         prop = RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
776         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
777
778         prop = RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
779         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
780         RNA_def_property_array(prop, 1);
781
782         /* IDP_DOUBLE */
783         prop = RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
784         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
785
786         prop = RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
787         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
788         RNA_def_property_array(prop, 1);
789
790         /* IDP_GROUP */
791         prop = RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
792         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
793         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
794         RNA_def_property_struct_type(prop, "PropertyGroup");
795
796         prop = RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
797         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
798         RNA_def_property_struct_type(prop, "PropertyGroup");
799
800         prop = RNA_def_property(srna, "idp_array", PROP_COLLECTION, PROP_NONE);
801         RNA_def_property_struct_type(prop, "PropertyGroup");
802         RNA_def_property_collection_funcs(prop, "rna_IDPArray_begin", "rna_iterator_array_next", "rna_iterator_array_end",
803                                           "rna_iterator_array_get", "rna_IDPArray_length", NULL, NULL, NULL);
804         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
805
806         /* never tested, maybe its useful to have this? */
807 #if 0
808         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
809         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
810         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
811         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
812         RNA_def_struct_name_property(srna, prop);
813 #endif
814
815         /* IDP_ID */
816         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
817         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY | PROP_NEVER_UNLINK);
818         RNA_def_property_struct_type(prop, "ID");
819
820
821         /* ID property groups > level 0, since level 0 group is merged
822          * with native RNA properties. the builtin_properties will take
823          * care of the properties here */
824         srna = RNA_def_struct(brna, "PropertyGroup", NULL);
825         RNA_def_struct_sdna(srna, "IDPropertyGroup");
826         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties");
827         RNA_def_struct_idprops_func(srna, "rna_PropertyGroup_idprops");
828         RNA_def_struct_register_funcs(srna, "rna_PropertyGroup_register", "rna_PropertyGroup_unregister", NULL);
829         RNA_def_struct_refine_func(srna, "rna_PropertyGroup_refine");
830
831         /* important so python types can have their name used in list views
832          * however this isn't prefect because it overrides how python would set the name
833          * when we only really want this so RNA_def_struct_name_property() is set to something useful */
834         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
835         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
836         /*RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
837         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
838         RNA_def_struct_name_property(srna, prop);
839 }
840
841
842 static void rna_def_ID_materials(BlenderRNA *brna)
843 {
844         StructRNA *srna;
845         FunctionRNA *func;
846         PropertyRNA *parm;
847         
848         /* for mesh/mball/curve materials */
849         srna = RNA_def_struct(brna, "IDMaterials", NULL);
850         RNA_def_struct_sdna(srna, "ID");
851         RNA_def_struct_ui_text(srna, "ID Materials", "Collection of materials");
852
853         func = RNA_def_function(srna, "append", "rna_IDMaterials_append_id");
854         RNA_def_function_flag(func, FUNC_USE_MAIN);
855         RNA_def_function_ui_description(func, "Add a new material to the data-block");
856         parm = RNA_def_pointer(func, "material", "Material", "", "Material to add");
857         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
858
859         func = RNA_def_function(srna, "pop", "rna_IDMaterials_pop_id");
860         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_MAIN);
861         RNA_def_function_ui_description(func, "Remove a material from the data-block");
862         parm = RNA_def_int(func, "index", -1, -MAXMAT, MAXMAT, "", "Index of material to remove", 0, MAXMAT);
863         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
864         parm = RNA_def_pointer(func, "material", "Material", "", "Material to remove");
865         RNA_def_function_return(func, parm);
866
867         func = RNA_def_function(srna, "clear", "rna_IDMaterials_clear_id");
868         RNA_def_function_ui_description(func, "Remove all materials from the data-block");
869         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
870 }
871
872 static void rna_def_image_preview(BlenderRNA *brna)
873 {
874         StructRNA *srna;
875         FunctionRNA *func;
876         PropertyRNA *prop;
877
878         srna = RNA_def_struct(brna, "ImagePreview", NULL);
879         RNA_def_struct_sdna(srna, "PreviewImage");
880         RNA_def_struct_ui_text(srna, "Image Preview", "Preview image and icon");
881
882         prop = RNA_def_property(srna, "is_image_custom", PROP_BOOLEAN, PROP_NONE);
883         RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_PREVIEW]", PRV_USER_EDITED);
884         RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_image_custom_set");
885         RNA_def_property_ui_text(prop, "Custom Image", "True if this preview image has been modified by py script,"
886                                  "and is no more auto-generated by Blender");
887
888         prop = RNA_def_int_vector(srna, "image_size", 2, NULL, 0, 0, "Image Size",
889                                   "Width and height in pixels", 0, 0);
890         RNA_def_property_subtype(prop, PROP_PIXEL);
891         RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_size_get", "rna_ImagePreview_image_size_set", NULL);
892
893         prop = RNA_def_property(srna, "image_pixels", PROP_INT, PROP_NONE);
894         RNA_def_property_flag(prop, PROP_DYNAMIC);
895         RNA_def_property_multi_array(prop, 1, NULL);
896         RNA_def_property_ui_text(prop, "Image Pixels", "Image pixels, as bytes (always RGBA 32bits)");
897         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_get_length");
898         RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_pixels_get", "rna_ImagePreview_image_pixels_set", NULL);
899
900         prop = RNA_def_property(srna, "image_pixels_float", PROP_FLOAT, PROP_NONE);
901         RNA_def_property_flag(prop, PROP_DYNAMIC);
902         RNA_def_property_multi_array(prop, 1, NULL);
903         RNA_def_property_ui_text(prop, "Float Image Pixels",
904                                  "Image pixels components, as floats (RGBA concatenated values)");
905         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_float_get_length");
906         RNA_def_property_float_funcs(prop, "rna_ImagePreview_image_pixels_float_get",
907                                      "rna_ImagePreview_image_pixels_float_set", NULL);
908
909
910         prop = RNA_def_property(srna, "is_icon_custom", PROP_BOOLEAN, PROP_NONE);
911         RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_ICON]", PRV_USER_EDITED);
912         RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_icon_custom_set");
913         RNA_def_property_ui_text(prop, "Custom Icon", "True if this preview icon has been modified by py script,"
914                                  "and is no more auto-generated by Blender");
915
916         prop = RNA_def_int_vector(srna, "icon_size", 2, NULL, 0, 0, "Icon Size",
917                                   "Width and height in pixels", 0, 0);
918         RNA_def_property_subtype(prop, PROP_PIXEL);
919         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_size_get", "rna_ImagePreview_icon_size_set", NULL);
920
921         prop = RNA_def_property(srna, "icon_pixels", PROP_INT, PROP_NONE);
922         RNA_def_property_flag(prop, PROP_DYNAMIC);
923         RNA_def_property_multi_array(prop, 1, NULL);
924         RNA_def_property_ui_text(prop, "Icon Pixels", "Icon pixels, as bytes (always RGBA 32bits)");
925         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_get_length");
926         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_pixels_get", "rna_ImagePreview_icon_pixels_set", NULL);
927
928         prop = RNA_def_property(srna, "icon_pixels_float", PROP_FLOAT, PROP_NONE);
929         RNA_def_property_flag(prop, PROP_DYNAMIC);
930         RNA_def_property_multi_array(prop, 1, NULL);
931         RNA_def_property_ui_text(prop, "Float Icon Pixels", "Icon pixels components, as floats (RGBA concatenated values)");
932         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_float_get_length");
933         RNA_def_property_float_funcs(prop, "rna_ImagePreview_icon_pixels_float_get",
934                                      "rna_ImagePreview_icon_pixels_float_set", NULL);
935
936         prop = RNA_def_int(srna, "icon_id", 0, INT_MIN, INT_MAX, "Icon ID",
937                            "Unique integer identifying this preview as an icon (zero means invalid)", INT_MIN, INT_MAX);
938         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
939         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_id_get", NULL, NULL);
940
941         func = RNA_def_function(srna, "reload", "rna_ImagePreview_icon_reload");
942         RNA_def_function_ui_description(func, "Reload the preview from its source path");
943 }
944
945 static void rna_def_ID(BlenderRNA *brna)
946 {
947         StructRNA *srna;
948         FunctionRNA *func;
949         PropertyRNA *prop, *parm;
950
951         static const EnumPropertyItem update_flag_items[] = {
952                 {OB_RECALC_OB, "OBJECT", 0, "Object", ""},
953                 {OB_RECALC_DATA, "DATA", 0, "Data", ""},
954                 {OB_RECALC_TIME, "TIME", 0, "Time", ""},
955                 {0, NULL, 0, NULL, NULL}
956         };
957
958         srna = RNA_def_struct(brna, "ID", NULL);
959         RNA_def_struct_ui_text(srna, "ID",
960                                "Base type for data-blocks, defining a unique name, linking from other libraries "
961                                "and garbage collection");
962         RNA_def_struct_flag(srna, STRUCT_ID | STRUCT_ID_REFCOUNT);
963         RNA_def_struct_refine_func(srna, "rna_ID_refine");
964         RNA_def_struct_idprops_func(srna, "rna_ID_idprops");
965
966         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
967         RNA_def_property_ui_text(prop, "Name", "Unique data-block ID name");
968         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
969         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
970         RNA_def_property_editable_func(prop, "rna_ID_name_editable");
971         RNA_def_property_update(prop, NC_ID | NA_RENAME, NULL);
972         RNA_def_struct_name_property(srna, prop);
973
974         prop = RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
975         RNA_def_property_int_sdna(prop, NULL, "us");
976         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
977         RNA_def_property_ui_text(prop, "Users", "Number of times this data-block is referenced");
978
979         prop = RNA_def_property(srna, "use_fake_user", PROP_BOOLEAN, PROP_NONE);
980         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
981         RNA_def_property_ui_text(prop, "Fake User", "Save this data-block even if it has no users");
982         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
983
984         prop = RNA_def_property(srna, "tag", PROP_BOOLEAN, PROP_NONE);
985         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_DOIT);
986         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
987         RNA_def_property_ui_text(prop, "Tag",
988                                  "Tools can use this to tag data for their own purposes "
989                                  "(initial state is undefined)");
990
991         prop = RNA_def_property(srna, "is_updated", PROP_BOOLEAN, PROP_NONE);
992         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_ID_RECALC);
993         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
994         RNA_def_property_ui_text(prop, "Is Updated", "Data-block is tagged for recalculation");
995
996         prop = RNA_def_property(srna, "is_updated_data", PROP_BOOLEAN, PROP_NONE);
997         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_ID_RECALC_DATA);
998         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
999         RNA_def_property_ui_text(prop, "Is Updated Data", "Data-block data is tagged for recalculation");
1000
1001         prop = RNA_def_property(srna, "is_library_indirect", PROP_BOOLEAN, PROP_NONE);
1002         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_INDIRECT);
1003         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1004         RNA_def_property_ui_text(prop, "Is Indirect", "Is this ID block linked indirectly");
1005
1006         prop = RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
1007         RNA_def_property_pointer_sdna(prop, NULL, "lib");
1008         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1009         RNA_def_property_ui_text(prop, "Library", "Library file the data-block is linked from");
1010
1011         prop = RNA_def_pointer(srna, "preview", "ImagePreview", "Preview",
1012                                "Preview image and icon of this data-block (None if not supported for this type of data)");
1013         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1014         RNA_def_property_pointer_funcs(prop, "rna_IDPreview_get", NULL, NULL, NULL);
1015
1016         /* functions */
1017         func = RNA_def_function(srna, "copy", "rna_ID_copy");
1018         RNA_def_function_ui_description(func, "Create a copy of this data-block (not supported for all data-blocks)");
1019         RNA_def_function_flag(func, FUNC_USE_MAIN);
1020         parm = RNA_def_pointer(func, "id", "ID", "", "New copy of the ID");
1021         RNA_def_function_return(func, parm);
1022
1023         func = RNA_def_function(srna, "user_clear", "rna_ID_user_clear");
1024         RNA_def_function_ui_description(func, "Clear the user count of a data-block so its not saved, "
1025                                         "on reload the data will be removed");
1026
1027         func = RNA_def_function(srna, "user_remap", "rna_ID_user_remap");
1028         RNA_def_function_ui_description(func, "Replace all usage in the .blend file of this ID by new given one");
1029         RNA_def_function_flag(func, FUNC_USE_MAIN);
1030         parm = RNA_def_pointer(func, "new_id", "ID", "", "New ID to use");
1031         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1032
1033         func = RNA_def_function(srna, "make_local", "rna_ID_make_local");
1034         RNA_def_function_ui_description(func, "Make this datablock local, return local one "
1035                                               "(may be a copy of the original, in case it is also indirectly used)");
1036         RNA_def_function_flag(func, FUNC_USE_MAIN);
1037         parm = RNA_def_boolean(func, "clear_proxy", true, "",
1038                                "Whether to clear proxies (the default behavior, "
1039                                "note that if object has to be duplicated to be made local, proxies are always cleared)");
1040         parm = RNA_def_pointer(func, "id", "ID", "", "This ID, or the new ID if it was copied");
1041         RNA_def_function_return(func, parm);
1042
1043         func = RNA_def_function(srna, "user_of_id", "BKE_library_ID_use_ID");
1044         RNA_def_function_ui_description(func, "Count the number of times that ID uses/references given one");
1045         parm = RNA_def_pointer(func, "id", "ID", "", "ID to count usages");
1046         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1047         parm = RNA_def_int(func, "count", 0, 0, INT_MAX,
1048                            "", "Number of usages/references of given id by current data-block", 0, INT_MAX);
1049         RNA_def_function_return(func, parm);
1050
1051         func = RNA_def_function(srna, "animation_data_create", "rna_ID_animation_data_create");
1052         RNA_def_function_flag(func, FUNC_USE_MAIN);
1053         RNA_def_function_ui_description(func, "Create animation data to this ID, note that not all ID types support this");
1054         parm = RNA_def_pointer(func, "anim_data", "AnimData", "", "New animation data or NULL");
1055         RNA_def_function_return(func, parm);
1056
1057         func = RNA_def_function(srna, "animation_data_clear", "rna_ID_animation_data_free");
1058         RNA_def_function_flag(func, FUNC_USE_MAIN);
1059         RNA_def_function_ui_description(func, "Clear animation on this this ID");
1060
1061         func = RNA_def_function(srna, "update_tag", "rna_ID_update_tag");
1062         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1063         RNA_def_function_ui_description(func,
1064                                         "Tag the ID to update its display data, "
1065                                         "e.g. when calling :class:`bpy.types.Scene.update`");
1066         RNA_def_enum_flag(func, "refresh", update_flag_items, 0, "", "Type of updates to perform");
1067 }
1068
1069 static void rna_def_library(BlenderRNA *brna)
1070 {
1071         StructRNA *srna;
1072         FunctionRNA *func;
1073         PropertyRNA *prop;
1074
1075         srna = RNA_def_struct(brna, "Library", "ID");
1076         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked");
1077         RNA_def_struct_ui_icon(srna, ICON_LIBRARY_DATA_DIRECT);
1078
1079         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
1080         RNA_def_property_string_sdna(prop, NULL, "name");
1081         RNA_def_property_ui_text(prop, "File Path", "Path to the library .blend file");
1082         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Library_filepath_set");
1083         
1084         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
1085         RNA_def_property_struct_type(prop, "Library");
1086         RNA_def_property_ui_text(prop, "Parent", "");
1087
1088         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
1089         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
1090         RNA_def_property_ui_text(prop, "Packed File", "");
1091
1092         func = RNA_def_function(srna, "reload", "WM_lib_reload");
1093         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
1094         RNA_def_function_ui_description(func, "Reload this library and all its linked data-blocks");
1095 }
1096 void RNA_def_ID(BlenderRNA *brna)
1097 {
1098         StructRNA *srna;
1099
1100         /* built-in unknown type */
1101         srna = RNA_def_struct(brna, "UnknownType", NULL);
1102         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data");
1103
1104         /* built-in any type */
1105         srna = RNA_def_struct(brna, "AnyType", NULL);
1106         RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data");
1107
1108         rna_def_ID(brna);
1109         rna_def_image_preview(brna);
1110         rna_def_ID_properties(brna);
1111         rna_def_ID_materials(brna);
1112         rna_def_library(brna);
1113 }
1114
1115 #endif