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