UI: Python API defining dynamic icons

Currently only able to define geometry icons.

4 files changed, 176 insertions, 0 deletions

diff --git a/source/blender/python/intern/CMakeLists.txt b/source/blender/python/intern/CMakeLists.txt
index b745563508a..c6cab3dda65 100644
--- a/source/blender/python/intern/CMakeLists.txt
+++ b/source/blender/python/intern/CMakeLists.txt
@@ -52,6 +52,7 @@ set(SRC
 	bpy_app_build_options.c
 	bpy_app_ffmpeg.c
 	bpy_app_handlers.c
+	bpy_app_icons.c
 	bpy_app_ocio.c
 	bpy_app_oiio.c
 	bpy_app_opensubdiv.c
@@ -93,6 +94,7 @@ set(SRC
 	bpy_app_build_options.h
 	bpy_app_ffmpeg.h
 	bpy_app_handlers.h
+	bpy_app_icons.h
 	bpy_app_ocio.h
 	bpy_app_oiio.h
 	bpy_app_opensubdiv.h
diff --git a/source/blender/python/intern/bpy_app.c b/source/blender/python/intern/bpy_app.c
index 1e2ce372727..f6e89ef38a5 100644
--- a/source/blender/python/intern/bpy_app.c
+++ b/source/blender/python/intern/bpy_app.c
@@ -47,6 +47,9 @@
 #include "bpy_app_handlers.h"
 #include "bpy_driver.h"
 
+/* modules */
+#include "bpy_app_icons.h"
+
 #include "BLI_utildefines.h"
 
 #include "BKE_appdir.h"
@@ -117,6 +120,9 @@ static PyStructSequence_Field app_info_fields[] = {
 	{(char *)"build_options", (char *)"A set containing most important enabled optional build features"},
 	{(char *)"handlers", (char *)"Application handler callbacks"},
 	{(char *)"translations", (char *)"Application and addons internationalization API"},
+
+	/* Modules (not struct sequence). */
+	{(char *)"icons", (char *)"Manage custom icons"},
 	{NULL},
 };
 
@@ -129,6 +135,7 @@ PyDoc_STRVAR(bpy_app_doc,
 "   :maxdepth: 1\n"
 "\n"
 "   bpy.app.handlers.rst\n"
+"   bpy.app.icons.rst\n"
 "   bpy.app.translations.rst\n"
 );
 
@@ -210,6 +217,9 @@ static PyObject *make_app_info(void)
 	SetObjItem(BPY_app_handlers_struct());
 	SetObjItem(BPY_app_translations_struct());
 
+	/* modules */
+	SetObjItem(BPY_app_icons_module());
+
 #undef SetIntItem
 #undef SetStrItem
 #undef SetBytesItem
diff --git a/source/blender/python/intern/bpy_app_icons.c b/source/blender/python/intern/bpy_app_icons.c
new file mode 100644
index 00000000000..8aeee1aff9c
--- /dev/null
+++ b/source/blender/python/intern/bpy_app_icons.c
@@ -0,0 +1,134 @@
+/*
+ * ***** 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,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/python/intern/bpy_app_icons.c
+ *  \ingroup pythonintern
+ *
+ * Runtime defined icons.
+ */
+
+#include <Python.h>
+
+#include "MEM_guardedalloc.h"
+
+#include "BLI_utildefines.h"
+
+#include "BKE_icons.h"
+
+#include "../generic/py_capi_utils.h"
+
+#include "bpy_app_icons.h"
+
+/* We may want to load direct from file. */
+PyDoc_STRVAR(bpy_app_icons_new_triangles_doc,
+".. function:: new_triangles(coords, colors)"
+"\n"
+"   Create a new icon from triangle geometry.\n"
+"\n"
+"   :arg coords: Sequence of bytes (6 floats for one triangle) for (X, Y) coordinates.\n"
+"   :type coords: byte sequence\n"
+"   :arg colors: Sequence of ints (12 for one triangles) for RGBA.\n"
+"   :type colors: byte sequence\n"
+"   :return: Unique icon value (pass to interface ``icon_value`` argument).\n"
+"   :rtype: int\n"
+);
+static PyObject *bpy_app_icons_new_triangles(PyObject *UNUSED(self), PyObject *args)
+{
+	/* bytes */
+	PyObject *py_coords, *py_colors;
+	if (!PyArg_ParseTuple(args, "SS:new_triangles", &py_coords, &py_colors)) {
+		return NULL;
+	}
+
+	const int coords_len = PyBytes_GET_SIZE(py_coords);
+	const int tris_len = coords_len / 6;
+	if (tris_len * 6 != coords_len) {
+		PyErr_SetString(PyExc_ValueError, "coords must be multiple of 6");
+		return NULL;
+	}
+	if (PyBytes_GET_SIZE(py_colors) != 2 * coords_len) {
+		PyErr_SetString(PyExc_ValueError, "colors must be twice size of coords");
+		return NULL;
+	}
+
+	int coords_size = sizeof(uchar[2]) * tris_len * 3;
+	int colors_size = sizeof(uchar[4]) * tris_len * 3;
+	uchar (*coords)[2] = MEM_mallocN(coords_size, __func__);
+	uchar (*colors)[4] = MEM_mallocN(colors_size, __func__);
+
+	memcpy(coords, PyBytes_AS_STRING(py_coords), coords_size);
+	memcpy(colors, PyBytes_AS_STRING(py_colors), colors_size);
+
+	struct Icon_Geom *geom = MEM_mallocN(sizeof(*geom), __func__);
+	geom->coords_len = tris_len;
+	geom->coords = coords;
+	geom->colors = colors;
+	geom->icon_id = 0;
+	int icon_id = BKE_icon_geom_ensure(geom);
+	return PyLong_FromLong(icon_id);
+}
+
+PyDoc_STRVAR(bpy_app_icons_release_doc,
+".. function:: release(icon_id)"
+"\n"
+"   Release the icon.\n"
+);
+static PyObject *bpy_app_icons_release(PyObject *UNUSED(self), PyObject *args)
+{
+	int icon_id;
+	static _PyArg_Parser _parser = {"i:release", NULL, 0};
+	if (!_PyArg_ParseTupleAndKeywordsFast(
+	        args, NULL, &_parser,
+	        &icon_id))
+	{
+		return NULL;
+	}
+
+	if (!BKE_icon_delete_unmanaged(icon_id)) {
+		PyErr_SetString(PyExc_ValueError, "invalid icon_id");
+		return NULL;
+	}
+	Py_RETURN_NONE;
+}
+
+static struct PyMethodDef M_AppIcons_methods[] = {
+	{"new_triangles", (PyCFunction)bpy_app_icons_new_triangles, METH_VARARGS, bpy_app_icons_new_triangles_doc},
+	{"release", (PyCFunction)bpy_app_icons_release, METH_VARARGS, bpy_app_icons_release_doc},
+	{NULL, NULL, 0, NULL}
+};
+
+static struct PyModuleDef M_AppIcons_module_def = {
+	PyModuleDef_HEAD_INIT,
+	"bpy.app.icons",  /* m_name */
+	NULL,  /* m_doc */
+	0,     /* m_size */
+	M_AppIcons_methods,  /* m_methods */
+	NULL,  /* m_reload */
+	NULL,  /* m_traverse */
+	NULL,  /* m_clear */
+	NULL,  /* m_free */
+};
+
+PyObject *BPY_app_icons_module(void)
+{
+	PyObject *mod = PyModule_Create(&M_AppIcons_module_def);
+
+	return mod;
+}
diff --git a/source/blender/python/intern/bpy_app_icons.h b/source/blender/python/intern/bpy_app_icons.h
new file mode 100644
index 00000000000..309c7ed222f
--- /dev/null
+++ b/source/blender/python/intern/bpy_app_icons.h
@@ -0,0 +1,30 @@
+/*
+ * ***** 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,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/python/intern/bpy_app_icons.h
+ *  \ingroup pythonintern
+ */
+
+#ifndef __BPY_APP_ICONS_H__
+#define __BPY_APP_ICONS_H__
+
+PyObject *BPY_app_icons_module(void);
+
+#endif /* __BPY_APP_ICONS_H__ */