bmesh docs:
[blender.git] / source / blender / python / bmesh / bmesh_py_types_meshdata.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2012 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Campbell Barton
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/python/bmesh/bmesh_py_types_meshdata.c
27  *  \ingroup pybmesh
28  *
29  * This file defines customdata types which can't be accessed as primitive
30  * python types such as MDeformVert, MLoopUV, MTexPoly
31  */
32
33 #include <Python.h>
34
35 #include "../mathutils/mathutils.h"
36
37 #include "DNA_meshdata_types.h"
38
39 #include "BLI_utildefines.h"
40 #include "BLI_math_vector.h"
41
42 /* Mesh Loop UV
43  * ************ */
44
45 #define BPy_BMLoopUV_Check(v)  (Py_TYPE(v) == &BPy_BMLoopUV_Type)
46
47 typedef struct BPy_BMLoopUV {
48         PyObject_VAR_HEAD
49         MLoopUV *data;
50 } BPy_BMLoopUV;
51
52 PyDoc_STRVAR(bpy_bmloopuv_uv_doc,
53 "Loops UV (as a 2D Vector).\n\n:type: :class:`mathutils.Vector`"
54 );
55 static PyObject *bpy_bmloopuv_uv_get(BPy_BMLoopUV *self, void *UNUSED(closure))
56 {
57         return Vector_CreatePyObject(self->data->uv, 2, Py_WRAP, NULL);
58 }
59
60 static int bpy_bmloopuv_uv_set(BPy_BMLoopUV *self, PyObject *value, void *UNUSED(closure))
61 {
62         float tvec[2];
63         if (mathutils_array_parse(tvec, 2, 2, value, "BMLoopUV.uv") != -1) {
64                 copy_v2_v2(self->data->uv, tvec);
65                 return 0;
66         }
67         else {
68                 return -1;
69         }
70 }
71
72 PyDoc_STRVAR(bpy_bmloopuv_flag__pin_uv_doc,
73 "UV pin state.\n\n:type: boolean"
74 );
75 PyDoc_STRVAR(bpy_bmloopuv_flag__select_doc,
76 "UV select state.\n\n:type: boolean"
77 );
78 PyDoc_STRVAR(bpy_bmloopuv_flag__select_edge_doc,
79 "UV edge select state.\n\n:type: boolean"
80 );
81
82
83 static PyObject *bpy_bmloopuv_flag_get(BPy_BMLoopUV *self, void *flag_p)
84 {
85         const int flag = GET_INT_FROM_POINTER(flag_p);
86         return PyBool_FromLong(self->data->flag & flag);
87 }
88
89 static int bpy_bmloopuv_flag_set(BPy_BMLoopUV *self, PyObject *value, void *flag_p)
90 {
91         const int flag = GET_INT_FROM_POINTER(flag_p);
92
93         switch (PyLong_AsLong(value)) {
94                 case TRUE:
95                         self->data->flag |= flag;
96                         return 0;
97                 case FALSE:
98                         self->data->flag &= ~flag;
99                         return 0;
100                 default:
101                         PyErr_SetString(PyExc_TypeError,
102                                         "expected a boolean type 0/1");
103                         return -1;
104         }
105 }
106
107 static PyGetSetDef bpy_bmloopuv_getseters[] = {
108     /* attributes match rna_def_mloopuv  */
109     {(char *)"uv",          (getter)bpy_bmloopuv_uv_get,   (setter)bpy_bmloopuv_uv_set,   (char *)bpy_bmloopuv_uv_doc, NULL},
110     {(char *)"pin_uv",      (getter)bpy_bmloopuv_flag_get, (setter)bpy_bmloopuv_flag_set, (char *)bpy_bmloopuv_flag__pin_uv_doc, (void *)MLOOPUV_PINNED},
111     {(char *)"select",      (getter)bpy_bmloopuv_flag_get, (setter)bpy_bmloopuv_flag_set, (char *)bpy_bmloopuv_flag__select_doc, (void *)MLOOPUV_VERTSEL},
112     {(char *)"select_edge", (getter)bpy_bmloopuv_flag_get, (setter)bpy_bmloopuv_flag_set, (char *)bpy_bmloopuv_flag__select_edge_doc, (void *)MLOOPUV_EDGESEL},
113
114     {NULL, NULL, NULL, NULL, NULL} /* Sentinel */
115 };
116
117 PyTypeObject BPy_BMLoopUV_Type = {{{0}}}; /* bm.loops.layers.uv.active */
118
119 static void bm_init_types_bmloopuv(void)
120 {
121         BPy_BMLoopUV_Type.tp_basicsize = sizeof(BPy_BMLoopUV);
122
123         BPy_BMLoopUV_Type.tp_name = "BMLoopUV";
124
125         BPy_BMLoopUV_Type.tp_doc = NULL; // todo
126
127         BPy_BMLoopUV_Type.tp_getset = bpy_bmloopuv_getseters;
128
129         BPy_BMLoopUV_Type.tp_flags = Py_TPFLAGS_DEFAULT;
130
131         PyType_Ready(&BPy_BMLoopUV_Type);
132 }
133
134 int BPy_BMLoopUV_AssignPyObject(struct MLoopUV *mloopuv, PyObject *value)
135 {
136         if (UNLIKELY(!BPy_BMLoopUV_Check(value))) {
137                 PyErr_Format(PyExc_TypeError, "expected BMLoopUV, not a %.200s", Py_TYPE(value)->tp_name);
138                 return -1;
139         }
140         else {
141                 *((MLoopUV *)mloopuv) = *((MLoopUV *)((BPy_BMLoopUV *)value)->data);
142                 return 0;
143         }
144 }
145
146 PyObject *BPy_BMLoopUV_CreatePyObject(struct MLoopUV *mloopuv)
147 {
148         BPy_BMLoopUV *self = PyObject_New(BPy_BMLoopUV, &BPy_BMLoopUV_Type);
149         self->data = mloopuv;
150         return (PyObject *)self;
151 }
152
153 /* --- End Mesh Loop UV --- */
154
155 /* Mesh Loop Color
156  * *************** */
157
158 /* This simply provices a color wrapper for
159  * color which uses mathutils callbacks for mathutils.Color
160  */
161
162 #define MLOOPCOL_FROM_CAPSULE(color_capsule)  \
163         ((MLoopCol *)PyCapsule_GetPointer(color_capsule, NULL))
164
165 static void mloopcol_to_float(const MLoopCol *mloopcol, float col_r[3])
166 {
167         rgb_uchar_to_float(col_r, (unsigned char *)&mloopcol->r);
168 }
169
170 static void mloopcol_from_float(MLoopCol *mloopcol, const float col[3])
171 {
172         rgb_float_to_uchar((unsigned char *)&mloopcol->r, col);
173 }
174
175 static unsigned char mathutils_bmloopcol_cb_index = -1;
176
177 static int mathutils_bmloopcol_check(BaseMathObject *UNUSED(bmo))
178 {
179         /* always ok */
180         return 0;
181 }
182
183 static int mathutils_bmloopcol_get(BaseMathObject *bmo, int UNUSED(subtype))
184 {
185         MLoopCol *mloopcol = MLOOPCOL_FROM_CAPSULE(bmo->cb_user);
186         mloopcol_to_float(mloopcol, bmo->data);
187         return 0;
188 }
189
190 static int mathutils_bmloopcol_set(BaseMathObject *bmo, int UNUSED(subtype))
191 {
192         MLoopCol *mloopcol = MLOOPCOL_FROM_CAPSULE(bmo->cb_user);
193         mloopcol_from_float(mloopcol, bmo->data);
194         return 0;
195 }
196
197 static int mathutils_bmloopcol_get_index(BaseMathObject *bmo, int subtype, int UNUSED(index))
198 {
199         /* lazy, avoid repeteing the case statement */
200         if (mathutils_bmloopcol_get(bmo, subtype) == -1)
201                 return -1;
202         return 0;
203 }
204
205 static int mathutils_bmloopcol_set_index(BaseMathObject *bmo, int subtype, int index)
206 {
207         const float f = bmo->data[index];
208
209         /* lazy, avoid repeteing the case statement */
210         if (mathutils_bmloopcol_get(bmo, subtype) == -1)
211                 return -1;
212
213         bmo->data[index] = f;
214         return mathutils_bmloopcol_set(bmo, subtype);
215 }
216
217 Mathutils_Callback mathutils_bmloopcol_cb = {
218         mathutils_bmloopcol_check,
219         mathutils_bmloopcol_get,
220         mathutils_bmloopcol_set,
221         mathutils_bmloopcol_get_index,
222         mathutils_bmloopcol_set_index
223 };
224
225 static void bm_init_types_bmloopcol(void)
226 {
227         /* pass */
228         mathutils_bmloopcol_cb_index = Mathutils_RegisterCallback(&mathutils_bmloopcol_cb);
229 }
230
231 int BPy_BMLoopColor_AssignPyObject(struct MLoopCol *mloopcol, PyObject *value)
232 {
233         float tvec[3];
234         if (mathutils_array_parse(tvec, 3, 3, value, "BMLoopCol") != -1) {
235                 mloopcol_from_float(mloopcol, tvec);
236                 return 0;
237         }
238         else {
239                 return -1;
240         }
241 }
242
243 PyObject *BPy_BMLoopColor_CreatePyObject(struct MLoopCol *data)
244 {
245         PyObject *color_capsule;
246         color_capsule = PyCapsule_New(data, NULL, NULL);
247         return Color_CreatePyObject_cb(color_capsule, mathutils_bmloopcol_cb_index, 0);
248 }
249
250 #undef MLOOPCOL_FROM_CAPSULE
251
252 /* --- End Mesh Loop Color --- */
253
254
255 /* call to init all types */
256 void BPy_BM_init_types_meshdata(void)
257 {
258         bm_init_types_bmloopuv();
259         bm_init_types_bmloopcol();
260 }