Blender V5.3
bmesh_py_types.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2012 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <Python.h>
12
13#include "bmesh.hh"
14
15namespace blender {
16
17struct BMesh;
18struct BMEdge;
19struct BMElem;
20struct BMFace;
21struct BMLoop;
22struct BMVert;
23
24extern PyTypeObject BPy_BMesh_Type;
25extern PyTypeObject BPy_BMVert_Type;
26extern PyTypeObject BPy_BMEdge_Type;
27extern PyTypeObject BPy_BMFace_Type;
28extern PyTypeObject BPy_BMLoop_Type;
29
30extern PyTypeObject BPy_BMElemSeq_Type;
31extern PyTypeObject BPy_BMVertSeq_Type;
32extern PyTypeObject BPy_BMEdgeSeq_Type;
33extern PyTypeObject BPy_BMFaceSeq_Type;
34extern PyTypeObject BPy_BMLoopSeq_Type;
35
36extern PyTypeObject BPy_BMIter_Type;
37
38#define BPy_BMesh_Check(v) (Py_TYPE(v) == &BPy_BMesh_Type)
39#define BPy_BMVert_Check(v) (Py_TYPE(v) == &BPy_BMVert_Type)
40#define BPy_BMEdge_Check(v) (Py_TYPE(v) == &BPy_BMEdge_Type)
41#define BPy_BMFace_Check(v) (Py_TYPE(v) == &BPy_BMFace_Type)
42#define BPy_BMLoop_Check(v) (Py_TYPE(v) == &BPy_BMLoop_Type)
43#define BPy_BMElemSeq_Check(v) (Py_TYPE(v) == &BPy_BMElemSeq_Type)
44#define BPy_BMVertSeq_Check(v) (Py_TYPE(v) == &BPy_BMVertSeq_Type)
45#define BPy_BMEdgeSeq_Check(v) (Py_TYPE(v) == &BPy_BMEdgeSeq_Type)
46#define BPy_BMFaceSeq_Check(v) (Py_TYPE(v) == &BPy_BMFaceSeq_Type)
47#define BPy_BMLoopSeq_Check(v) (Py_TYPE(v) == &BPy_BMLoopSeq_Type)
48#define BPy_BMIter_Check(v) (Py_TYPE(v) == &BPy_BMIter_Type)
49/* trick since we know they share a hash function */
50#define BPy_BMElem_Check(v) (Py_TYPE(v)->tp_hash == BPy_BMVert_Type.tp_hash)
51
52/* cast from _any_ bmesh type - they all have BMesh first */
54 PyObject_HEAD
55 BMesh *bm; /* keep first */
56};
57
58/* BPy_BMVert/BPy_BMEdge/BPy_BMFace/BPy_BMLoop can cast to this */
59struct BPy_BMElem {
60 PyObject_HEAD
61 BMesh *bm; /* keep first */
63};
64
65struct BPy_BMesh {
66 PyObject_HEAD
67 BMesh *bm; /* keep first */
68 int flag;
69};
70
71/* element types */
72struct BPy_BMVert {
73 PyObject_HEAD
74 BMesh *bm; /* keep first */
76};
77
78struct BPy_BMEdge {
79 PyObject_HEAD
80 BMesh *bm; /* keep first */
82};
83
84struct BPy_BMFace {
85 PyObject_HEAD
86 BMesh *bm; /* keep first */
88};
89
90struct BPy_BMLoop {
91 PyObject_HEAD
92 BMesh *bm; /* keep first */
94};
95
96/* iterators */
97
98/* used for ...
99 * - BPy_BMElemSeq_Type
100 * - BPy_BMVertSeq_Type
101 * - BPy_BMEdgeSeq_Type
102 * - BPy_BMFaceSeq_Type
103 * - BPy_BMLoopSeq_Type
104 */
106 PyObject_HEAD
107 BMesh *bm; /* keep first */
108
109 /* if this is a sequence on an existing element,
110 * loops of faces for eg.
111 * If this variable is set, it will be used */
112
113 /* we hold a reference to this.
114 * check in case the owner becomes invalid on access */
115 /* TODO: make this a GC'd object!, will function OK without this though. */
117
118 /* iterator type */
119 short itype;
120};
121
123 PyObject_HEAD
124 BMesh *bm; /* keep first */
126};
127
128void BPy_BM_init_types();
129
130[[nodiscard]] PyObject *BPyInit_bmesh_types();
131
132enum {
133 BPY_BMFLAG_NOP = 0, /* do nothing */
134 BPY_BMFLAG_IS_WRAPPED = 1, /* the mesh is owned by editmode */
135};
136
137[[nodiscard]] PyObject *BPy_BMesh_CreatePyObject(BMesh *bm, int flag);
138[[nodiscard]] PyObject *BPy_BMVert_CreatePyObject(BMesh *bm, BMVert *v);
139[[nodiscard]] PyObject *BPy_BMEdge_CreatePyObject(BMesh *bm, BMEdge *e);
140[[nodiscard]] PyObject *BPy_BMFace_CreatePyObject(BMesh *bm, BMFace *f);
141[[nodiscard]] PyObject *BPy_BMLoop_CreatePyObject(BMesh *bm, BMLoop *l);
142[[nodiscard]] PyObject *BPy_BMElemSeq_CreatePyObject(BMesh *bm, BPy_BMElem *py_ele, char itype);
143[[nodiscard]] PyObject *BPy_BMVertSeq_CreatePyObject(BMesh *bm);
144[[nodiscard]] PyObject *BPy_BMEdgeSeq_CreatePyObject(BMesh *bm);
145[[nodiscard]] PyObject *BPy_BMFaceSeq_CreatePyObject(BMesh *bm);
146[[nodiscard]] PyObject *BPy_BMLoopSeq_CreatePyObject(BMesh *bm);
147[[nodiscard]] PyObject *BPy_BMIter_CreatePyObject(BMesh *bm);
148
150[[nodiscard]] PyObject *BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele);
151
158[[nodiscard]] void *BPy_BMElem_PySeq_As_Array_FAST(BMesh **r_bm,
159 PyObject *seq_fast,
160 Py_ssize_t min,
161 Py_ssize_t max,
162 Py_ssize_t *r_seq_num,
163 char htype,
164 bool do_unique_check,
165 bool do_bm_check,
166 const char *error_prefix);
167[[nodiscard]] void *BPy_BMElem_PySeq_As_Array(BMesh **r_bm,
168 PyObject *seq,
169 Py_ssize_t min,
170 Py_ssize_t max,
171 Py_ssize_t *r_seq_num,
172 char htype,
173 bool do_unique_check,
174 bool do_bm_check,
175 const char *error_prefix);
176
177[[nodiscard]] BMVert **BPy_BMVert_PySeq_As_Array(BMesh **r_bm,
178 PyObject *seq,
179 Py_ssize_t min,
180 Py_ssize_t max,
181 Py_ssize_t *r_seq_num,
182 bool do_unique_check,
183 bool do_bm_check,
184 const char *error_prefix);
185[[nodiscard]] BMEdge **BPy_BMEdge_PySeq_As_Array(BMesh **r_bm,
186 PyObject *seq,
187 Py_ssize_t min,
188 Py_ssize_t max,
189 Py_ssize_t *r_seq_num,
190 bool do_unique_check,
191 bool do_bm_check,
192 const char *error_prefix);
193[[nodiscard]] BMFace **BPy_BMFace_PySeq_As_Array(BMesh **r_bm,
194 PyObject *seq,
195 Py_ssize_t min,
196 Py_ssize_t max,
197 Py_ssize_t *r_seq_num,
198 bool do_unique_check,
199 bool do_bm_check,
200 const char *error_prefix);
201[[nodiscard]] BMLoop **BPy_BMLoop_PySeq_As_Array(BMesh **r_bm,
202 PyObject *seq,
203 Py_ssize_t min,
204 Py_ssize_t max,
205 Py_ssize_t *r_seq_num,
206 bool do_unique_check,
207 bool do_bm_check,
208 const char *error_prefix);
209
210[[nodiscard]] PyObject *BPy_BMElem_Array_As_Tuple(BMesh *bm, BMHeader **elem, Py_ssize_t elem_num);
211[[nodiscard]] PyObject *BPy_BMVert_Array_As_Tuple(BMesh *bm, BMVert **elem, Py_ssize_t elem_num);
212[[nodiscard]] PyObject *BPy_BMEdge_Array_As_Tuple(BMesh *bm, BMEdge **elem, Py_ssize_t elem_num);
213[[nodiscard]] PyObject *BPy_BMFace_Array_As_Tuple(BMesh *bm, BMFace **elem, Py_ssize_t elem_num);
214[[nodiscard]] PyObject *BPy_BMLoop_Array_As_Tuple(BMesh *bm,
215 BMLoop *const *elem,
216 Py_ssize_t elem_num);
217
218[[nodiscard]] int BPy_BMElem_CheckHType(PyTypeObject *type, char htype);
224[[nodiscard]] char *BPy_BMElem_StringFromHType_ex(char htype, char ret[32]);
225[[nodiscard]] char *BPy_BMElem_StringFromHType(char htype);
226
227// void bpy_bm_generic_invalidate(BPy_BMGeneric *self);
228[[nodiscard]] int bpy_bm_generic_valid_check(BPy_BMGeneric *self);
229[[nodiscard]] int bpy_bm_generic_valid_check_source(BMesh *bm_source,
230 const char *error_prefix,
231 void **args,
232 uint args_tot) ATTR_NONNULL(1, 2);
233[[nodiscard]] int bpy_bm_check_uv_select_sync_valid(BMesh *bm, const char *error_prefix);
234[[nodiscard]] int bpy_bm_uv_layer_offset_or_error(BMesh *bm, const char *error_prefix);
235[[nodiscard]] int bpy_bm_check_bm_match_or_error(BMesh *bm_a,
236 BMesh *bm_b,
237 const char *error_prefix);
238
239#define BPY_BM_CHECK_OBJ(obj) \
240 if (bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1) [[unlikely]] { \
241 return NULL; \
242 } \
243 (void)0
244#define BPY_BM_CHECK_INT(obj) \
245 if (bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1) [[unlikely]] { \
246 return -1; \
247 } \
248 (void)0
249
253#define BPY_BM_CHECK_SOURCE_OBJ(bm, errmsg, ...) \
254 { \
255 void *_args[] = {__VA_ARGS__}; \
256 if (bpy_bm_generic_valid_check_source(bm, errmsg, _args, ARRAY_SIZE(_args)) == -1) \
257 [[unlikely]] \
258 { \
259 return NULL; \
260 } \
261 } \
262 (void)0
263#define BPY_BM_CHECK_SOURCE_INT(bm, errmsg, ...) \
264 { \
265 void *_args[] = {__VA_ARGS__}; \
266 if (bpy_bm_generic_valid_check_source(bm, errmsg, _args, ARRAY_SIZE(_args)) == -1) \
267 [[unlikely]] \
268 { \
269 return -1; \
270 } \
271 } \
272 (void)0
273
274#define BPY_BM_IS_VALID(obj) (LIKELY((obj)->bm != NULL))
275
276#define BM_ITER_BPY_BM_SEQ(ele, iter, bpy_bmelemseq) \
277 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new( \
278 iter, \
279 (bpy_bmelemseq)->bm, \
280 (bpy_bmelemseq)->itype, \
281 (bpy_bmelemseq)->py_ele ? ((BPy_BMElem *)(bpy_bmelemseq)->py_ele)->ele : NULL); \
282 ele; \
283 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
284
285} // namespace blender
#define ATTR_NONNULL(...)
btScalar max
BMesh Iterators.
int bpy_bm_uv_layer_offset_or_error(BMesh *bm, const char *error_prefix)
void * BPy_BMElem_PySeq_As_Array_FAST(BMesh **r_bm, PyObject *seq_fast, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, const char htype, const bool do_unique_check, const bool do_bm_check, const char *error_prefix)
int bpy_bm_check_bm_match_or_error(BMesh *bm_a, BMesh *bm_b, const char *error_prefix)
PyTypeObject BPy_BMLoop_Type
PyTypeObject BPy_BMVertSeq_Type
BMEdge ** BPy_BMEdge_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, bool do_unique_check, bool do_bm_check, const char *error_prefix)
unsigned int uint
Definition BKE_text.h:55
ATTR_WARN_UNUSED_RESULT const BMLoop * l
PyTypeObject BPy_BMVert_Type
BMVert ** BPy_BMVert_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, bool do_unique_check, bool do_bm_check, const char *error_prefix)
PyObject * BPy_BMElem_Array_As_Tuple(BMesh *bm, BMHeader **elem, Py_ssize_t elem_num)
PyObject * BPy_BMLoop_CreatePyObject(BMesh *bm, BMLoop *l)
PyObject * BPy_BMLoop_Array_As_Tuple(BMesh *bm, BMLoop *const *elem, Py_ssize_t elem_num)
char * BPy_BMElem_StringFromHType(const char htype)
int BPy_BMElem_CheckHType(PyTypeObject *type, const char htype)
PyObject * BPyInit_bmesh_types()
ATTR_WARN_UNUSED_RESULT const BMVert * v
PyTypeObject BPy_BMLoopSeq_Type
PyObject * BPy_BMLoopSeq_CreatePyObject(BMesh *bm)
PyTypeObject BPy_BMFace_Type
int bpy_bm_generic_valid_check(BPy_BMGeneric *self)
PyTypeObject BPy_BMesh_Type
BMesh const char itype
PyTypeObject BPy_BMEdgeSeq_Type
PyTypeObject BPy_BMFaceSeq_Type
PyObject * BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele)
PyObject * BPy_BMVert_CreatePyObject(BMesh *bm, BMVert *v)
PyTypeObject BPy_BMIter_Type
PyTypeObject BPy_BMElemSeq_Type
PyObject * BPy_BMEdge_Array_As_Tuple(BMesh *bm, BMEdge **elem, Py_ssize_t elem_num)
void BPy_BM_init_types()
PyObject * BPy_BMFace_Array_As_Tuple(BMesh *bm, BMFace **elem, Py_ssize_t elem_num)
PyObject * BPy_BMFaceSeq_CreatePyObject(BMesh *bm)
int bpy_bm_generic_valid_check_source(BMesh *bm_source, const char *error_prefix, void **args, uint args_tot)
PyObject * BPy_BMVertSeq_CreatePyObject(BMesh *bm)
char * BPy_BMElem_StringFromHType_ex(const char htype, char ret[32])
PyObject * BPy_BMElemSeq_CreatePyObject(BMesh *bm, BPy_BMElem *py_ele, const char itype)
PyObject * BPy_BMesh_CreatePyObject(BMesh *bm, int flag)
PyObject * BPy_BMVert_Array_As_Tuple(BMesh *bm, BMVert **elem, Py_ssize_t elem_num)
int bpy_bm_check_uv_select_sync_valid(BMesh *bm, const char *error_prefix)
void * BPy_BMElem_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, const char htype, const bool do_unique_check, const bool do_bm_check, const char *error_prefix)
PyObject * BPy_BMIter_CreatePyObject(BMesh *bm)
PyTypeObject BPy_BMEdge_Type
PyObject * BPy_BMEdgeSeq_CreatePyObject(BMesh *bm)
BMFace ** BPy_BMFace_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, bool do_unique_check, bool do_bm_check, const char *error_prefix)
BMLoop ** BPy_BMLoop_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_seq_num, bool do_unique_check, bool do_bm_check, const char *error_prefix)
ATTR_WARN_UNUSED_RESULT const BMVert const BMEdge * e
@ BPY_BMFLAG_IS_WRAPPED
PyObject * BPy_BMEdge_CreatePyObject(BMesh *bm, BMEdge *e)
PyObject * BPy_BMFace_CreatePyObject(BMesh *bm, BMFace *f)
#define min(a, b)
Definition sort.cc:38
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm