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