Fix build error on Windows 32 bit.
[blender-staging.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 #ifdef WITH_PYTHON
391 void **rna_ID_instance(PointerRNA *ptr)
392 {
393         ID *id = (ID *)ptr->data;
394         return &id->py_instance;
395 }
396 #endif
397
398 static void rna_IDPArray_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
399 {
400         IDProperty *prop = (IDProperty *)ptr->data;
401         rna_iterator_array_begin(iter, IDP_IDPArray(prop), sizeof(IDProperty), prop->len, 0, NULL);
402 }
403
404 static int rna_IDPArray_length(PointerRNA *ptr)
405 {
406         IDProperty *prop = (IDProperty *)ptr->data;
407         return prop->len;
408 }
409
410 int rna_IDMaterials_assign_int(PointerRNA *ptr, int key, const PointerRNA *assign_ptr)
411 {
412         ID *id =           ptr->id.data;
413         short *totcol = give_totcolp_id(id);
414         Material *mat_id = assign_ptr->id.data;
415         if (totcol && (key >= 0 && key < *totcol)) {
416                 assign_material_id(id, mat_id, key + 1);
417                 return 1;
418         }
419         else {
420                 return 0;
421         }
422 }
423
424 static void rna_IDMaterials_append_id(ID *id, Main *bmain, Material *ma)
425 {
426         BKE_material_append_id(bmain, id, ma);
427
428         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
429         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
430 }
431
432 static Material *rna_IDMaterials_pop_id(ID *id, Main *bmain, ReportList *reports, int index_i, int remove_material_slot)
433 {
434         Material *ma;
435         short *totcol = give_totcolp_id(id);
436         const short totcol_orig = *totcol;
437         if (index_i < 0) {
438                 index_i += (*totcol);
439         }
440
441         if ((index_i < 0) || (index_i >= (*totcol))) {
442                 BKE_report(reports, RPT_ERROR, "Index out of range");
443                 return NULL;
444         }
445
446         ma = BKE_material_pop_id(bmain, id, index_i, remove_material_slot);
447
448         if (*totcol == totcol_orig) {
449                 BKE_report(reports, RPT_ERROR, "No material to removed");
450                 return NULL;
451         }
452
453         DAG_id_tag_update(id, OB_RECALC_DATA);
454         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
455         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
456
457         return ma;
458 }
459
460 static void rna_IDMaterials_clear_id(ID *id, int remove_material_slot)
461 {
462         BKE_material_clear_id(G.main, id, remove_material_slot);
463
464         DAG_id_tag_update(id, OB_RECALC_DATA);
465         WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
466         WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
467 }
468
469 static void rna_Library_filepath_set(PointerRNA *ptr, const char *value)
470 {
471         Library *lib = (Library *)ptr->data;
472         BKE_library_filepath_set(lib, value);
473 }
474
475 /* ***** ImagePreview ***** */
476
477 static void rna_ImagePreview_is_custom_set(PointerRNA *ptr, int value, enum eIconSizes size)
478 {
479         ID *id = ptr->id.data;
480         PreviewImage *prv_img = (PreviewImage *)ptr->data;
481
482         if (id != NULL) {
483                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
484         }
485
486         if ((value && (prv_img->flag[size] & PRV_USER_EDITED)) || (!value && !(prv_img->flag[size] & PRV_USER_EDITED))) {
487                 return;
488         }
489
490         if (value)
491                 prv_img->flag[size] |= PRV_USER_EDITED;
492         else
493                 prv_img->flag[size] &= ~PRV_USER_EDITED;
494
495         prv_img->flag[size] |= PRV_CHANGED;
496
497         BKE_previewimg_clear_single(prv_img, size);
498 }
499
500 static void rna_ImagePreview_size_get(PointerRNA *ptr, int *values, enum eIconSizes size)
501 {
502         ID *id = (ID *)ptr->id.data;
503         PreviewImage *prv_img = (PreviewImage *)ptr->data;
504
505         if (id != NULL) {
506                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
507         }
508
509         BKE_previewimg_ensure(prv_img, size);
510
511         values[0] = prv_img->w[size];
512         values[1] = prv_img->h[size];
513 }
514
515 static void rna_ImagePreview_size_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
516 {
517         ID *id = (ID *)ptr->id.data;
518         PreviewImage *prv_img = (PreviewImage *)ptr->data;
519
520         if (id != NULL) {
521                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
522         }
523
524         BKE_previewimg_clear_single(prv_img, size);
525
526         if (values[0] && values[1]) {
527                 prv_img->rect[size] = MEM_callocN(values[0] * values[1] * sizeof(unsigned int), "prv_rect");
528
529                 prv_img->w[size] = values[0];
530                 prv_img->h[size] = values[1];
531         }
532
533         prv_img->flag[size] |= (PRV_CHANGED | PRV_USER_EDITED);
534 }
535
536
537 static int rna_ImagePreview_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
538 {
539         ID *id = ptr->id.data;
540         PreviewImage *prv_img = (PreviewImage *)ptr->data;
541
542         if (id != NULL) {
543                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
544         }
545
546         BKE_previewimg_ensure(prv_img, size);
547
548         length[0] = prv_img->w[size] * prv_img->h[size];
549
550         return length[0];
551 }
552
553 static void rna_ImagePreview_pixels_get(PointerRNA *ptr, int *values, enum eIconSizes size)
554 {
555         ID *id = ptr->id.data;
556         PreviewImage *prv_img = (PreviewImage *)ptr->data;
557
558         if (id != NULL) {
559                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
560         }
561
562         BKE_previewimg_ensure(prv_img, size);
563
564         memcpy(values, prv_img->rect[size], prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
565 }
566
567 static void rna_ImagePreview_pixels_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
568 {
569         ID *id = ptr->id.data;
570         PreviewImage *prv_img = (PreviewImage *)ptr->data;
571
572         if (id != NULL) {
573                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
574         }
575
576         memcpy(prv_img->rect[size], values, prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
577         prv_img->flag[size] |= PRV_USER_EDITED;
578 }
579
580
581 static int rna_ImagePreview_pixels_float_get_length(
582         PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
583 {
584         ID *id = ptr->id.data;
585         PreviewImage *prv_img = (PreviewImage *)ptr->data;
586
587         BLI_assert(sizeof(unsigned int) == 4);
588
589         if (id != NULL) {
590                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
591         }
592
593         BKE_previewimg_ensure(prv_img, size);
594
595         length[0] = prv_img->w[size] * prv_img->h[size] * 4;
596
597         return length[0];
598 }
599
600 static void rna_ImagePreview_pixels_float_get(PointerRNA *ptr, float *values, enum eIconSizes size)
601 {
602         ID *id = ptr->id.data;
603         PreviewImage *prv_img = (PreviewImage *)ptr->data;
604
605         unsigned char *data = (unsigned char *)prv_img->rect[size];
606         const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
607         size_t i;
608
609         BLI_assert(sizeof(unsigned int) == 4);
610
611         if (id != NULL) {
612                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
613         }
614
615         BKE_previewimg_ensure(prv_img, size);
616
617         for (i = 0; i < len; i++) {
618                 values[i] = data[i] * (1.0f / 255.0f);
619         }
620 }
621
622 static void rna_ImagePreview_pixels_float_set(PointerRNA *ptr, const float *values, enum eIconSizes size)
623 {
624         ID *id = ptr->id.data;
625         PreviewImage *prv_img = (PreviewImage *)ptr->data;
626
627         unsigned char *data = (unsigned char *)prv_img->rect[size];
628         const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
629         size_t i;
630
631         BLI_assert(sizeof(unsigned int) == 4);
632
633         if (id != NULL) {
634                 BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
635         }
636
637         for (i = 0; i < len; i++) {
638                 data[i] = FTOCHAR(values[i]);
639         }
640         prv_img->flag[size] |= PRV_USER_EDITED;
641 }
642
643
644 static void rna_ImagePreview_is_image_custom_set(PointerRNA *ptr, int value)
645 {
646         rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_PREVIEW);
647 }
648
649 static void rna_ImagePreview_image_size_get(PointerRNA *ptr, int *values)
650 {
651         rna_ImagePreview_size_get(ptr, values, ICON_SIZE_PREVIEW);
652 }
653
654 static void rna_ImagePreview_image_size_set(PointerRNA *ptr, const int *values)
655 {
656         rna_ImagePreview_size_set(ptr, values, ICON_SIZE_PREVIEW);
657 }
658
659 static int rna_ImagePreview_image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
660 {
661         return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_PREVIEW);
662 }
663
664 static void rna_ImagePreview_image_pixels_get(PointerRNA *ptr, int *values)
665 {
666         rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_PREVIEW);
667 }
668
669 static void rna_ImagePreview_image_pixels_set(PointerRNA *ptr, const int *values)
670 {
671         rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_PREVIEW);
672 }
673
674 static int rna_ImagePreview_image_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
675 {
676         return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_PREVIEW);
677 }
678
679 static void rna_ImagePreview_image_pixels_float_get(PointerRNA *ptr, float *values)
680 {
681         rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_PREVIEW);
682 }
683
684 static void rna_ImagePreview_image_pixels_float_set(PointerRNA *ptr, const float *values)
685 {
686         rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_PREVIEW);
687 }
688
689
690 static void rna_ImagePreview_is_icon_custom_set(PointerRNA *ptr, int value)
691 {
692         rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_ICON);
693 }
694
695 static void rna_ImagePreview_icon_size_get(PointerRNA *ptr, int *values)
696 {
697         rna_ImagePreview_size_get(ptr, values, ICON_SIZE_ICON);
698 }
699
700 static void rna_ImagePreview_icon_size_set(PointerRNA *ptr, const int *values)
701 {
702         rna_ImagePreview_size_set(ptr, values, ICON_SIZE_ICON);
703 }
704
705 static int rna_ImagePreview_icon_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
706 {
707         return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_ICON);
708 }
709
710 static void rna_ImagePreview_icon_pixels_get(PointerRNA *ptr, int *values)
711 {
712         rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_ICON);
713 }
714
715 static void rna_ImagePreview_icon_pixels_set(PointerRNA *ptr, const int *values)
716 {
717         rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_ICON);
718 }
719
720 static int rna_ImagePreview_icon_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
721 {
722         return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_ICON);
723 }
724
725 static void rna_ImagePreview_icon_pixels_float_get(PointerRNA *ptr, float *values)
726 {
727         rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_ICON);
728 }
729
730 static void rna_ImagePreview_icon_pixels_float_set(PointerRNA *ptr, const float *values)
731 {
732         rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_ICON);
733 }
734
735
736 static int rna_ImagePreview_icon_id_get(PointerRNA *ptr)
737 {
738         /* Using a callback here allows us to only generate icon matching that preview when icon_id is requested. */
739         return BKE_icon_preview_ensure(ptr->id.data, (PreviewImage *)(ptr->data));
740 }
741 static void rna_ImagePreview_icon_reload(PreviewImage *prv)
742 {
743         /* will lazy load on next use, but only in case icon is not user-modified! */
744         if (!(prv->flag[ICON_SIZE_ICON] & PRV_USER_EDITED) && !(prv->flag[ICON_SIZE_PREVIEW] & PRV_USER_EDITED)) {
745                 BKE_previewimg_clear(prv);
746         }
747 }
748
749 static PointerRNA rna_IDPreview_get(PointerRNA *ptr)
750 {
751         ID *id = (ID *)ptr->data;
752         PreviewImage *prv_img = BKE_previewimg_id_ensure(id);
753
754         return rna_pointer_inherit_refine(ptr, &RNA_ImagePreview, prv_img);
755 }
756
757 #else
758
759 static void rna_def_ID_properties(BlenderRNA *brna)
760 {
761         StructRNA *srna;
762         PropertyRNA *prop;
763
764         /* this is struct is used for holding the virtual
765          * PropertyRNA's for ID properties */
766         srna = RNA_def_struct(brna, "PropertyGroupItem", NULL);
767         RNA_def_struct_sdna(srna, "IDProperty");
768         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties");
769         
770         /* IDP_STRING */
771         prop = RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
772         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
773
774         /* IDP_INT */
775         prop = RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
776         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
777
778         prop = RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
779         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
780         RNA_def_property_array(prop, 1);
781
782         /* IDP_FLOAT */
783         prop = RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
784         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
785
786         prop = RNA_def_property(srna, "float_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_DOUBLE */
791         prop = RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
792         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
793
794         prop = RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
795         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
796         RNA_def_property_array(prop, 1);
797
798         /* IDP_GROUP */
799         prop = RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
800         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
801         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
802         RNA_def_property_struct_type(prop, "PropertyGroup");
803
804         prop = RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
805         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
806         RNA_def_property_struct_type(prop, "PropertyGroup");
807
808         prop = RNA_def_property(srna, "idp_array", PROP_COLLECTION, PROP_NONE);
809         RNA_def_property_struct_type(prop, "PropertyGroup");
810         RNA_def_property_collection_funcs(prop, "rna_IDPArray_begin", "rna_iterator_array_next", "rna_iterator_array_end",
811                                           "rna_iterator_array_get", "rna_IDPArray_length", NULL, NULL, NULL);
812         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
813
814         /* never tested, maybe its useful to have this? */
815 #if 0
816         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
817         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
818         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
819         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
820         RNA_def_struct_name_property(srna, prop);
821 #endif
822
823         /* IDP_ID */
824         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
825         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY | PROP_NEVER_UNLINK);
826         RNA_def_property_struct_type(prop, "ID");
827
828
829         /* ID property groups > level 0, since level 0 group is merged
830          * with native RNA properties. the builtin_properties will take
831          * care of the properties here */
832         srna = RNA_def_struct(brna, "PropertyGroup", NULL);
833         RNA_def_struct_sdna(srna, "IDPropertyGroup");
834         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties");
835         RNA_def_struct_idprops_func(srna, "rna_PropertyGroup_idprops");
836         RNA_def_struct_register_funcs(srna, "rna_PropertyGroup_register", "rna_PropertyGroup_unregister", NULL);
837         RNA_def_struct_refine_func(srna, "rna_PropertyGroup_refine");
838
839         /* important so python types can have their name used in list views
840          * however this isn't prefect because it overrides how python would set the name
841          * when we only really want this so RNA_def_struct_name_property() is set to something useful */
842         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
843         RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
844         /*RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
845         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
846         RNA_def_struct_name_property(srna, prop);
847 }
848
849
850 static void rna_def_ID_materials(BlenderRNA *brna)
851 {
852         StructRNA *srna;
853         FunctionRNA *func;
854         PropertyRNA *parm;
855         
856         /* for mesh/mball/curve materials */
857         srna = RNA_def_struct(brna, "IDMaterials", NULL);
858         RNA_def_struct_sdna(srna, "ID");
859         RNA_def_struct_ui_text(srna, "ID Materials", "Collection of materials");
860
861         func = RNA_def_function(srna, "append", "rna_IDMaterials_append_id");
862         RNA_def_function_flag(func, FUNC_USE_MAIN);
863         RNA_def_function_ui_description(func, "Add a new material to the data-block");
864         parm = RNA_def_pointer(func, "material", "Material", "", "Material to add");
865         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
866
867         func = RNA_def_function(srna, "pop", "rna_IDMaterials_pop_id");
868         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_MAIN);
869         RNA_def_function_ui_description(func, "Remove a material from the data-block");
870         parm = RNA_def_int(func, "index", -1, -MAXMAT, MAXMAT, "", "Index of material to remove", 0, MAXMAT);
871         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
872         parm = RNA_def_pointer(func, "material", "Material", "", "Material to remove");
873         RNA_def_function_return(func, parm);
874
875         func = RNA_def_function(srna, "clear", "rna_IDMaterials_clear_id");
876         RNA_def_function_ui_description(func, "Remove all materials from the data-block");
877         RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
878 }
879
880 static void rna_def_image_preview(BlenderRNA *brna)
881 {
882         StructRNA *srna;
883         FunctionRNA *func;
884         PropertyRNA *prop;
885
886         srna = RNA_def_struct(brna, "ImagePreview", NULL);
887         RNA_def_struct_sdna(srna, "PreviewImage");
888         RNA_def_struct_ui_text(srna, "Image Preview", "Preview image and icon");
889
890         prop = RNA_def_property(srna, "is_image_custom", PROP_BOOLEAN, PROP_NONE);
891         RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_PREVIEW]", PRV_USER_EDITED);
892         RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_image_custom_set");
893         RNA_def_property_ui_text(prop, "Custom Image", "True if this preview image has been modified by py script,"
894                                  "and is no more auto-generated by Blender");
895
896         prop = RNA_def_int_vector(srna, "image_size", 2, NULL, 0, 0, "Image Size",
897                                   "Width and height in pixels", 0, 0);
898         RNA_def_property_subtype(prop, PROP_PIXEL);
899         RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_size_get", "rna_ImagePreview_image_size_set", NULL);
900
901         prop = RNA_def_property(srna, "image_pixels", PROP_INT, PROP_NONE);
902         RNA_def_property_flag(prop, PROP_DYNAMIC);
903         RNA_def_property_multi_array(prop, 1, NULL);
904         RNA_def_property_ui_text(prop, "Image Pixels", "Image pixels, as bytes (always RGBA 32bits)");
905         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_get_length");
906         RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_pixels_get", "rna_ImagePreview_image_pixels_set", NULL);
907
908         prop = RNA_def_property(srna, "image_pixels_float", PROP_FLOAT, PROP_NONE);
909         RNA_def_property_flag(prop, PROP_DYNAMIC);
910         RNA_def_property_multi_array(prop, 1, NULL);
911         RNA_def_property_ui_text(prop, "Float Image Pixels",
912                                  "Image pixels components, as floats (RGBA concatenated values)");
913         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_float_get_length");
914         RNA_def_property_float_funcs(prop, "rna_ImagePreview_image_pixels_float_get",
915                                      "rna_ImagePreview_image_pixels_float_set", NULL);
916
917
918         prop = RNA_def_property(srna, "is_icon_custom", PROP_BOOLEAN, PROP_NONE);
919         RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_ICON]", PRV_USER_EDITED);
920         RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_icon_custom_set");
921         RNA_def_property_ui_text(prop, "Custom Icon", "True if this preview icon has been modified by py script,"
922                                  "and is no more auto-generated by Blender");
923
924         prop = RNA_def_int_vector(srna, "icon_size", 2, NULL, 0, 0, "Icon Size",
925                                   "Width and height in pixels", 0, 0);
926         RNA_def_property_subtype(prop, PROP_PIXEL);
927         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_size_get", "rna_ImagePreview_icon_size_set", NULL);
928
929         prop = RNA_def_property(srna, "icon_pixels", PROP_INT, PROP_NONE);
930         RNA_def_property_flag(prop, PROP_DYNAMIC);
931         RNA_def_property_multi_array(prop, 1, NULL);
932         RNA_def_property_ui_text(prop, "Icon Pixels", "Icon pixels, as bytes (always RGBA 32bits)");
933         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_get_length");
934         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_pixels_get", "rna_ImagePreview_icon_pixels_set", NULL);
935
936         prop = RNA_def_property(srna, "icon_pixels_float", PROP_FLOAT, PROP_NONE);
937         RNA_def_property_flag(prop, PROP_DYNAMIC);
938         RNA_def_property_multi_array(prop, 1, NULL);
939         RNA_def_property_ui_text(prop, "Float Icon Pixels", "Icon pixels components, as floats (RGBA concatenated values)");
940         RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_float_get_length");
941         RNA_def_property_float_funcs(prop, "rna_ImagePreview_icon_pixels_float_get",
942                                      "rna_ImagePreview_icon_pixels_float_set", NULL);
943
944         prop = RNA_def_int(srna, "icon_id", 0, INT_MIN, INT_MAX, "Icon ID",
945                            "Unique integer identifying this preview as an icon (zero means invalid)", INT_MIN, INT_MAX);
946         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
947         RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_id_get", NULL, NULL);
948
949         func = RNA_def_function(srna, "reload", "rna_ImagePreview_icon_reload");
950         RNA_def_function_ui_description(func, "Reload the preview from its source path");
951 }
952
953 static void rna_def_ID(BlenderRNA *brna)
954 {
955         StructRNA *srna;
956         FunctionRNA *func;
957         PropertyRNA *prop, *parm;
958
959         static const EnumPropertyItem update_flag_items[] = {
960                 {OB_RECALC_OB, "OBJECT", 0, "Object", ""},
961                 {OB_RECALC_DATA, "DATA", 0, "Data", ""},
962                 {OB_RECALC_TIME, "TIME", 0, "Time", ""},
963                 {0, NULL, 0, NULL, NULL}
964         };
965
966         srna = RNA_def_struct(brna, "ID", NULL);
967         RNA_def_struct_ui_text(srna, "ID",
968                                "Base type for data-blocks, defining a unique name, linking from other libraries "
969                                "and garbage collection");
970         RNA_def_struct_flag(srna, STRUCT_ID | STRUCT_ID_REFCOUNT);
971         RNA_def_struct_refine_func(srna, "rna_ID_refine");
972         RNA_def_struct_idprops_func(srna, "rna_ID_idprops");
973
974         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
975         RNA_def_property_ui_text(prop, "Name", "Unique data-block ID name");
976         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
977         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
978         RNA_def_property_editable_func(prop, "rna_ID_name_editable");
979         RNA_def_property_update(prop, NC_ID | NA_RENAME, NULL);
980         RNA_def_struct_name_property(srna, prop);
981
982         prop = RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
983         RNA_def_property_int_sdna(prop, NULL, "us");
984         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
985         RNA_def_property_ui_text(prop, "Users", "Number of times this data-block is referenced");
986
987         prop = RNA_def_property(srna, "use_fake_user", PROP_BOOLEAN, PROP_NONE);
988         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
989         RNA_def_property_ui_text(prop, "Fake User", "Save this data-block even if it has no users");
990         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
991
992         prop = RNA_def_property(srna, "tag", PROP_BOOLEAN, PROP_NONE);
993         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_DOIT);
994         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
995         RNA_def_property_ui_text(prop, "Tag",
996                                  "Tools can use this to tag data for their own purposes "
997                                  "(initial state is undefined)");
998
999         prop = RNA_def_property(srna, "is_updated", PROP_BOOLEAN, PROP_NONE);
1000         RNA_def_property_boolean_sdna(prop, NULL, "recalc", ID_RECALC);
1001         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1002         RNA_def_property_ui_text(prop, "Is Updated", "Data-block is tagged for recalculation");
1003
1004         prop = RNA_def_property(srna, "is_updated_data", PROP_BOOLEAN, PROP_NONE);
1005         RNA_def_property_boolean_sdna(prop, NULL, "recalc", ID_RECALC_DATA);
1006         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1007         RNA_def_property_ui_text(prop, "Is Updated Data", "Data-block data is tagged for recalculation");
1008
1009         prop = RNA_def_property(srna, "is_library_indirect", PROP_BOOLEAN, PROP_NONE);
1010         RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_INDIRECT);
1011         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1012         RNA_def_property_ui_text(prop, "Is Indirect", "Is this ID block linked indirectly");
1013
1014         prop = RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
1015         RNA_def_property_pointer_sdna(prop, NULL, "lib");
1016         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1017         RNA_def_property_ui_text(prop, "Library", "Library file the data-block is linked from");
1018
1019         prop = RNA_def_pointer(srna, "preview", "ImagePreview", "Preview",
1020                                "Preview image and icon of this data-block (None if not supported for this type of data)");
1021         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1022         RNA_def_property_pointer_funcs(prop, "rna_IDPreview_get", NULL, NULL, NULL);
1023
1024         /* functions */
1025         func = RNA_def_function(srna, "copy", "rna_ID_copy");
1026         RNA_def_function_ui_description(func, "Create a copy of this data-block (not supported for all data-blocks)");
1027         RNA_def_function_flag(func, FUNC_USE_MAIN);
1028         parm = RNA_def_pointer(func, "id", "ID", "", "New copy of the ID");
1029         RNA_def_function_return(func, parm);
1030
1031         func = RNA_def_function(srna, "user_clear", "rna_ID_user_clear");
1032         RNA_def_function_ui_description(func, "Clear the user count of a data-block so its not saved, "
1033                                         "on reload the data will be removed");
1034
1035         func = RNA_def_function(srna, "user_remap", "rna_ID_user_remap");
1036         RNA_def_function_ui_description(func, "Replace all usage in the .blend file of this ID by new given one");
1037         RNA_def_function_flag(func, FUNC_USE_MAIN);
1038         parm = RNA_def_pointer(func, "new_id", "ID", "", "New ID to use");
1039         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1040
1041         func = RNA_def_function(srna, "make_local", "rna_ID_make_local");
1042         RNA_def_function_ui_description(func, "Make this datablock local, return local one "
1043                                               "(may be a copy of the original, in case it is also indirectly used)");
1044         RNA_def_function_flag(func, FUNC_USE_MAIN);
1045         parm = RNA_def_boolean(func, "clear_proxy", true, "",
1046                                "Whether to clear proxies (the default behavior, "
1047                                "note that if object has to be duplicated to be made local, proxies are always cleared)");
1048         parm = RNA_def_pointer(func, "id", "ID", "", "This ID, or the new ID if it was copied");
1049         RNA_def_function_return(func, parm);
1050
1051         func = RNA_def_function(srna, "user_of_id", "BKE_library_ID_use_ID");
1052         RNA_def_function_ui_description(func, "Count the number of times that ID uses/references given one");
1053         parm = RNA_def_pointer(func, "id", "ID", "", "ID to count usages");
1054         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1055         parm = RNA_def_int(func, "count", 0, 0, INT_MAX,
1056                            "", "Number of usages/references of given id by current data-block", 0, INT_MAX);
1057         RNA_def_function_return(func, parm);
1058
1059         func = RNA_def_function(srna, "animation_data_create", "rna_ID_animation_data_create");
1060         RNA_def_function_flag(func, FUNC_USE_MAIN);
1061         RNA_def_function_ui_description(func, "Create animation data to this ID, note that not all ID types support this");
1062         parm = RNA_def_pointer(func, "anim_data", "AnimData", "", "New animation data or NULL");
1063         RNA_def_function_return(func, parm);
1064
1065         func = RNA_def_function(srna, "animation_data_clear", "rna_ID_animation_data_free");
1066         RNA_def_function_flag(func, FUNC_USE_MAIN);
1067         RNA_def_function_ui_description(func, "Clear animation on this this ID");
1068
1069         func = RNA_def_function(srna, "update_tag", "rna_ID_update_tag");
1070         RNA_def_function_flag(func, FUNC_USE_REPORTS);
1071         RNA_def_function_ui_description(func,
1072                                         "Tag the ID to update its display data, "
1073                                         "e.g. when calling :class:`bpy.types.Scene.update`");
1074         RNA_def_enum_flag(func, "refresh", update_flag_items, 0, "", "Type of updates to perform");
1075
1076 #ifdef WITH_PYTHON
1077         RNA_def_struct_register_funcs(srna, NULL, NULL, "rna_ID_instance");
1078 #endif
1079 }
1080
1081 static void rna_def_library(BlenderRNA *brna)
1082 {
1083         StructRNA *srna;
1084         FunctionRNA *func;
1085         PropertyRNA *prop;
1086
1087         srna = RNA_def_struct(brna, "Library", "ID");
1088         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked");
1089         RNA_def_struct_ui_icon(srna, ICON_LIBRARY_DATA_DIRECT);
1090
1091         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
1092         RNA_def_property_string_sdna(prop, NULL, "name");
1093         RNA_def_property_ui_text(prop, "File Path", "Path to the library .blend file");
1094         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Library_filepath_set");
1095         
1096         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
1097         RNA_def_property_struct_type(prop, "Library");
1098         RNA_def_property_ui_text(prop, "Parent", "");
1099
1100         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
1101         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
1102         RNA_def_property_ui_text(prop, "Packed File", "");
1103
1104         func = RNA_def_function(srna, "reload", "WM_lib_reload");
1105         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
1106         RNA_def_function_ui_description(func, "Reload this library and all its linked data-blocks");
1107 }
1108 void RNA_def_ID(BlenderRNA *brna)
1109 {
1110         StructRNA *srna;
1111
1112         /* built-in unknown type */
1113         srna = RNA_def_struct(brna, "UnknownType", NULL);
1114         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data");
1115
1116         /* built-in any type */
1117         srna = RNA_def_struct(brna, "AnyType", NULL);
1118         RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data");
1119
1120         rna_def_ID(brna);
1121         rna_def_image_preview(brna);
1122         rna_def_ID_properties(brna);
1123         rna_def_ID_materials(brna);
1124         rna_def_library(brna);
1125 }
1126
1127 #endif