Merge branch 'master' into blender2.8
[blender.git] / source / blender / python / bmesh / bmesh_py_types.h
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.h
27  *  \ingroup pybmesh
28  */
29
30 #ifndef __BMESH_PY_TYPES_H__
31 #define __BMESH_PY_TYPES_H__
32
33 extern PyTypeObject BPy_BMesh_Type;
34 extern PyTypeObject BPy_BMVert_Type;
35 extern PyTypeObject BPy_BMEdge_Type;
36 extern PyTypeObject BPy_BMFace_Type;
37 extern PyTypeObject BPy_BMLoop_Type;
38
39 extern PyTypeObject BPy_BMElemSeq_Type;
40 extern PyTypeObject BPy_BMVertSeq_Type;
41 extern PyTypeObject BPy_BMEdgeSeq_Type;
42 extern PyTypeObject BPy_BMFaceSeq_Type;
43 extern PyTypeObject BPy_BMLoopSeq_Type;
44
45 extern PyTypeObject BPy_BMIter_Type;
46
47 #define BPy_BMesh_Check(v)      (Py_TYPE(v) == &BPy_BMesh_Type)
48 #define BPy_BMVert_Check(v)     (Py_TYPE(v) == &BPy_BMVert_Type)
49 #define BPy_BMEdge_Check(v)     (Py_TYPE(v) == &BPy_BMEdge_Type)
50 #define BPy_BMFace_Check(v)     (Py_TYPE(v) == &BPy_BMFace_Type)
51 #define BPy_BMLoop_Check(v)     (Py_TYPE(v) == &BPy_BMLoop_Type)
52 #define BPy_BMElemSeq_Check(v)  (Py_TYPE(v) == &BPy_BMElemSeq_Type)
53 #define BPy_BMVertSeq_Check(v)  (Py_TYPE(v) == &BPy_BMVertSeq_Type)
54 #define BPy_BMEdgeSeq_Check(v)  (Py_TYPE(v) == &BPy_BMEdgeSeq_Type)
55 #define BPy_BMFaceSeq_Check(v)  (Py_TYPE(v) == &BPy_BMFaceSeq_Type)
56 #define BPy_BMLoopSeq_Check(v)  (Py_TYPE(v) == &BPy_BMLoopSeq_Type)
57 #define BPy_BMIter_Check(v)     (Py_TYPE(v) == &BPy_BMIter_Type)
58 /* trick since we know they share a hash function */
59 #define BPy_BMElem_Check(v)     (Py_TYPE(v)->tp_hash == BPy_BMVert_Type.tp_hash)
60
61 /* cast from _any_ bmesh type - they all have BMesh first */
62 typedef struct BPy_BMGeneric {
63         PyObject_VAR_HEAD
64         struct BMesh *bm; /* keep first */
65 } BPy_BMGeneric;
66
67 /* BPy_BMVert/BPy_BMEdge/BPy_BMFace/BPy_BMLoop can cast to this */
68 typedef struct BPy_BMElem {
69         PyObject_VAR_HEAD
70         struct BMesh *bm; /* keep first */
71         struct BMElem *ele;
72 } BPy_BMElem;
73
74 typedef struct BPy_BMesh {
75         PyObject_VAR_HEAD
76         struct BMesh *bm; /* keep first */
77         int flag;
78 } BPy_BMesh;
79
80 /* element types */
81 typedef struct BPy_BMVert {
82         PyObject_VAR_HEAD
83         struct BMesh *bm; /* keep first */
84         struct BMVert *v;
85 } BPy_BMVert;
86
87 typedef struct BPy_BMEdge {
88         PyObject_VAR_HEAD
89         struct BMesh *bm; /* keep first */
90         struct BMEdge *e;
91 } BPy_BMEdge;
92
93 typedef struct BPy_BMFace {
94         PyObject_VAR_HEAD
95         struct BMesh *bm; /* keep first */
96         struct BMFace *f;
97 } BPy_BMFace;
98
99 typedef struct BPy_BMLoop {
100         PyObject_VAR_HEAD
101         struct BMesh *bm; /* keep first */
102         struct BMLoop *l;
103 } BPy_BMLoop;
104
105
106 /* iterators */
107
108 /* used for ...
109  * - BPy_BMElemSeq_Type
110  * - BPy_BMVertSeq_Type
111  * - BPy_BMEdgeSeq_Type
112  * - BPy_BMFaceSeq_Type
113  * - BPy_BMLoopSeq_Type
114  */
115 typedef struct BPy_BMElemSeq {
116         PyObject_VAR_HEAD
117         struct BMesh *bm; /* keep first */
118
119         /* if this is a sequence on an existing element,
120          * loops of faces for eg.
121          * If this variable is set, it will be used */
122
123         /* we hold a reference to this.
124          * check in case the owner becomes invalid on access */
125         /* TODO - make this a GC'd object!, will function OK without this though */
126         BPy_BMElem *py_ele;
127
128         /* iterator type */
129         short itype;
130 } BPy_BMElemSeq;
131
132 typedef struct BPy_BMIter {
133         PyObject_VAR_HEAD
134         struct BMesh *bm; /* keep first */
135         BMIter iter;
136 } BPy_BMIter;
137
138 void BPy_BM_init_types(void);
139
140 PyObject *BPyInit_bmesh_types(void);
141
142 enum {
143         BPY_BMFLAG_NOP = 0,       /* do nothing */
144         BPY_BMFLAG_IS_WRAPPED = 1 /* the mesh is owned by editmode */
145 };
146
147 PyObject *BPy_BMesh_CreatePyObject(BMesh *bm, int flag);
148 PyObject *BPy_BMVert_CreatePyObject(BMesh *bm, BMVert *v);
149 PyObject *BPy_BMEdge_CreatePyObject(BMesh *bm, BMEdge *e);
150 PyObject *BPy_BMFace_CreatePyObject(BMesh *bm, BMFace *f);
151 PyObject *BPy_BMLoop_CreatePyObject(BMesh *bm, BMLoop *l);
152 PyObject *BPy_BMElemSeq_CreatePyObject(BMesh *bm, BPy_BMElem *py_ele, const char itype);
153 PyObject *BPy_BMVertSeq_CreatePyObject(BMesh *bm);
154 PyObject *BPy_BMEdgeSeq_CreatePyObject(BMesh *bm);
155 PyObject *BPy_BMFaceSeq_CreatePyObject(BMesh *bm);
156 PyObject *BPy_BMLoopSeq_CreatePyObject(BMesh *bm);
157 PyObject *BPy_BMIter_CreatePyObject(BMesh *bm);
158
159 PyObject *BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele); /* just checks type and creates v/e/f/l */
160
161 void *BPy_BMElem_PySeq_As_Array_FAST(
162         BMesh **r_bm, PyObject *seq_fast, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_size,
163         const char htype,
164         const bool do_unique_check, const bool do_bm_check,
165         const char *error_prefix);
166 void *BPy_BMElem_PySeq_As_Array(
167         BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_size,
168         const char htype,
169         const bool do_unique_check, const bool do_bm_check,
170         const char *error_prefix);
171
172 PyObject *BPy_BMElem_Array_As_Tuple(BMesh *bm, BMHeader **elem, Py_ssize_t elem_len);
173 PyObject *BPy_BMVert_Array_As_Tuple(BMesh *bm, BMVert **elem, Py_ssize_t elem_len);
174 PyObject *BPy_BMEdge_Array_As_Tuple(BMesh *bm, BMEdge **elem, Py_ssize_t elem_len);
175 PyObject *BPy_BMFace_Array_As_Tuple(BMesh *bm, BMFace **elem, Py_ssize_t elem_len);
176 PyObject *BPy_BMLoop_Array_As_Tuple(BMesh *bm, BMLoop **elem, Py_ssize_t elem_len);
177
178 int       BPy_BMElem_CheckHType(PyTypeObject *type, const char htype);
179 char     *BPy_BMElem_StringFromHType_ex(const char htype, char ret[32]);
180 char     *BPy_BMElem_StringFromHType(const char htype);
181
182 // void bpy_bm_generic_invalidate(BPy_BMGeneric *self);
183 int  bpy_bm_generic_valid_check(BPy_BMGeneric *self);
184 int  bpy_bm_generic_valid_check_source(BMesh *bm_source, const char *error_prefix, void **args, unsigned int args_n) ATTR_NONNULL(1, 2);
185
186 #define BPY_BM_CHECK_OBJ(obj) \
187         if (UNLIKELY(bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1)) { return NULL; } (void)0
188 #define BPY_BM_CHECK_INT(obj) \
189         if (UNLIKELY(bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1)) { return -1; }   (void)0
190
191 /* macros like BPY_BM_CHECK_OBJ/BPY_BM_CHECK_INT that ensure we're from the right BMesh */
192 #define BPY_BM_CHECK_SOURCE_OBJ(bm, errmsg, ...)  { \
193         void *_args[] = {__VA_ARGS__}; \
194         if (UNLIKELY(bpy_bm_generic_valid_check_source(bm, errmsg, _args, ARRAY_SIZE(_args)) == -1)) { \
195                 return NULL; \
196         } \
197 } (void)0
198 #define BPY_BM_CHECK_SOURCE_INT(bm, errmsg, ...)  { \
199         void *_args[] = {__VA_ARGS__}; \
200         if (UNLIKELY(bpy_bm_generic_valid_check_source(bm, errmsg, _args, ARRAY_SIZE(_args)) == -1)) { \
201                 return -1; \
202         } \
203 } (void)0
204
205 #define BPY_BM_IS_VALID(obj) (LIKELY((obj)->bm != NULL))
206
207 #define BM_ITER_BPY_BM_SEQ(ele, iter, bpy_bmelemseq)                \
208         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(              \
209                      iter,                                              \
210                      (bpy_bmelemseq)->bm,                               \
211                      (bpy_bmelemseq)->itype,                            \
212                      (bpy_bmelemseq)->py_ele ?                          \
213                          ((BPy_BMElem *)(bpy_bmelemseq)->py_ele)->ele : \
214                          NULL                                           \
215                      );                                                 \
216              ele;                                                       \
217              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
218
219
220 #ifdef __PY_CAPI_UTILS_H__
221 struct PyC_FlagSet;
222 extern struct PyC_FlagSet bpy_bm_scene_vert_edge_face_flags[];
223 extern struct PyC_FlagSet bpy_bm_htype_vert_edge_face_flags[];
224 extern struct PyC_FlagSet bpy_bm_htype_all_flags[];
225 extern struct PyC_FlagSet bpy_bm_hflag_all_flags[];
226 #endif
227
228 #endif /* __BMESH_PY_TYPES_H__ */