2011-02-23 10:52:22 +00:00
|
|
|
/*
|
2008-11-07 02:58:25 +00:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 13:34:04 +00:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2008-11-07 02:58:25 +00:00
|
|
|
*
|
|
|
|
|
* Contributor(s): Blender Foundation (2008).
|
|
|
|
|
*
|
|
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
|
|
|
*/
|
|
|
|
|
|
2011-02-27 20:20:01 +00:00
|
|
|
/** \file blender/makesrna/intern/rna_ID.c
|
|
|
|
|
* \ingroup RNA
|
|
|
|
|
*/
|
|
|
|
|
|
2008-11-07 02:58:25 +00:00
|
|
|
#include <stdlib.h>
|
2008-11-17 18:44:06 +00:00
|
|
|
#include <stdio.h>
|
2008-11-07 02:58:25 +00:00
|
|
|
|
|
|
|
|
#include "DNA_ID.h"
|
2010-10-24 07:02:19 +00:00
|
|
|
#include "DNA_vfont_types.h"
|
2011-07-31 12:43:41 +00:00
|
|
|
#include "DNA_material_types.h"
|
2011-01-03 09:09:30 +00:00
|
|
|
#include "DNA_object_types.h"
|
2008-11-07 02:58:25 +00:00
|
|
|
|
2013-03-07 02:44:55 +00:00
|
|
|
#include "BLI_utildefines.h"
|
2018-05-07 17:14:28 +02:00
|
|
|
#include "BLI_math_base.h"
|
2013-03-07 02:44:55 +00:00
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
#include "BKE_icons.h"
|
2016-11-10 10:42:28 +01:00
|
|
|
#include "BKE_object.h"
|
2015-05-11 16:29:12 +02:00
|
|
|
|
2013-03-07 02:44:55 +00:00
|
|
|
#include "RNA_access.h"
|
|
|
|
|
#include "RNA_define.h"
|
2013-09-11 21:27:14 +00:00
|
|
|
#include "RNA_enum_types.h"
|
2013-03-07 02:44:55 +00:00
|
|
|
|
2009-11-25 23:13:47 +00:00
|
|
|
#include "WM_types.h"
|
|
|
|
|
|
2009-06-03 23:16:51 +00:00
|
|
|
#include "rna_internal.h"
|
|
|
|
|
|
2012-03-18 09:27:36 +00:00
|
|
|
/* enum of ID-block types
|
2009-10-14 09:08:53 +00:00
|
|
|
* NOTE: need to keep this in line with the other defines for these
|
|
|
|
|
*/
|
2017-10-18 15:07:26 +11:00
|
|
|
const EnumPropertyItem rna_enum_id_type_items[] = {
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_AC, "ACTION", ICON_ACTION, "Action", ""},
|
|
|
|
|
{ID_AR, "ARMATURE", ICON_ARMATURE_DATA, "Armature", ""},
|
|
|
|
|
{ID_BR, "BRUSH", ICON_BRUSH_DATA, "Brush", ""},
|
|
|
|
|
{ID_CA, "CAMERA", ICON_CAMERA_DATA, "Camera", ""},
|
Basic Alembic support
All in all, this patch adds an Alembic importer, an Alembic exporter,
and a new CacheFile data block which, for now, wraps around an Alembic
archive. This data block is made available through a new modifier ("Mesh
Sequence Cache") as well as a new constraint ("Transform Cache") to
somewhat properly support respectively geometric and transformation data
streaming from alembic caches.
A more in-depth documentation is to be found on the wiki, as well as a
guide to compile alembic: https://wiki.blender.org/index.php/
User:Kevindietrich/AlembicBasicIo.
Many thanks to everyone involved in this little project, and huge shout
out to "cgstrive" for the thorough testings with Maya, 3ds Max, Houdini
and Realflow as well as @fjuhec, @jensverwiebe and @jasperge for the
custom builds and compile fixes.
Reviewers: sergey, campbellbarton, mont29
Reviewed By: sergey, campbellbarton, mont29
Differential Revision: https://developer.blender.org/D2060
2016-08-06 06:20:37 +02:00
|
|
|
{ID_CF, "CACHEFILE", ICON_FILE, "Cache File", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_CU, "CURVE", ICON_CURVE_DATA, "Curve", ""},
|
|
|
|
|
{ID_VF, "FONT", ICON_FONT_DATA, "Font", ""},
|
|
|
|
|
{ID_GD, "GREASEPENCIL", ICON_GREASEPENCIL, "Grease Pencil", ""},
|
|
|
|
|
{ID_GR, "GROUP", ICON_GROUP, "Group", ""},
|
|
|
|
|
{ID_IM, "IMAGE", ICON_IMAGE_DATA, "Image", ""},
|
|
|
|
|
{ID_KE, "KEY", ICON_SHAPEKEY_DATA, "Key", ""},
|
|
|
|
|
{ID_LA, "LAMP", ICON_LAMP_DATA, "Lamp", ""},
|
2009-10-15 13:47:18 +00:00
|
|
|
{ID_LI, "LIBRARY", ICON_LIBRARY_DATA_DIRECT, "Library", ""},
|
2014-03-04 03:47:58 +11:00
|
|
|
{ID_LS, "LINESTYLE", ICON_LINE_DATA, "Line Style", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_LT, "LATTICE", ICON_LATTICE_DATA, "Lattice", ""},
|
2014-10-06 21:39:03 +02:00
|
|
|
{ID_MSK, "MASK", ICON_MOD_MASK, "Mask", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_MA, "MATERIAL", ICON_MATERIAL_DATA, "Material", ""},
|
2016-07-26 20:15:00 +02:00
|
|
|
{ID_MB, "META", ICON_META_DATA, "Metaball", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_ME, "MESH", ICON_MESH_DATA, "Mesh", ""},
|
2016-07-26 20:15:00 +02:00
|
|
|
{ID_MC, "MOVIECLIP", ICON_CLIP, "Movie Clip", ""},
|
|
|
|
|
{ID_NT, "NODETREE", ICON_NODETREE, "Node Tree", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_OB, "OBJECT", ICON_OBJECT_DATA, "Object", ""},
|
2014-10-06 21:39:03 +02:00
|
|
|
{ID_PC, "PAINTCURVE", ICON_CURVE_BEZCURVE, "Paint Curve", ""},
|
|
|
|
|
{ID_PAL, "PALETTE", ICON_COLOR, "Palette", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_PA, "PARTICLE", ICON_PARTICLE_DATA, "Particle", ""},
|
|
|
|
|
{ID_SCE, "SCENE", ICON_SCENE_DATA, "Scene", ""},
|
2009-10-15 13:47:18 +00:00
|
|
|
{ID_SCR, "SCREEN", ICON_SPLITSCREEN, "Screen", ""},
|
2015-08-06 12:34:31 +10:00
|
|
|
{ID_SO, "SOUND", ICON_PLAY_AUDIO, "Sound", ""},
|
2011-08-01 11:44:20 +00:00
|
|
|
{ID_SPK, "SPEAKER", ICON_SPEAKER, "Speaker", ""},
|
2009-10-14 09:08:53 +00:00
|
|
|
{ID_TXT, "TEXT", ICON_TEXT, "Text", ""},
|
|
|
|
|
{ID_TE, "TEXTURE", ICON_TEXTURE_DATA, "Texture", ""},
|
2009-10-15 13:47:18 +00:00
|
|
|
{ID_WM, "WINDOWMANAGER", ICON_FULLSCREEN, "Window Manager", ""},
|
2015-08-06 12:34:31 +10:00
|
|
|
{ID_WO, "WORLD", ICON_WORLD_DATA, "World", ""},
|
2012-05-12 11:01:29 +00:00
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
|
};
|
2009-10-14 09:08:53 +00:00
|
|
|
|
2008-11-07 02:58:25 +00:00
|
|
|
#ifdef RNA_RUNTIME
|
|
|
|
|
|
2015-07-14 11:19:27 +02:00
|
|
|
#include "DNA_anim_types.h"
|
|
|
|
|
|
2016-06-22 18:05:55 +02:00
|
|
|
#include "BLI_listbase.h"
|
|
|
|
|
|
2012-08-03 23:44:50 +00:00
|
|
|
#include "BKE_font.h"
|
2008-11-17 18:44:06 +00:00
|
|
|
#include "BKE_idprop.h"
|
2009-03-14 23:17:55 +00:00
|
|
|
#include "BKE_library.h"
|
2016-01-06 19:34:42 +01:00
|
|
|
#include "BKE_library_query.h"
|
2016-06-22 18:05:55 +02:00
|
|
|
#include "BKE_library_remap.h"
|
2009-11-05 10:50:58 +00:00
|
|
|
#include "BKE_animsys.h"
|
2010-09-03 07:25:37 +00:00
|
|
|
#include "BKE_material.h"
|
2011-01-03 09:09:30 +00:00
|
|
|
#include "BKE_depsgraph.h"
|
2015-12-28 17:17:25 +11:00
|
|
|
#include "BKE_global.h" /* XXX, remove me */
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2012-05-12 22:38:15 +00:00
|
|
|
#include "WM_api.h"
|
|
|
|
|
|
2008-11-07 02:58:25 +00:00
|
|
|
/* name functions that ignore the first two ID characters */
|
2009-01-08 13:57:29 +00:00
|
|
|
void rna_ID_name_get(PointerRNA *ptr, char *value)
|
2008-11-07 02:58:25 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
|
|
|
|
BLI_strncpy(value, id->name + 2, sizeof(id->name) - 2);
|
2008-11-07 02:58:25 +00:00
|
|
|
}
|
|
|
|
|
|
2009-01-08 13:57:29 +00:00
|
|
|
int rna_ID_name_length(PointerRNA *ptr)
|
2008-11-07 02:58:25 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
|
|
|
|
return strlen(id->name + 2);
|
2008-11-07 02:58:25 +00:00
|
|
|
}
|
|
|
|
|
|
2009-01-08 13:57:29 +00:00
|
|
|
void rna_ID_name_set(PointerRNA *ptr, const char *value)
|
2008-11-07 02:58:25 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
|
|
|
|
BLI_strncpy_utf8(id->name + 2, value, sizeof(id->name) - 2);
|
2015-12-28 17:17:25 +11:00
|
|
|
BLI_libblock_ensure_unique_name(G.main, id->name);
|
2008-11-07 02:58:25 +00:00
|
|
|
}
|
|
|
|
|
|
2016-09-22 00:10:53 +02:00
|
|
|
static int rna_ID_name_editable(PointerRNA *ptr, const char **UNUSED(r_info))
|
2010-01-11 05:10:57 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
2010-01-11 05:10:57 +00:00
|
|
|
|
|
|
|
|
if (GS(id->name) == ID_VF) {
|
2012-08-03 22:12:57 +00:00
|
|
|
VFont *vfont = (VFont *)id;
|
|
|
|
|
if (BKE_vfont_is_builtin(vfont))
|
2014-04-01 11:34:00 +11:00
|
|
|
return false;
|
2010-01-11 05:10:57 +00:00
|
|
|
}
|
|
|
|
|
|
2015-10-06 21:43:04 +11:00
|
|
|
return PROP_EDITABLE;
|
2010-01-11 05:10:57 +00:00
|
|
|
}
|
|
|
|
|
|
2017-11-29 14:09:49 +11:00
|
|
|
short RNA_type_to_ID_code(const StructRNA *type)
|
2008-11-17 18:44:06 +00:00
|
|
|
{
|
2017-11-29 14:09:49 +11:00
|
|
|
const StructRNA *base_type = RNA_struct_base_child_of(type, &RNA_ID);
|
|
|
|
|
if (UNLIKELY(base_type == NULL)) {
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
if (base_type == &RNA_Action) return ID_AC;
|
|
|
|
|
if (base_type == &RNA_Armature) return ID_AR;
|
|
|
|
|
if (base_type == &RNA_Brush) return ID_BR;
|
|
|
|
|
if (base_type == &RNA_CacheFile) return ID_CF;
|
|
|
|
|
if (base_type == &RNA_Camera) return ID_CA;
|
|
|
|
|
if (base_type == &RNA_Curve) return ID_CU;
|
|
|
|
|
if (base_type == &RNA_GreasePencil) return ID_GD;
|
|
|
|
|
if (base_type == &RNA_Group) return ID_GR;
|
|
|
|
|
if (base_type == &RNA_Image) return ID_IM;
|
|
|
|
|
if (base_type == &RNA_Key) return ID_KE;
|
|
|
|
|
if (base_type == &RNA_Lamp) return ID_LA;
|
|
|
|
|
if (base_type == &RNA_Library) return ID_LI;
|
|
|
|
|
if (base_type == &RNA_FreestyleLineStyle) return ID_LS;
|
|
|
|
|
if (base_type == &RNA_Lattice) return ID_LT;
|
|
|
|
|
if (base_type == &RNA_Material) return ID_MA;
|
|
|
|
|
if (base_type == &RNA_MetaBall) return ID_MB;
|
|
|
|
|
if (base_type == &RNA_MovieClip) return ID_MC;
|
|
|
|
|
if (base_type == &RNA_Mesh) return ID_ME;
|
|
|
|
|
if (base_type == &RNA_Mask) return ID_MSK;
|
|
|
|
|
if (base_type == &RNA_NodeTree) return ID_NT;
|
|
|
|
|
if (base_type == &RNA_Object) return ID_OB;
|
|
|
|
|
if (base_type == &RNA_ParticleSettings) return ID_PA;
|
|
|
|
|
if (base_type == &RNA_Palette) return ID_PAL;
|
|
|
|
|
if (base_type == &RNA_PaintCurve) return ID_PC;
|
|
|
|
|
if (base_type == &RNA_Scene) return ID_SCE;
|
|
|
|
|
if (base_type == &RNA_Screen) return ID_SCR;
|
|
|
|
|
if (base_type == &RNA_Sound) return ID_SO;
|
|
|
|
|
if (base_type == &RNA_Speaker) return ID_SPK;
|
|
|
|
|
if (base_type == &RNA_Texture) return ID_TE;
|
|
|
|
|
if (base_type == &RNA_Text) return ID_TXT;
|
|
|
|
|
if (base_type == &RNA_VectorFont) return ID_VF;
|
|
|
|
|
if (base_type == &RNA_World) return ID_WO;
|
|
|
|
|
if (base_type == &RNA_WindowManager) return ID_WM;
|
2009-06-07 13:09:18 +00:00
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2009-06-07 13:09:18 +00:00
|
|
|
StructRNA *ID_code_to_RNA_type(short idcode)
|
|
|
|
|
{
|
2017-11-29 14:09:49 +11:00
|
|
|
/* Note, this switch doesn't use a 'default',
|
|
|
|
|
* so adding new ID's causes a warning. */
|
|
|
|
|
switch ((ID_Type)idcode) {
|
2009-01-05 16:31:00 +00:00
|
|
|
case ID_AC: return &RNA_Action;
|
2008-12-09 11:29:40 +00:00
|
|
|
case ID_AR: return &RNA_Armature;
|
2008-12-01 06:52:18 +00:00
|
|
|
case ID_BR: return &RNA_Brush;
|
2008-11-29 19:53:49 +00:00
|
|
|
case ID_CA: return &RNA_Camera;
|
Basic Alembic support
All in all, this patch adds an Alembic importer, an Alembic exporter,
and a new CacheFile data block which, for now, wraps around an Alembic
archive. This data block is made available through a new modifier ("Mesh
Sequence Cache") as well as a new constraint ("Transform Cache") to
somewhat properly support respectively geometric and transformation data
streaming from alembic caches.
A more in-depth documentation is to be found on the wiki, as well as a
guide to compile alembic: https://wiki.blender.org/index.php/
User:Kevindietrich/AlembicBasicIo.
Many thanks to everyone involved in this little project, and huge shout
out to "cgstrive" for the thorough testings with Maya, 3ds Max, Houdini
and Realflow as well as @fjuhec, @jensverwiebe and @jasperge for the
custom builds and compile fixes.
Reviewers: sergey, campbellbarton, mont29
Reviewed By: sergey, campbellbarton, mont29
Differential Revision: https://developer.blender.org/D2060
2016-08-06 06:20:37 +02:00
|
|
|
case ID_CF: return &RNA_CacheFile;
|
2008-12-01 19:02:27 +00:00
|
|
|
case ID_CU: return &RNA_Curve;
|
2009-08-27 06:03:41 +00:00
|
|
|
case ID_GD: return &RNA_GreasePencil;
|
2008-11-30 05:07:57 +00:00
|
|
|
case ID_GR: return &RNA_Group;
|
2008-11-30 18:39:49 +00:00
|
|
|
case ID_IM: return &RNA_Image;
|
2008-12-03 21:18:10 +00:00
|
|
|
case ID_KE: return &RNA_Key;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
case ID_LA: return &RNA_Lamp;
|
2008-11-29 19:08:46 +00:00
|
|
|
case ID_LI: return &RNA_Library;
|
2010-06-25 22:45:42 +00:00
|
|
|
case ID_LS: return &RNA_FreestyleLineStyle;
|
2008-11-30 16:38:56 +00:00
|
|
|
case ID_LT: return &RNA_Lattice;
|
2008-11-27 13:36:28 +00:00
|
|
|
case ID_MA: return &RNA_Material;
|
2008-11-30 20:18:55 +00:00
|
|
|
case ID_MB: return &RNA_MetaBall;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_MC: return &RNA_MovieClip;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
case ID_ME: return &RNA_Mesh;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_MSK: return &RNA_Mask;
|
|
|
|
|
case ID_NT: return &RNA_NodeTree;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
case ID_OB: return &RNA_Object;
|
2009-02-17 21:07:01 +00:00
|
|
|
case ID_PA: return &RNA_ParticleSettings;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_PAL: return &RNA_Palette;
|
|
|
|
|
case ID_PC: return &RNA_PaintCurve;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
case ID_SCE: return &RNA_Scene;
|
2008-11-29 01:04:15 +00:00
|
|
|
case ID_SCR: return &RNA_Screen;
|
2008-12-26 16:50:05 +00:00
|
|
|
case ID_SO: return &RNA_Sound;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_SPK: return &RNA_Speaker;
|
2009-01-02 23:05:28 +00:00
|
|
|
case ID_TE: return &RNA_Texture;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_TXT: return &RNA_Text;
|
2008-12-02 23:45:11 +00:00
|
|
|
case ID_VF: return &RNA_VectorFont;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
case ID_WM: return &RNA_WindowManager;
|
2015-01-12 19:54:52 +01:00
|
|
|
case ID_WO: return &RNA_World;
|
2014-07-21 12:02:05 +02:00
|
|
|
|
2017-11-29 14:09:49 +11:00
|
|
|
/* deprecated */
|
|
|
|
|
case ID_IP: break;
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
}
|
2017-11-29 14:09:49 +11:00
|
|
|
|
|
|
|
|
return &RNA_ID;
|
2008-11-17 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
2009-06-07 13:09:18 +00:00
|
|
|
StructRNA *rna_ID_refine(PointerRNA *ptr)
|
|
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
2009-06-07 13:09:18 +00:00
|
|
|
|
|
|
|
|
return ID_code_to_RNA_type(GS(id->name));
|
|
|
|
|
}
|
|
|
|
|
|
2013-03-07 02:44:55 +00:00
|
|
|
IDProperty *rna_ID_idprops(PointerRNA *ptr, bool create)
|
2009-05-20 09:52:02 +00:00
|
|
|
{
|
|
|
|
|
return IDP_GetProperties(ptr->data, create);
|
|
|
|
|
}
|
|
|
|
|
|
2009-01-08 13:57:29 +00:00
|
|
|
void rna_ID_fake_user_set(PointerRNA *ptr, int value)
|
2008-11-29 19:08:46 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
ID *id = (ID *)ptr->data;
|
2008-11-29 19:08:46 +00:00
|
|
|
|
2015-11-09 20:59:42 +01:00
|
|
|
if (value) {
|
|
|
|
|
id_fake_user_set(id);
|
2008-11-29 19:08:46 +00:00
|
|
|
}
|
2015-11-09 20:59:42 +01:00
|
|
|
else {
|
|
|
|
|
id_fake_user_clear(id);
|
2008-11-29 19:08:46 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2013-03-07 02:44:55 +00:00
|
|
|
IDProperty *rna_PropertyGroup_idprops(PointerRNA *ptr, bool UNUSED(create))
|
2009-05-20 09:52:02 +00:00
|
|
|
{
|
|
|
|
|
return ptr->data;
|
|
|
|
|
}
|
|
|
|
|
|
2011-05-31 02:14:25 +00:00
|
|
|
void rna_PropertyGroup_unregister(Main *UNUSED(bmain), StructRNA *type)
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
{
|
|
|
|
|
RNA_struct_free(&BLENDER_RNA, type);
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-13 21:52:57 +10:00
|
|
|
StructRNA *rna_PropertyGroup_register(
|
|
|
|
|
Main *UNUSED(bmain), ReportList *reports, void *data, const char *identifier,
|
|
|
|
|
StructValidateFunc validate, StructCallbackFunc UNUSED(call),
|
|
|
|
|
StructFreeFunc UNUSED(free))
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
{
|
|
|
|
|
PointerRNA dummyptr;
|
|
|
|
|
|
|
|
|
|
/* create dummy pointer */
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_pointer_create(NULL, &RNA_PropertyGroup, NULL, &dummyptr);
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
|
|
|
|
|
/* validate the python class */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (validate(&dummyptr, data, NULL) != 0)
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
return NULL;
|
|
|
|
|
|
2009-12-22 10:04:15 +00:00
|
|
|
/* note: it looks like there is no length limit on the srna id since its
|
|
|
|
|
* just a char pointer, but take care here, also be careful that python
|
2012-02-08 04:37:37 +00:00
|
|
|
* owns the string pointer which it could potentially free while blender
|
2009-12-22 10:04:15 +00:00
|
|
|
* is running. */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (BLI_strnlen(identifier, MAX_IDPROP_NAME) == MAX_IDPROP_NAME) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_reportf(reports, RPT_ERROR, "Registering id property class: '%s' is too long, maximum length is %d",
|
|
|
|
|
identifier, MAX_IDPROP_NAME);
|
2009-12-22 10:04:15 +00:00
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2013-01-09 05:32:15 +00:00
|
|
|
return RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup); /* XXX */
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
}
|
|
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
StructRNA *rna_PropertyGroup_refine(PointerRNA *ptr)
|
2.5: RNA, defining enums, pointers and collections properties is now
possible from python, but it's still work in progress.
Pointers and collections are restricted to types derived from
IDPropertyGroup (same as for operators), because RNA knows how to
allocate/deallocate those.
Collections have .add() and .remove(number) functions that can be
used. The remove function should be fixed to take an other argument
than a number.
With the IDPropertyGroup restriction, pointers are more like nested
structs. They don't have add(), remove() yet, not sure where to put
them. Currently the pointer / nested struct is automatically allocated
in the get() function, this needs to be fixed, rule is that RNA get()
will not change any data for thread safety.
Also, it is only possible to add properties to structs after they have
been registered, which needs to be improved as well.
Example code:
http://www.pasteall.org/7201/python
2009-08-18 01:29:25 +00:00
|
|
|
{
|
|
|
|
|
return ptr->type;
|
|
|
|
|
}
|
|
|
|
|
|
2016-07-10 14:52:00 +02:00
|
|
|
static ID *rna_ID_copy(ID *id, Main *bmain)
|
2009-09-28 14:28:45 +00:00
|
|
|
{
|
|
|
|
|
ID *newid;
|
|
|
|
|
|
2016-07-10 14:52:00 +02:00
|
|
|
if (id_copy(bmain, id, &newid, false)) {
|
2012-03-05 23:30:41 +00:00
|
|
|
if (newid) id_us_min(newid);
|
2009-09-28 14:28:45 +00:00
|
|
|
return newid;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2011-02-07 08:13:28 +00:00
|
|
|
static void rna_ID_update_tag(ID *id, ReportList *reports, int flag)
|
2011-01-03 09:09:30 +00:00
|
|
|
{
|
|
|
|
|
/* XXX, new function for this! */
|
2012-03-09 18:28:30 +00:00
|
|
|
#if 0
|
|
|
|
|
if (ob->type == OB_FONT) {
|
2011-01-03 09:09:30 +00:00
|
|
|
Curve *cu = ob->data;
|
|
|
|
|
freedisplist(&cu->disp);
|
2014-01-03 14:18:06 +11:00
|
|
|
BKE_vfont_to_curve(bmain, sce, ob, FO_EDIT, NULL);
|
2012-03-09 18:28:30 +00:00
|
|
|
}
|
|
|
|
|
#endif
|
2011-01-03 09:09:30 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (flag == 0) {
|
2011-01-03 09:09:30 +00:00
|
|
|
/* pass */
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
/* ensure flag us correct for the type */
|
2012-03-05 23:30:41 +00:00
|
|
|
switch (GS(id->name)) {
|
2012-05-12 11:01:29 +00:00
|
|
|
case ID_OB:
|
|
|
|
|
if (flag & ~(OB_RECALC_ALL)) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with Object ID type");
|
2012-05-12 11:01:29 +00:00
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
/* Could add particle updates later */
|
2012-03-09 18:28:30 +00:00
|
|
|
#if 0
|
2012-05-12 11:01:29 +00:00
|
|
|
case ID_PA:
|
|
|
|
|
if (flag & ~(OB_RECALC_ALL | PSYS_RECALC)) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_report(reports, RPT_ERROR, "'Refresh' incompatible with ParticleSettings ID type");
|
2012-05-12 11:01:29 +00:00
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
break;
|
2012-03-09 18:28:30 +00:00
|
|
|
#endif
|
2012-05-12 11:01:29 +00:00
|
|
|
default:
|
|
|
|
|
BKE_report(reports, RPT_ERROR, "This ID type is not compatible with any 'refresh' options");
|
|
|
|
|
return;
|
2011-01-03 09:09:30 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
DAG_id_tag_update(id, flag);
|
|
|
|
|
}
|
|
|
|
|
|
2012-09-23 18:50:56 +00:00
|
|
|
static void rna_ID_user_clear(ID *id)
|
2010-03-11 17:18:06 +00:00
|
|
|
{
|
2015-11-09 20:59:42 +01:00
|
|
|
id_fake_user_clear(id);
|
2012-03-18 07:38:51 +00:00
|
|
|
id->us = 0; /* don't save */
|
2010-03-11 17:18:06 +00:00
|
|
|
}
|
|
|
|
|
|
2016-06-22 18:05:55 +02:00
|
|
|
static void rna_ID_user_remap(ID *id, Main *bmain, ID *new_id)
|
|
|
|
|
{
|
2017-04-17 22:33:07 +02:00
|
|
|
if ((GS(id->name) == GS(new_id->name)) && (id != new_id)) {
|
2016-06-22 18:05:55 +02:00
|
|
|
/* For now, do not allow remapping data in linked data from here... */
|
|
|
|
|
BKE_libblock_remap(bmain, id, new_id, ID_REMAP_SKIP_INDIRECT_USAGE | ID_REMAP_SKIP_NEVER_NULL_USAGE);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-11-21 20:57:02 +01:00
|
|
|
static struct ID *rna_ID_make_local(struct ID *self, Main *bmain, int clear_proxy)
|
2016-11-10 10:42:28 +01:00
|
|
|
{
|
|
|
|
|
/* Special case, as we can't rely on id_make_local(); it clears proxies. */
|
|
|
|
|
if (!clear_proxy && GS(self->name) == ID_OB) {
|
|
|
|
|
BKE_object_make_local_ex(bmain, (Object *)self, false, clear_proxy);
|
|
|
|
|
}
|
2016-11-21 20:57:02 +01:00
|
|
|
else {
|
2016-11-10 10:42:28 +01:00
|
|
|
id_make_local(bmain, self, false, false);
|
|
|
|
|
}
|
|
|
|
|
|
2016-11-30 15:25:54 +01:00
|
|
|
ID *ret_id = self->newid ? self->newid : self;
|
|
|
|
|
BKE_id_clear_newpoin(self);
|
|
|
|
|
return ret_id;
|
2016-11-10 10:42:28 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2015-07-14 11:19:27 +02:00
|
|
|
static AnimData * rna_ID_animation_data_create(ID *id, Main *bmain)
|
|
|
|
|
{
|
|
|
|
|
AnimData *adt = BKE_animdata_add_id(id);
|
|
|
|
|
DAG_relations_tag_update(bmain);
|
|
|
|
|
return adt;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ID_animation_data_free(ID *id, Main *bmain)
|
|
|
|
|
{
|
ID-Remap - Step one: core work (cleanup and rework of generic ID datablock handling).
This commit changes a lot of how IDs are handled internally, especially the unlinking/freeing
processes. So far, this was very fuzy, to summarize cleanly deleting or replacing a datablock
was pretty much impossible, except for a few special cases.
Also, unlinking was handled by each datatype, in a rather messy and prone-to-errors way (quite
a few ID usages were missed or wrongly handled that way).
One of the main goal of id-remap branch was to cleanup this, and fatorize ID links handling
by using library_query utils to allow generic handling of those, which is now the case
(now, generic ID links handling is only "knwon" from readfile.c and library_query.c).
This commit also adds backends to allow live replacement and deletion of datablocks in Blender
(so-called 'remapping' process, where we replace all usages of a given ID pointer by a new one,
or NULL one in case of unlinking).
This will allow nice new features, like ability to easily reload or relocate libraries, real immediate
deletion of datablocks in blender, replacement of one datablock by another, etc.
Some of those are for next commits.
A word of warning: this commit is highly risky, because it affects potentially a lot in Blender core.
Though it was tested rather deeply, being totally impossible to check all possible ID usage cases,
it's likely there are some remaining issues and bugs in new code... Please report them! ;)
Review task: D2027 (https://developer.blender.org/D2027).
Reviewed by campbellbarton, thanks a bunch.
2016-06-22 17:29:38 +02:00
|
|
|
BKE_animdata_free(id, true);
|
2015-07-14 11:19:27 +02:00
|
|
|
DAG_relations_tag_update(bmain);
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-11 18:37:54 +11:00
|
|
|
#ifdef WITH_PYTHON
|
|
|
|
|
void **rna_ID_instance(PointerRNA *ptr)
|
|
|
|
|
{
|
|
|
|
|
ID *id = (ID *)ptr->data;
|
|
|
|
|
return &id->py_instance;
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2010-09-24 00:39:01 +00:00
|
|
|
static void rna_IDPArray_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
|
|
|
|
|
{
|
2012-03-05 23:30:41 +00:00
|
|
|
IDProperty *prop = (IDProperty *)ptr->data;
|
2010-09-24 00:39:01 +00:00
|
|
|
rna_iterator_array_begin(iter, IDP_IDPArray(prop), sizeof(IDProperty), prop->len, 0, NULL);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static int rna_IDPArray_length(PointerRNA *ptr)
|
|
|
|
|
{
|
2012-03-05 23:30:41 +00:00
|
|
|
IDProperty *prop = (IDProperty *)ptr->data;
|
2010-09-24 00:39:01 +00:00
|
|
|
return prop->len;
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-01 21:09:42 +00:00
|
|
|
int rna_IDMaterials_assign_int(PointerRNA *ptr, int key, const PointerRNA *assign_ptr)
|
2011-10-01 17:54:33 +00:00
|
|
|
{
|
2012-03-05 23:30:41 +00:00
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
short *totcol = give_totcolp_id(id);
|
|
|
|
|
Material *mat_id = assign_ptr->id.data;
|
|
|
|
|
if (totcol && (key >= 0 && key < *totcol)) {
|
2011-10-11 05:45:59 +00:00
|
|
|
assign_material_id(id, mat_id, key + 1);
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
2011-10-01 17:54:33 +00:00
|
|
|
}
|
|
|
|
|
|
2016-08-12 14:59:11 +02:00
|
|
|
static void rna_IDMaterials_append_id(ID *id, Main *bmain, Material *ma)
|
2012-05-12 22:38:15 +00:00
|
|
|
{
|
2016-08-12 14:59:11 +02:00
|
|
|
BKE_material_append_id(bmain, id, ma);
|
2012-05-12 22:38:15 +00:00
|
|
|
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
|
|
|
|
|
}
|
|
|
|
|
|
2016-08-12 14:59:11 +02:00
|
|
|
static Material *rna_IDMaterials_pop_id(ID *id, Main *bmain, ReportList *reports, int index_i, int remove_material_slot)
|
2012-05-12 22:38:15 +00:00
|
|
|
{
|
2013-08-13 10:21:11 +00:00
|
|
|
Material *ma;
|
|
|
|
|
short *totcol = give_totcolp_id(id);
|
|
|
|
|
const short totcol_orig = *totcol;
|
|
|
|
|
if (index_i < 0) {
|
|
|
|
|
index_i += (*totcol);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ((index_i < 0) || (index_i >= (*totcol))) {
|
|
|
|
|
BKE_report(reports, RPT_ERROR, "Index out of range");
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2016-08-12 14:59:11 +02:00
|
|
|
ma = BKE_material_pop_id(bmain, id, index_i, remove_material_slot);
|
2013-08-13 10:21:11 +00:00
|
|
|
|
|
|
|
|
if (*totcol == totcol_orig) {
|
|
|
|
|
BKE_report(reports, RPT_ERROR, "No material to removed");
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
2012-05-12 22:38:15 +00:00
|
|
|
|
|
|
|
|
DAG_id_tag_update(id, OB_RECALC_DATA);
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
|
|
|
|
|
|
|
|
|
|
return ma;
|
|
|
|
|
}
|
|
|
|
|
|
2013-08-14 11:29:58 +00:00
|
|
|
static void rna_IDMaterials_clear_id(ID *id, int remove_material_slot)
|
|
|
|
|
{
|
2016-08-12 14:59:11 +02:00
|
|
|
BKE_material_clear_id(G.main, id, remove_material_slot);
|
2013-08-14 11:29:58 +00:00
|
|
|
|
|
|
|
|
DAG_id_tag_update(id, OB_RECALC_DATA);
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_DRAW, id);
|
|
|
|
|
WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, id);
|
|
|
|
|
}
|
|
|
|
|
|
2012-09-23 18:50:56 +00:00
|
|
|
static void rna_Library_filepath_set(PointerRNA *ptr, const char *value)
|
2011-10-23 17:52:20 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
Library *lib = (Library *)ptr->data;
|
2011-10-23 17:52:20 +00:00
|
|
|
BKE_library_filepath_set(lib, value);
|
|
|
|
|
}
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
/* ***** ImagePreview ***** */
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_is_custom_set(PointerRNA *ptr, int value, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ((value && (prv_img->flag[size] & PRV_USER_EDITED)) || (!value && !(prv_img->flag[size] & PRV_USER_EDITED))) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (value)
|
|
|
|
|
prv_img->flag[size] |= PRV_USER_EDITED;
|
|
|
|
|
else
|
|
|
|
|
prv_img->flag[size] &= ~PRV_USER_EDITED;
|
|
|
|
|
|
|
|
|
|
prv_img->flag[size] |= PRV_CHANGED;
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_clear_single(prv_img, size);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_size_get(PointerRNA *ptr, int *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = (ID *)ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_ensure(prv_img, size);
|
|
|
|
|
|
|
|
|
|
values[0] = prv_img->w[size];
|
|
|
|
|
values[1] = prv_img->h[size];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_size_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = (ID *)ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-10 17:26:37 +02:00
|
|
|
BKE_previewimg_clear_single(prv_img, size);
|
2015-05-11 16:29:12 +02:00
|
|
|
|
|
|
|
|
if (values[0] && values[1]) {
|
|
|
|
|
prv_img->rect[size] = MEM_callocN(values[0] * values[1] * sizeof(unsigned int), "prv_rect");
|
|
|
|
|
|
2015-08-10 17:26:37 +02:00
|
|
|
prv_img->w[size] = values[0];
|
|
|
|
|
prv_img->h[size] = values[1];
|
|
|
|
|
}
|
2015-05-11 16:29:12 +02:00
|
|
|
|
|
|
|
|
prv_img->flag[size] |= (PRV_CHANGED | PRV_USER_EDITED);
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
static int rna_ImagePreview_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_ensure(prv_img, size);
|
|
|
|
|
|
|
|
|
|
length[0] = prv_img->w[size] * prv_img->h[size];
|
|
|
|
|
|
|
|
|
|
return length[0];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_pixels_get(PointerRNA *ptr, int *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_ensure(prv_img, size);
|
|
|
|
|
|
|
|
|
|
memcpy(values, prv_img->rect[size], prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_pixels_set(PointerRNA *ptr, const int *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
memcpy(prv_img->rect[size], values, prv_img->w[size] * prv_img->h[size] * sizeof(unsigned int));
|
|
|
|
|
prv_img->flag[size] |= PRV_USER_EDITED;
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
|
|
|
|
|
static int rna_ImagePreview_pixels_float_get_length(
|
|
|
|
|
PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION], enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
BLI_assert(sizeof(unsigned int) == 4);
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_ensure(prv_img, size);
|
|
|
|
|
|
|
|
|
|
length[0] = prv_img->w[size] * prv_img->h[size] * 4;
|
|
|
|
|
|
|
|
|
|
return length[0];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_pixels_float_get(PointerRNA *ptr, float *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
unsigned char *data = (unsigned char *)prv_img->rect[size];
|
|
|
|
|
const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
|
|
|
|
|
size_t i;
|
|
|
|
|
|
|
|
|
|
BLI_assert(sizeof(unsigned int) == 4);
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BKE_previewimg_ensure(prv_img, size);
|
|
|
|
|
|
|
|
|
|
for (i = 0; i < len; i++) {
|
|
|
|
|
values[i] = data[i] * (1.0f / 255.0f);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_pixels_float_set(PointerRNA *ptr, const float *values, enum eIconSizes size)
|
|
|
|
|
{
|
|
|
|
|
ID *id = ptr->id.data;
|
|
|
|
|
PreviewImage *prv_img = (PreviewImage *)ptr->data;
|
|
|
|
|
|
|
|
|
|
unsigned char *data = (unsigned char *)prv_img->rect[size];
|
|
|
|
|
const size_t len = prv_img->w[size] * prv_img->h[size] * 4;
|
|
|
|
|
size_t i;
|
|
|
|
|
|
|
|
|
|
BLI_assert(sizeof(unsigned int) == 4);
|
|
|
|
|
|
|
|
|
|
if (id != NULL) {
|
|
|
|
|
BLI_assert(prv_img == BKE_previewimg_id_ensure(id));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (i = 0; i < len; i++) {
|
|
|
|
|
data[i] = FTOCHAR(values[i]);
|
|
|
|
|
}
|
|
|
|
|
prv_img->flag[size] |= PRV_USER_EDITED;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
static void rna_ImagePreview_is_image_custom_set(PointerRNA *ptr, int value)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_size_get(PointerRNA *ptr, int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_size_get(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_size_set(PointerRNA *ptr, const int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_size_set(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static int rna_ImagePreview_image_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
|
|
|
|
|
{
|
|
|
|
|
return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_pixels_get(PointerRNA *ptr, int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_pixels_set(PointerRNA *ptr, const int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
static int rna_ImagePreview_image_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
|
|
|
|
|
{
|
|
|
|
|
return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_pixels_float_get(PointerRNA *ptr, float *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_image_pixels_float_set(PointerRNA *ptr, const float *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_PREVIEW);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
static void rna_ImagePreview_is_icon_custom_set(PointerRNA *ptr, int value)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_is_custom_set(ptr, value, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_size_get(PointerRNA *ptr, int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_size_get(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_size_set(PointerRNA *ptr, const int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_size_set(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static int rna_ImagePreview_icon_pixels_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
|
|
|
|
|
{
|
|
|
|
|
return rna_ImagePreview_pixels_get_length(ptr, length, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_pixels_get(PointerRNA *ptr, int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_get(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_pixels_set(PointerRNA *ptr, const int *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_set(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
static int rna_ImagePreview_icon_pixels_float_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
|
|
|
|
|
{
|
|
|
|
|
return rna_ImagePreview_pixels_float_get_length(ptr, length, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_pixels_float_get(PointerRNA *ptr, float *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_float_get(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void rna_ImagePreview_icon_pixels_float_set(PointerRNA *ptr, const float *values)
|
|
|
|
|
{
|
|
|
|
|
rna_ImagePreview_pixels_float_set(ptr, values, ICON_SIZE_ICON);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
static int rna_ImagePreview_icon_id_get(PointerRNA *ptr)
|
|
|
|
|
{
|
|
|
|
|
/* Using a callback here allows us to only generate icon matching that preview when icon_id is requested. */
|
2016-07-12 17:49:30 +02:00
|
|
|
return BKE_icon_preview_ensure(ptr->id.data, (PreviewImage *)(ptr->data));
|
2015-05-11 16:29:12 +02:00
|
|
|
}
|
|
|
|
|
static void rna_ImagePreview_icon_reload(PreviewImage *prv)
|
|
|
|
|
{
|
|
|
|
|
/* will lazy load on next use, but only in case icon is not user-modified! */
|
|
|
|
|
if (!(prv->flag[ICON_SIZE_ICON] & PRV_USER_EDITED) && !(prv->flag[ICON_SIZE_PREVIEW] & PRV_USER_EDITED)) {
|
|
|
|
|
BKE_previewimg_clear(prv);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-10 17:26:37 +02:00
|
|
|
static PointerRNA rna_IDPreview_get(PointerRNA *ptr)
|
|
|
|
|
{
|
|
|
|
|
ID *id = (ID *)ptr->data;
|
|
|
|
|
PreviewImage *prv_img = BKE_previewimg_id_ensure(id);
|
|
|
|
|
|
|
|
|
|
return rna_pointer_inherit_refine(ptr, &RNA_ImagePreview, prv_img);
|
|
|
|
|
}
|
|
|
|
|
|
2018-04-05 16:34:36 +02:00
|
|
|
static IDProperty *rna_IDPropertyWrapPtr_idprops(PointerRNA *ptr, bool UNUSED(create))
|
|
|
|
|
{
|
|
|
|
|
if (ptr == NULL) {
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
return ptr->data;
|
|
|
|
|
}
|
|
|
|
|
|
2008-11-07 02:58:25 +00:00
|
|
|
#else
|
|
|
|
|
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
static void rna_def_ID_properties(BlenderRNA *brna)
|
2008-11-17 18:44:06 +00:00
|
|
|
{
|
|
|
|
|
StructRNA *srna;
|
|
|
|
|
PropertyRNA *prop;
|
|
|
|
|
|
|
|
|
|
/* this is struct is used for holding the virtual
|
|
|
|
|
* PropertyRNA's for ID properties */
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "PropertyGroupItem", NULL);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_struct_sdna(srna, "IDProperty");
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties");
|
2008-12-19 04:06:24 +00:00
|
|
|
|
2008-11-17 18:44:06 +00:00
|
|
|
/* IDP_STRING */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
|
|
|
|
|
/* IDP_INT */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
RNA_def_property_array(prop, 1);
|
|
|
|
|
|
|
|
|
|
/* IDP_FLOAT */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
RNA_def_property_array(prop, 1);
|
|
|
|
|
|
|
|
|
|
/* IDP_DOUBLE */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2008-11-17 18:44:06 +00:00
|
|
|
RNA_def_property_array(prop, 1);
|
|
|
|
|
|
|
|
|
|
/* IDP_GROUP */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2009-03-23 13:24:48 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_property_struct_type(prop, "PropertyGroup");
|
2008-11-17 18:44:06 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_property_struct_type(prop, "PropertyGroup");
|
RNA:
* Added support for using pointers + collections as operator properties,
but with the restriction that they must point to other type derived from
ID property groups. The "add" function for these properties will allocate
a new ID property group and point to that.
* Added support for arrays with type IDP_GROUP in ID properties.
* Fix bug getting/setting float array values.
Example code for collections, note the "OperatorMousePath" type is defined
in rna_wm.c and has a float[2] property named "loc".
Defining the operator property:
prop= RNA_def_property(ot->srna, "path", PROP_COLLECTION, PROP_NONE);
RNA_def_property_struct_runtime(prop, &RNA_OperatorMousePath);
Adding values:
PointerRNA itemptr;
float loc[2] = {1, 1},
RNA_collection_add(op->ptr, "path", &itemptr);
RNA_float_set_array(&itemptr, "loc", loc);
Iterating:
RNA_BEGIN(op->ptr, itemptr, "path") {
float loc[2];
RNA_float_get_array(&itemptr, "loc", loc);
printf("Location: %f %f\n", loc[0], loc[1]);
}
RNA_END;
2008-12-26 20:38:52 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "idp_array", PROP_COLLECTION, PROP_NONE);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_property_struct_type(prop, "PropertyGroup");
|
2012-03-18 09:27:36 +00:00
|
|
|
RNA_def_property_collection_funcs(prop, "rna_IDPArray_begin", "rna_iterator_array_next", "rna_iterator_array_end",
|
|
|
|
|
"rna_iterator_array_get", "rna_IDPArray_length", NULL, NULL, NULL);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2010-09-24 00:39:01 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
/* never tested, maybe its useful to have this? */
|
2009-12-09 22:37:02 +00:00
|
|
|
#if 0
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2009-12-09 22:37:02 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
|
2009-12-09 22:37:02 +00:00
|
|
|
RNA_def_struct_name_property(srna, prop);
|
|
|
|
|
#endif
|
|
|
|
|
|
Datablock ID Properties
The absence of datablock properties "will certainly be resolved soon as the need for them is becoming obvious" said the [[http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.67/Python_Nodes|Python Nodes release notes]]. So this patch allows Python scripts to create ID Properties which reference datablocks.
This functionality is implemented for `PointerProperty` and now such properties can be created with Python.
In addition to the standard update callback, `PointerProperty` can have a `poll` callback (standard RNA) which is useful for search menus. For details see the test included in this patch.
Original author: @artfunkel
Alexander (Blend4Web Team)
Reviewers: brecht, artfunkel, mont29, campbellbarton
Reviewed By: mont29, campbellbarton
Subscribers: jta, sergey, campbellbarton, wisaac, poseidon4o, mont29, homyachetser, Evgeny_Rodygin, AlexKowel, yurikovelenov, fjuhec, sharlybg, cardboard, duarteframos, blueprintrandom, a.romanov, BYOB, disnel, aditiapratama, bliblubli, dfelinto, lukastoenne
Maniphest Tasks: T37754
Differential Revision: https://developer.blender.org/D113
2017-04-13 12:30:03 +03:00
|
|
|
/* IDP_ID */
|
|
|
|
|
prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
|
|
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY | PROP_NEVER_UNLINK);
|
|
|
|
|
RNA_def_property_struct_type(prop, "ID");
|
|
|
|
|
|
2008-11-17 18:44:06 +00:00
|
|
|
|
|
|
|
|
/* ID property groups > level 0, since level 0 group is merged
|
|
|
|
|
* with native RNA properties. the builtin_properties will take
|
|
|
|
|
* care of the properties here */
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "PropertyGroup", NULL);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_struct_sdna(srna, "IDPropertyGroup");
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties");
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_struct_idprops_func(srna, "rna_PropertyGroup_idprops");
|
2011-05-18 11:21:10 +00:00
|
|
|
RNA_def_struct_register_funcs(srna, "rna_PropertyGroup_register", "rna_PropertyGroup_unregister", NULL);
|
2011-02-16 02:51:56 +00:00
|
|
|
RNA_def_struct_refine_func(srna, "rna_PropertyGroup_refine");
|
2009-12-09 22:37:02 +00:00
|
|
|
|
|
|
|
|
/* important so python types can have their name used in list views
|
2012-03-18 07:38:51 +00:00
|
|
|
* however this isn't prefect because it overrides how python would set the name
|
2009-12-09 22:37:02 +00:00
|
|
|
* when we only really want this so RNA_def_struct_name_property() is set to something useful */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_EXPORT | PROP_IDPROPERTY);
|
2012-03-05 23:30:41 +00:00
|
|
|
/*RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
|
2009-12-09 22:37:02 +00:00
|
|
|
RNA_def_struct_name_property(srna, prop);
|
2008-11-17 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
2010-09-03 07:25:37 +00:00
|
|
|
|
|
|
|
|
static void rna_def_ID_materials(BlenderRNA *brna)
|
|
|
|
|
{
|
|
|
|
|
StructRNA *srna;
|
|
|
|
|
FunctionRNA *func;
|
|
|
|
|
PropertyRNA *parm;
|
|
|
|
|
|
|
|
|
|
/* for mesh/mball/curve materials */
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "IDMaterials", NULL);
|
2010-09-03 07:25:37 +00:00
|
|
|
RNA_def_struct_sdna(srna, "ID");
|
|
|
|
|
RNA_def_struct_ui_text(srna, "ID Materials", "Collection of materials");
|
|
|
|
|
|
2012-05-12 22:38:15 +00:00
|
|
|
func = RNA_def_function(srna, "append", "rna_IDMaterials_append_id");
|
2016-08-12 14:59:11 +02:00
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_function_ui_description(func, "Add a new material to the data-block");
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "material", "Material", "", "Material to add");
|
Refactor RNA property: split flags in property flags, parameter flags, and internal flags.
This gives us 9 flags available again for properties (we had none anymore),
and also makes things slightly cleaner.
To simplify (and make more clear the differences between mere properties
and function parameters), also added RNA_def_parameter_flags function (and
its clear counterpart), to be used instead of RNA_def_property_flag for
function parameters.
This patch is also a big cleanup (some RNA function definitions were
still using 'prop' PropertyRNA pointer, etc.).
And yes, am aware this will be annoying for all branches, but we really need
to get new flags available for properties (will need at least one for override, etc.).
Reviewers: sergey, Severin
Subscribers: dfelinto, brecht
Differential Revision: https://developer.blender.org/D2400
2016-12-12 15:23:55 +01:00
|
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
2012-05-12 22:38:15 +00:00
|
|
|
|
|
|
|
|
func = RNA_def_function(srna, "pop", "rna_IDMaterials_pop_id");
|
2016-08-12 14:59:11 +02:00
|
|
|
RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_MAIN);
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_function_ui_description(func, "Remove a material from the data-block");
|
2013-08-13 10:21:11 +00:00
|
|
|
parm = RNA_def_int(func, "index", -1, -MAXMAT, MAXMAT, "", "Index of material to remove", 0, MAXMAT);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "material", "Material", "", "Material to remove");
|
2010-09-03 07:25:37 +00:00
|
|
|
RNA_def_function_return(func, parm);
|
2013-08-14 11:29:58 +00:00
|
|
|
|
|
|
|
|
func = RNA_def_function(srna, "clear", "rna_IDMaterials_clear_id");
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_function_ui_description(func, "Remove all materials from the data-block");
|
2013-08-14 11:29:58 +00:00
|
|
|
RNA_def_boolean(func, "update_data", 0, "", "Update data by re-adjusting the material slots assigned");
|
2010-09-03 07:25:37 +00:00
|
|
|
}
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
static void rna_def_image_preview(BlenderRNA *brna)
|
|
|
|
|
{
|
|
|
|
|
StructRNA *srna;
|
|
|
|
|
FunctionRNA *func;
|
|
|
|
|
PropertyRNA *prop;
|
|
|
|
|
|
|
|
|
|
srna = RNA_def_struct(brna, "ImagePreview", NULL);
|
|
|
|
|
RNA_def_struct_sdna(srna, "PreviewImage");
|
|
|
|
|
RNA_def_struct_ui_text(srna, "Image Preview", "Preview image and icon");
|
|
|
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "is_image_custom", PROP_BOOLEAN, PROP_NONE);
|
|
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_PREVIEW]", PRV_USER_EDITED);
|
|
|
|
|
RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_image_custom_set");
|
|
|
|
|
RNA_def_property_ui_text(prop, "Custom Image", "True if this preview image has been modified by py script,"
|
|
|
|
|
"and is no more auto-generated by Blender");
|
|
|
|
|
|
|
|
|
|
prop = RNA_def_int_vector(srna, "image_size", 2, NULL, 0, 0, "Image Size",
|
|
|
|
|
"Width and height in pixels", 0, 0);
|
|
|
|
|
RNA_def_property_subtype(prop, PROP_PIXEL);
|
|
|
|
|
RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_size_get", "rna_ImagePreview_image_size_set", NULL);
|
|
|
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "image_pixels", PROP_INT, PROP_NONE);
|
|
|
|
|
RNA_def_property_flag(prop, PROP_DYNAMIC);
|
|
|
|
|
RNA_def_property_multi_array(prop, 1, NULL);
|
|
|
|
|
RNA_def_property_ui_text(prop, "Image Pixels", "Image pixels, as bytes (always RGBA 32bits)");
|
|
|
|
|
RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_get_length");
|
|
|
|
|
RNA_def_property_int_funcs(prop, "rna_ImagePreview_image_pixels_get", "rna_ImagePreview_image_pixels_set", NULL);
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
prop = RNA_def_property(srna, "image_pixels_float", PROP_FLOAT, PROP_NONE);
|
|
|
|
|
RNA_def_property_flag(prop, PROP_DYNAMIC);
|
|
|
|
|
RNA_def_property_multi_array(prop, 1, NULL);
|
|
|
|
|
RNA_def_property_ui_text(prop, "Float Image Pixels",
|
|
|
|
|
"Image pixels components, as floats (RGBA concatenated values)");
|
|
|
|
|
RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_image_pixels_float_get_length");
|
|
|
|
|
RNA_def_property_float_funcs(prop, "rna_ImagePreview_image_pixels_float_get",
|
|
|
|
|
"rna_ImagePreview_image_pixels_float_set", NULL);
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "is_icon_custom", PROP_BOOLEAN, PROP_NONE);
|
|
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "flag[ICON_SIZE_ICON]", PRV_USER_EDITED);
|
|
|
|
|
RNA_def_property_boolean_funcs(prop, NULL, "rna_ImagePreview_is_icon_custom_set");
|
|
|
|
|
RNA_def_property_ui_text(prop, "Custom Icon", "True if this preview icon has been modified by py script,"
|
|
|
|
|
"and is no more auto-generated by Blender");
|
|
|
|
|
|
|
|
|
|
prop = RNA_def_int_vector(srna, "icon_size", 2, NULL, 0, 0, "Icon Size",
|
|
|
|
|
"Width and height in pixels", 0, 0);
|
|
|
|
|
RNA_def_property_subtype(prop, PROP_PIXEL);
|
|
|
|
|
RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_size_get", "rna_ImagePreview_icon_size_set", NULL);
|
|
|
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "icon_pixels", PROP_INT, PROP_NONE);
|
|
|
|
|
RNA_def_property_flag(prop, PROP_DYNAMIC);
|
|
|
|
|
RNA_def_property_multi_array(prop, 1, NULL);
|
|
|
|
|
RNA_def_property_ui_text(prop, "Icon Pixels", "Icon pixels, as bytes (always RGBA 32bits)");
|
|
|
|
|
RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_get_length");
|
|
|
|
|
RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_pixels_get", "rna_ImagePreview_icon_pixels_set", NULL);
|
|
|
|
|
|
2015-09-01 17:42:12 +02:00
|
|
|
prop = RNA_def_property(srna, "icon_pixels_float", PROP_FLOAT, PROP_NONE);
|
|
|
|
|
RNA_def_property_flag(prop, PROP_DYNAMIC);
|
|
|
|
|
RNA_def_property_multi_array(prop, 1, NULL);
|
|
|
|
|
RNA_def_property_ui_text(prop, "Float Icon Pixels", "Icon pixels components, as floats (RGBA concatenated values)");
|
|
|
|
|
RNA_def_property_dynamic_array_funcs(prop, "rna_ImagePreview_icon_pixels_float_get_length");
|
|
|
|
|
RNA_def_property_float_funcs(prop, "rna_ImagePreview_icon_pixels_float_get",
|
|
|
|
|
"rna_ImagePreview_icon_pixels_float_set", NULL);
|
|
|
|
|
|
2015-05-11 16:29:12 +02:00
|
|
|
prop = RNA_def_int(srna, "icon_id", 0, INT_MIN, INT_MAX, "Icon ID",
|
|
|
|
|
"Unique integer identifying this preview as an icon (zero means invalid)", INT_MIN, INT_MAX);
|
|
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
|
|
|
RNA_def_property_int_funcs(prop, "rna_ImagePreview_icon_id_get", NULL, NULL);
|
|
|
|
|
|
|
|
|
|
func = RNA_def_function(srna, "reload", "rna_ImagePreview_icon_reload");
|
|
|
|
|
RNA_def_function_ui_description(func, "Reload the preview from its source path");
|
|
|
|
|
}
|
|
|
|
|
|
2008-11-29 19:08:46 +00:00
|
|
|
static void rna_def_ID(BlenderRNA *brna)
|
2008-11-07 02:58:25 +00:00
|
|
|
{
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
StructRNA *srna;
|
2009-09-28 14:28:45 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
PropertyRNA *prop, *parm;
|
2008-11-07 02:58:25 +00:00
|
|
|
|
2017-10-18 15:07:26 +11:00
|
|
|
static const EnumPropertyItem update_flag_items[] = {
|
2011-01-03 09:09:30 +00:00
|
|
|
{OB_RECALC_OB, "OBJECT", 0, "Object", ""},
|
|
|
|
|
{OB_RECALC_DATA, "DATA", 0, "Data", ""},
|
|
|
|
|
{OB_RECALC_TIME, "TIME", 0, "Time", ""},
|
2012-05-12 11:01:29 +00:00
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
|
};
|
2011-01-03 09:09:30 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "ID", NULL);
|
2012-03-18 09:27:36 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "ID",
|
2015-10-24 02:44:43 +11:00
|
|
|
"Base type for data-blocks, defining a unique name, linking from other libraries "
|
2012-03-18 09:27:36 +00:00
|
|
|
"and garbage collection");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_struct_flag(srna, STRUCT_ID | STRUCT_ID_REFCOUNT);
|
2009-01-01 15:52:51 +00:00
|
|
|
RNA_def_struct_refine_func(srna, "rna_ID_refine");
|
2010-08-19 10:16:30 +00:00
|
|
|
RNA_def_struct_idprops_func(srna, "rna_ID_idprops");
|
2008-11-07 02:58:25 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_property_ui_text(prop, "Name", "Unique data-block ID name");
|
2008-11-07 02:58:25 +00:00
|
|
|
RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
|
2010-01-11 05:10:57 +00:00
|
|
|
RNA_def_property_editable_func(prop, "rna_ID_name_editable");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_update(prop, NC_ID | NA_RENAME, NULL);
|
2008-11-07 02:58:25 +00:00
|
|
|
RNA_def_struct_name_property(srna, prop);
|
2008-11-29 19:08:46 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
|
2008-11-29 19:08:46 +00:00
|
|
|
RNA_def_property_int_sdna(prop, NULL, "us");
|
2009-03-23 13:24:48 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_property_ui_text(prop, "Users", "Number of times this data-block is referenced");
|
2008-11-29 19:08:46 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "use_fake_user", PROP_BOOLEAN, PROP_NONE);
|
2008-11-29 19:08:46 +00:00
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_property_ui_text(prop, "Fake User", "Save this data-block even if it has no users");
|
2008-11-29 19:08:46 +00:00
|
|
|
RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
|
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "tag", PROP_BOOLEAN, PROP_NONE);
|
Split id->flag in two, persistent flags and runtime tags.
This is purely internal sanitizing/cleanup, no change in behavior is expected at all.
This change was also needed because we were getting short on ID flags, and
future enhancement of 'user_one' ID behavior requires two new ones.
id->flag remains for persistent data (fakeuser only, so far!), this also allows us
100% backward & forward compatibility.
New id->tag is used for most flags. Though written in .blend files, its content
is cleared at read time.
Note that .blend file version was bumped, so that we can clear runtimeflags from
old .blends, important in case we add new persistent flags in future.
Also, behavior of tags (either status ones, or whether they need to be cleared before/after use)
has been added as comments to their declaration.
Reviewers: sergey, campbellbarton
Differential Revision: https://developer.blender.org/D1683
2015-12-27 11:53:50 +01:00
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_DOIT);
|
2010-01-04 15:37:22 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
|
2015-04-13 22:08:51 +10:00
|
|
|
RNA_def_property_ui_text(prop, "Tag",
|
|
|
|
|
"Tools can use this to tag data for their own purposes "
|
|
|
|
|
"(initial state is undefined)");
|
2009-11-03 17:00:38 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "is_updated", PROP_BOOLEAN, PROP_NONE);
|
2017-12-15 09:43:18 +01:00
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "recalc", ID_RECALC);
|
2011-11-02 20:56:52 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_property_ui_text(prop, "Is Updated", "Data-block is tagged for recalculation");
|
2011-11-02 20:56:52 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "is_updated_data", PROP_BOOLEAN, PROP_NONE);
|
2017-12-15 09:43:18 +01:00
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "recalc", ID_RECALC_DATA);
|
2011-11-02 20:56:52 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_property_ui_text(prop, "Is Updated Data", "Data-block data is tagged for recalculation");
|
2011-11-02 20:56:52 +00:00
|
|
|
|
2012-05-17 09:17:39 +00:00
|
|
|
prop = RNA_def_property(srna, "is_library_indirect", PROP_BOOLEAN, PROP_NONE);
|
Split id->flag in two, persistent flags and runtime tags.
This is purely internal sanitizing/cleanup, no change in behavior is expected at all.
This change was also needed because we were getting short on ID flags, and
future enhancement of 'user_one' ID behavior requires two new ones.
id->flag remains for persistent data (fakeuser only, so far!), this also allows us
100% backward & forward compatibility.
New id->tag is used for most flags. Though written in .blend files, its content
is cleared at read time.
Note that .blend file version was bumped, so that we can clear runtimeflags from
old .blends, important in case we add new persistent flags in future.
Also, behavior of tags (either status ones, or whether they need to be cleared before/after use)
has been added as comments to their declaration.
Reviewers: sergey, campbellbarton
Differential Revision: https://developer.blender.org/D1683
2015-12-27 11:53:50 +01:00
|
|
|
RNA_def_property_boolean_sdna(prop, NULL, "tag", LIB_TAG_INDIRECT);
|
2012-05-17 09:17:39 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
|
|
|
RNA_def_property_ui_text(prop, "Is Indirect", "Is this ID block linked indirectly");
|
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
|
2008-11-29 19:08:46 +00:00
|
|
|
RNA_def_property_pointer_sdna(prop, NULL, "lib");
|
2009-03-23 13:24:48 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_property_ui_text(prop, "Library", "Library file the data-block is linked from");
|
2009-09-28 14:28:45 +00:00
|
|
|
|
2015-08-10 17:26:37 +02:00
|
|
|
prop = RNA_def_pointer(srna, "preview", "ImagePreview", "Preview",
|
2015-10-24 02:44:43 +11:00
|
|
|
"Preview image and icon of this data-block (None if not supported for this type of data)");
|
2015-08-10 17:26:37 +02:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
|
|
|
RNA_def_property_pointer_funcs(prop, "rna_IDPreview_get", NULL, NULL, NULL);
|
|
|
|
|
|
2009-09-28 14:28:45 +00:00
|
|
|
/* functions */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "copy", "rna_ID_copy");
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_function_ui_description(func, "Create a copy of this data-block (not supported for all data-blocks)");
|
2016-07-10 14:52:00 +02:00
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "id", "ID", "", "New copy of the ID");
|
2009-09-28 14:28:45 +00:00
|
|
|
RNA_def_function_return(func, parm);
|
2009-11-05 10:50:58 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "user_clear", "rna_ID_user_clear");
|
2015-10-24 02:44:43 +11:00
|
|
|
RNA_def_function_ui_description(func, "Clear the user count of a data-block so its not saved, "
|
2012-05-12 11:01:29 +00:00
|
|
|
"on reload the data will be removed");
|
2010-03-11 17:18:06 +00:00
|
|
|
|
2016-06-22 18:05:55 +02:00
|
|
|
func = RNA_def_function(srna, "user_remap", "rna_ID_user_remap");
|
|
|
|
|
RNA_def_function_ui_description(func, "Replace all usage in the .blend file of this ID by new given one");
|
|
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
|
|
|
|
parm = RNA_def_pointer(func, "new_id", "ID", "", "New ID to use");
|
Refactor RNA property: split flags in property flags, parameter flags, and internal flags.
This gives us 9 flags available again for properties (we had none anymore),
and also makes things slightly cleaner.
To simplify (and make more clear the differences between mere properties
and function parameters), also added RNA_def_parameter_flags function (and
its clear counterpart), to be used instead of RNA_def_property_flag for
function parameters.
This patch is also a big cleanup (some RNA function definitions were
still using 'prop' PropertyRNA pointer, etc.).
And yes, am aware this will be annoying for all branches, but we really need
to get new flags available for properties (will need at least one for override, etc.).
Reviewers: sergey, Severin
Subscribers: dfelinto, brecht
Differential Revision: https://developer.blender.org/D2400
2016-12-12 15:23:55 +01:00
|
|
|
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
|
2016-06-22 18:05:55 +02:00
|
|
|
|
2016-11-10 10:42:28 +01:00
|
|
|
func = RNA_def_function(srna, "make_local", "rna_ID_make_local");
|
|
|
|
|
RNA_def_function_ui_description(func, "Make this datablock local, return local one "
|
|
|
|
|
"(may be a copy of the original, in case it is also indirectly used)");
|
|
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
2016-11-21 20:57:02 +01:00
|
|
|
parm = RNA_def_boolean(func, "clear_proxy", true, "",
|
|
|
|
|
"Whether to clear proxies (the default behavior, "
|
|
|
|
|
"note that if object has to be duplicated to be made local, proxies are always cleared)");
|
2016-11-10 10:42:28 +01:00
|
|
|
parm = RNA_def_pointer(func, "id", "ID", "", "This ID, or the new ID if it was copied");
|
|
|
|
|
RNA_def_function_return(func, parm);
|
|
|
|
|
|
2016-01-06 19:34:42 +01:00
|
|
|
func = RNA_def_function(srna, "user_of_id", "BKE_library_ID_use_ID");
|
|
|
|
|
RNA_def_function_ui_description(func, "Count the number of times that ID uses/references given one");
|
|
|
|
|
parm = RNA_def_pointer(func, "id", "ID", "", "ID to count usages");
|
Refactor RNA property: split flags in property flags, parameter flags, and internal flags.
This gives us 9 flags available again for properties (we had none anymore),
and also makes things slightly cleaner.
To simplify (and make more clear the differences between mere properties
and function parameters), also added RNA_def_parameter_flags function (and
its clear counterpart), to be used instead of RNA_def_property_flag for
function parameters.
This patch is also a big cleanup (some RNA function definitions were
still using 'prop' PropertyRNA pointer, etc.).
And yes, am aware this will be annoying for all branches, but we really need
to get new flags available for properties (will need at least one for override, etc.).
Reviewers: sergey, Severin
Subscribers: dfelinto, brecht
Differential Revision: https://developer.blender.org/D2400
2016-12-12 15:23:55 +01:00
|
|
|
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
|
2016-01-06 19:34:42 +01:00
|
|
|
parm = RNA_def_int(func, "count", 0, 0, INT_MAX,
|
2016-09-19 16:46:20 +02:00
|
|
|
"", "Number of usages/references of given id by current data-block", 0, INT_MAX);
|
2016-01-06 19:34:42 +01:00
|
|
|
RNA_def_function_return(func, parm);
|
|
|
|
|
|
2015-07-14 11:19:27 +02:00
|
|
|
func = RNA_def_function(srna, "animation_data_create", "rna_ID_animation_data_create");
|
|
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Create animation data to this ID, note that not all ID types support this");
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "anim_data", "AnimData", "", "New animation data or NULL");
|
2009-11-05 10:50:58 +00:00
|
|
|
RNA_def_function_return(func, parm);
|
|
|
|
|
|
2015-07-14 11:19:27 +02:00
|
|
|
func = RNA_def_function(srna, "animation_data_clear", "rna_ID_animation_data_free");
|
|
|
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Clear animation on this this ID");
|
2009-11-05 10:50:58 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "update_tag", "rna_ID_update_tag");
|
2011-01-03 09:09:30 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_USE_REPORTS);
|
2015-04-13 22:08:51 +10:00
|
|
|
RNA_def_function_ui_description(func,
|
|
|
|
|
"Tag the ID to update its display data, "
|
|
|
|
|
"e.g. when calling :class:`bpy.types.Scene.update`");
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_enum_flag(func, "refresh", update_flag_items, 0, "", "Type of updates to perform");
|
2017-12-11 18:37:54 +11:00
|
|
|
|
|
|
|
|
#ifdef WITH_PYTHON
|
|
|
|
|
RNA_def_struct_register_funcs(srna, NULL, NULL, "rna_ID_instance");
|
|
|
|
|
#endif
|
2008-11-07 02:58:25 +00:00
|
|
|
}
|
|
|
|
|
|
2008-11-29 19:08:46 +00:00
|
|
|
static void rna_def_library(BlenderRNA *brna)
|
|
|
|
|
{
|
|
|
|
|
StructRNA *srna;
|
2016-07-19 17:49:01 +02:00
|
|
|
FunctionRNA *func;
|
2008-11-29 19:08:46 +00:00
|
|
|
PropertyRNA *prop;
|
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "Library", "ID");
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked");
|
2009-06-03 23:16:51 +00:00
|
|
|
RNA_def_struct_ui_icon(srna, ICON_LIBRARY_DATA_DIRECT);
|
2008-11-29 19:08:46 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
|
2008-11-29 19:08:46 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "name");
|
2010-06-02 17:58:28 +00:00
|
|
|
RNA_def_property_ui_text(prop, "File Path", "Path to the library .blend file");
|
2011-10-23 17:52:20 +00:00
|
|
|
RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Library_filepath_set");
|
2010-04-22 08:25:05 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
|
2010-06-11 10:46:47 +00:00
|
|
|
RNA_def_property_struct_type(prop, "Library");
|
2012-03-18 09:27:36 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Parent", "");
|
2014-08-06 03:10:53 +10:00
|
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
|
|
|
|
|
RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
|
|
|
|
|
RNA_def_property_ui_text(prop, "Packed File", "");
|
2016-07-19 17:49:01 +02:00
|
|
|
|
|
|
|
|
func = RNA_def_function(srna, "reload", "WM_lib_reload");
|
|
|
|
|
RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
|
2016-09-19 16:46:20 +02:00
|
|
|
RNA_def_function_ui_description(func, "Reload this library and all its linked data-blocks");
|
2008-11-29 19:08:46 +00:00
|
|
|
}
|
2018-04-05 16:34:36 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* \attention This is separate from the above. It allows for RNA functions to
|
|
|
|
|
* return an IDProperty *. See MovieClip.metadata for a usage example.
|
|
|
|
|
**/
|
|
|
|
|
static void rna_def_idproperty_wrap_ptr(BlenderRNA *brna)
|
|
|
|
|
{
|
|
|
|
|
StructRNA *srna;
|
|
|
|
|
|
|
|
|
|
srna = RNA_def_struct(brna, "IDPropertyWrapPtr", NULL);
|
|
|
|
|
RNA_def_struct_idprops_func(srna, "rna_IDPropertyWrapPtr_idprops");
|
|
|
|
|
RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES);
|
|
|
|
|
}
|
|
|
|
|
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
void RNA_def_ID(BlenderRNA *brna)
|
2008-11-17 18:44:06 +00:00
|
|
|
{
|
2008-12-19 04:06:24 +00:00
|
|
|
StructRNA *srna;
|
2009-01-10 22:57:33 +00:00
|
|
|
|
2009-04-07 00:49:39 +00:00
|
|
|
/* built-in unknown type */
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "UnknownType", NULL);
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data");
|
2008-11-30 15:55:14 +00:00
|
|
|
|
2009-04-07 00:49:39 +00:00
|
|
|
/* built-in any type */
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "AnyType", NULL);
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data");
|
2009-04-07 00:49:39 +00:00
|
|
|
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
rna_def_ID(brna);
|
2015-05-11 16:29:12 +02:00
|
|
|
rna_def_image_preview(brna);
|
RNA
* More ID property support. What was already possible was showing
ID properties as RNA properties. Now it is possible to define
RNA properties and have an ID property automatically created the
first time it is set (if not set it retuns the default).
* Added support for defining RNA structs and properties at runtime.
This is useful for python and plugins, and could also be used
for operators, not sure yet what is best there, they could be done
in preprocess for speed, but not sure how to do that while keeping
operator registration a single function.
* Added quick functions to get/set properties based on names, to be
used for operators.
* Added some simple support for inheritance, was already doing this
but having it as a feature simplifies things. Two things were added
for this: when defining a struct you can give a 'from' struct whose
properties will be copied, and structs like ID, operator, modifier,
can define a refine callback that will return the more specific type
of the struct like ID -> Object, Mesh, .. .
* Added simple windowmanager wrap with only the registered operators
list, used for testing RNA for operators.
2008-11-21 02:23:46 +00:00
|
|
|
rna_def_ID_properties(brna);
|
2010-09-03 07:25:37 +00:00
|
|
|
rna_def_ID_materials(brna);
|
2008-11-29 19:08:46 +00:00
|
|
|
rna_def_library(brna);
|
2018-04-05 16:34:36 +02:00
|
|
|
rna_def_idproperty_wrap_ptr(brna);
|
2008-11-17 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
2008-11-07 02:58:25 +00:00
|
|
|
#endif
|