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