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