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