Blender V5.3
bmesh_py_types_select.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2012 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
14
15#include <Python.h>
16
17#include "BLI_listbase.hh"
18#include "BLI_utildefines.hh"
19
20#include "bmesh.hh"
21
22#include "bmesh_py_types.hh"
24
26
27namespace blender {
28
30 /* Wrap. */
31 bpy_bmeditselseq_active_doc,
32 "The last selected element or None (read-only).\n"
33 "\n"
34 ":type: :class:`bmesh.types.BMVert` | "
35 ":class:`bmesh.types.BMEdge` | :class:`bmesh.types.BMFace` | None\n");
36static PyObject *bpy_bmeditselseq_active_get(BPy_BMEditSelSeq *self, void * /*closure*/)
37{
38 BMEditSelection *ese;
39 BPY_BM_CHECK_OBJ(self);
40
41 if ((ese = self->bm->selected.last())) {
42 return BPy_BMElem_CreatePyObject(self->bm, &ese->ele->head);
43 }
44
45 Py_RETURN_NONE;
46}
47
48static PyGetSetDef bpy_bmeditselseq_getseters[] = {
49 {"active",
50 reinterpret_cast<getter>(bpy_bmeditselseq_active_get),
51 static_cast<setter>(nullptr),
52 bpy_bmeditselseq_active_doc,
53 nullptr},
54 {nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
55};
56
58 /* Wrap. */
59 bpy_bmeditselseq_validate_doc,
60 ".. method:: validate()\n"
61 "\n"
62 " Ensures all elements in the selection history are selected.\n");
64{
65 BPY_BM_CHECK_OBJ(self);
67 Py_RETURN_NONE;
68}
69
71 /* Wrap. */
72 bpy_bmeditselseq_clear_doc,
73 ".. method:: clear()\n"
74 "\n"
75 " Empties the selection history.\n");
77{
78 BPY_BM_CHECK_OBJ(self);
80 Py_RETURN_NONE;
81}
82
84 /* Wrap. */
85 bpy_bmeditselseq_add_doc,
86 ".. method:: add(element)\n"
87 "\n"
88 " Add an element to the selection history (no action taken if its already added).\n"
89 "\n"
90 " :param element: The element to add.\n"
91 " :type element: :class:`BMVert` | :class:`BMEdge` | :class:`BMFace`\n");
92static PyObject *bpy_bmeditselseq_add(BPy_BMEditSelSeq *self, BPy_BMElem *value)
93{
94 const char *error_prefix = "select_history.add(...)";
95 BPY_BM_CHECK_OBJ(self);
96
97 if ((BPy_BMVert_Check(value) || BPy_BMEdge_Check(value) || BPy_BMFace_Check(value)) == false) {
98 PyErr_Format(PyExc_TypeError,
99 "%s: expected a BMVert/BMedge/BMFace not a %.200s",
100 error_prefix,
101 Py_TYPE(value)->tp_name);
102 return nullptr;
103 }
104
105 BPY_BM_CHECK_SOURCE_OBJ(self->bm, error_prefix, value);
106
107 BM_select_history_store(self->bm, value->ele);
108
109 Py_RETURN_NONE;
110}
111
113 /* Wrap. */
114 bpy_bmeditselseq_remove_doc,
115 ".. method:: remove(element)\n"
116 "\n"
117 " Remove an element from the selection history.\n"
118 "\n"
119 " :param element: The element to remove.\n"
120 " :type element: :class:`BMVert` | :class:`BMEdge` | :class:`BMFace`\n");
122{
123 const char *error_prefix = "select_history.remove(...)";
124 BPY_BM_CHECK_OBJ(self);
125
126 if ((BPy_BMVert_Check(value) || BPy_BMEdge_Check(value) || BPy_BMFace_Check(value)) == false) {
127 PyErr_Format(PyExc_TypeError,
128 "%s: expected a BMVert/BMedge/BMFace not a %.200s",
129 error_prefix,
130 Py_TYPE(value)->tp_name);
131 return nullptr;
132 }
133
134 BPY_BM_CHECK_SOURCE_OBJ(self->bm, error_prefix, value);
135
136 if (BM_select_history_remove(self->bm, value->ele) == false) {
137 PyErr_Format(PyExc_ValueError, "%s: element not found in selection history", error_prefix);
138 return nullptr;
139 }
140
141 Py_RETURN_NONE;
142}
143
145 /* Wrap. */
146 bpy_bmeditselseq_discard_doc,
147 ".. method:: discard(element)\n"
148 "\n"
149 " Discard an element from the selection history.\n"
150 "\n"
151 " Like remove but doesn't raise an error when the element is not in the selection list.\n"
152 "\n"
153 " :param element: The element to discard.\n"
154 " :type element: :class:`BMVert` | :class:`BMEdge` | :class:`BMFace`\n");
156{
157 const char *error_prefix = "select_history.discard()";
158 BPY_BM_CHECK_OBJ(self);
159
160 if ((BPy_BMVert_Check(value) || BPy_BMEdge_Check(value) || BPy_BMFace_Check(value)) == false) {
161 PyErr_Format(PyExc_TypeError,
162 "%s: expected a BMVert/BMedge/BMFace not a %.200s",
163 error_prefix,
164 Py_TYPE(value)->tp_name);
165 return nullptr;
166 }
167
168 BPY_BM_CHECK_SOURCE_OBJ(self->bm, error_prefix, value);
169
170 BM_select_history_remove(self->bm, value->ele);
171
172 Py_RETURN_NONE;
173}
174
175#ifdef __GNUC__
176# ifdef __clang__
177# pragma clang diagnostic push
178# pragma clang diagnostic ignored "-Wcast-function-type"
179# else
180# pragma GCC diagnostic push
181# pragma GCC diagnostic ignored "-Wcast-function-type"
182# endif
183#endif
184
185static PyMethodDef bpy_bmeditselseq_methods[] = {
186 {"validate",
187 reinterpret_cast<PyCFunction>(bpy_bmeditselseq_validate),
188 METH_NOARGS,
189 bpy_bmeditselseq_validate_doc},
190 {"clear",
191 reinterpret_cast<PyCFunction>(bpy_bmeditselseq_clear),
192 METH_NOARGS,
193 bpy_bmeditselseq_clear_doc},
194
195 {"add", reinterpret_cast<PyCFunction>(bpy_bmeditselseq_add), METH_O, bpy_bmeditselseq_add_doc},
196 {"remove",
197 reinterpret_cast<PyCFunction>(bpy_bmeditselseq_remove),
198 METH_O,
199 bpy_bmeditselseq_remove_doc},
200 {"discard",
201 reinterpret_cast<PyCFunction>(bpy_bmeditselseq_discard),
202 METH_O,
203 bpy_bmeditselseq_discard_doc},
204 {nullptr, nullptr, 0, nullptr},
205};
206
207#ifdef __GNUC__
208# ifdef __clang__
209# pragma clang diagnostic pop
210# else
211# pragma GCC diagnostic pop
212# endif
213#endif
214
215/* Sequences
216 * ========= */
217
219{
220 BPY_BM_CHECK_INT(self);
221
222 return self->bm->selected.count();
223}
224
225static PyObject *bpy_bmeditselseq_subscript_int(BPy_BMEditSelSeq *self, Py_ssize_t keynum)
226{
227 BMEditSelection *ese;
228
229 BPY_BM_CHECK_OBJ(self);
230
231 if (keynum < 0) {
232 ese = static_cast<BMEditSelection *>(BLI_rfindlink(&self->bm->selected, -1 - keynum));
233 }
234 else {
235 ese = static_cast<BMEditSelection *>(BLI_findlink(&self->bm->selected, keynum));
236 }
237
238 if (ese) {
239 return BPy_BMElem_CreatePyObject(self->bm, &ese->ele->head);
240 }
241
242 PyErr_Format(PyExc_IndexError, "BMElemSeq[index]: index %d out of range", keynum);
243 return nullptr;
244}
245
247 Py_ssize_t start,
248 Py_ssize_t stop)
249{
250 int count = 0;
251
252 PyObject *list;
253 BMEditSelection *ese;
254
255 BPY_BM_CHECK_OBJ(self);
256
257 list = PyList_New(0);
258
259 /* First loop up-until the start. */
260 for (ese = self->bm->selected.first(); ese; ese = ese->next) {
261 if (count == start) {
262 break;
263 }
264 count++;
265 }
266
267 /* Add items until stop. */
268 for (; ese; ese = ese->next) {
269 PyList_APPEND(list, BPy_BMElem_CreatePyObject(self->bm, &ese->ele->head));
270 count++;
271 if (count == stop) {
272 break;
273 }
274 }
275
276 return list;
277}
278
279static PyObject *bpy_bmeditselseq_subscript(BPy_BMEditSelSeq *self, PyObject *key)
280{
281 /* don't need error check here */
282 if (PyIndex_Check(key)) {
283 const Py_ssize_t i = PyNumber_AsSsize_t(key, PyExc_IndexError);
284 if (i == -1 && PyErr_Occurred()) {
285 return nullptr;
286 }
287 return bpy_bmeditselseq_subscript_int(self, i);
288 }
289 if (PySlice_Check(key)) {
290 PySliceObject *key_slice = reinterpret_cast<PySliceObject *>(key);
291 Py_ssize_t step = 1;
292
293 if (key_slice->step != Py_None && !_PyEval_SliceIndex(key_slice->step, &step)) {
294 return nullptr;
295 }
296 if (step != 1) {
297 PyErr_SetString(PyExc_TypeError, "BMElemSeq[slice]: slice steps not supported");
298 return nullptr;
299 }
300 if (key_slice->start == Py_None && key_slice->stop == Py_None) {
301 return bpy_bmeditselseq_subscript_slice(self, 0, PY_SSIZE_T_MAX);
302 }
303
304 Py_ssize_t start = 0, stop = PY_SSIZE_T_MAX;
305
306 /* avoid PySlice_GetIndicesEx because it needs to know the length ahead of time. */
307 if (key_slice->start != Py_None && !_PyEval_SliceIndex(key_slice->start, &start)) {
308 return nullptr;
309 }
310 if (key_slice->stop != Py_None && !_PyEval_SliceIndex(key_slice->stop, &stop)) {
311 return nullptr;
312 }
313
314 if (start < 0 || stop < 0) {
315 /* only get the length for negative values */
316 const Py_ssize_t len = bpy_bmeditselseq_length(self);
317 if (start < 0) {
318 start += len;
319 CLAMP_MIN(start, 0);
320 }
321 if (stop < 0) {
322 stop += len;
323 CLAMP_MIN(stop, 0);
324 }
325 }
326
327 if (stop - start <= 0) {
328 return PyList_New(0);
329 }
330
331 return bpy_bmeditselseq_subscript_slice(self, start, stop);
332 }
333
334 PyErr_SetString(PyExc_AttributeError, "BMElemSeq[key]: invalid key, key must be an int");
335 return nullptr;
336}
337
338static int bpy_bmeditselseq_contains(BPy_BMEditSelSeq *self, PyObject *value)
339{
340 BPY_BM_CHECK_INT(self);
341
342 if (!BPy_BMElem_Check(value)) {
343 return 0;
344 }
345
346 BPy_BMElem *value_bm_ele = reinterpret_cast<BPy_BMElem *>(value);
347 if (value_bm_ele->bm == self->bm) {
348 return BM_select_history_check(self->bm, value_bm_ele->ele);
349 }
350
351 return 0;
352}
353
354static PySequenceMethods bpy_bmeditselseq_as_sequence = {
355 /*sq_length*/ reinterpret_cast<lenfunc>(bpy_bmeditselseq_length),
356 /*sq_concat*/ nullptr,
357 /*sq_repeat*/ nullptr,
358 /* Only set this so `PySequence_Check()` returns True. */
359 /*sq_item*/ reinterpret_cast<ssizeargfunc>(bpy_bmeditselseq_subscript_int),
360 /*was_sq_slice*/ nullptr,
361 /*sq_ass_item*/ nullptr,
362 /*was_sq_ass_slice*/ nullptr,
363 /*sq_contains*/ reinterpret_cast<objobjproc>(bpy_bmeditselseq_contains),
364 /*sq_inplace_concat*/ nullptr,
365 /*sq_inplace_repeat*/ nullptr,
366};
367
368static PyMappingMethods bpy_bmeditselseq_as_mapping = {
369 /*mp_length*/ reinterpret_cast<lenfunc>(bpy_bmeditselseq_length),
370 /*mp_subscript*/ reinterpret_cast<binaryfunc>(bpy_bmeditselseq_subscript),
371 /*mp_ass_subscript*/ static_cast<objobjargproc>(nullptr),
372};
373
374/* Iterator
375 * -------- */
376
378{
379 BPy_BMEditSelIter *py_iter;
380
381 BPY_BM_CHECK_OBJ(self);
382 py_iter = reinterpret_cast<BPy_BMEditSelIter *>(BPy_BMEditSelIter_CreatePyObject(self->bm));
383 py_iter->ese = self->bm->selected.first();
384 return reinterpret_cast<PyObject *>(py_iter);
385}
386
388{
389 BMEditSelection *ese = self->ese;
390 if (ese == nullptr) {
391 PyErr_SetNone(PyExc_StopIteration);
392 return nullptr;
393 }
394
395 self->ese = ese->next;
396 return BPy_BMElem_CreatePyObject(self->bm, &ese->ele->head);
397}
398
401
403{
405 self->bm = bm;
406 /* caller must initialize 'iter' member */
407 return reinterpret_cast<PyObject *>(self);
408}
409
411{
413 self->bm = bm;
414 /* caller must initialize 'iter' member */
415 return reinterpret_cast<PyObject *>(self);
416}
417
419{
420 BPy_BMEditSelSeq_Type.tp_basicsize = sizeof(BPy_BMEditSelSeq);
421 BPy_BMEditSelIter_Type.tp_basicsize = sizeof(BPy_BMEditSelIter);
422
423 BPy_BMEditSelSeq_Type.tp_name = "BMEditSelSeq";
424 BPy_BMEditSelIter_Type.tp_name = "BMEditSelIter";
425
426 BPy_BMEditSelSeq_Type.tp_doc = nullptr; /* todo */
427 BPy_BMEditSelIter_Type.tp_doc = nullptr;
428
429 BPy_BMEditSelSeq_Type.tp_repr = static_cast<reprfunc>(nullptr);
430 BPy_BMEditSelIter_Type.tp_repr = static_cast<reprfunc>(nullptr);
431
433 BPy_BMEditSelIter_Type.tp_getset = nullptr;
434
436 BPy_BMEditSelIter_Type.tp_methods = nullptr;
437
439
441
442 BPy_BMEditSelSeq_Type.tp_iter = reinterpret_cast<getiterfunc>(bpy_bmeditselseq_iter);
443
444 /* Only 1 iterator so far. */
445 BPy_BMEditSelIter_Type.tp_iter = PyObject_SelfIter;
446 BPy_BMEditSelIter_Type.tp_iternext = reinterpret_cast<iternextfunc>(bpy_bmeditseliter_next);
447
448 BPy_BMEditSelSeq_Type.tp_dealloc = nullptr; //(destructor)bpy_bmeditselseq_dealloc;
449 BPy_BMEditSelIter_Type.tp_dealloc = nullptr; //(destructor)bpy_bmvert_dealloc;
450
451 BPy_BMEditSelSeq_Type.tp_flags = Py_TPFLAGS_DEFAULT;
452 BPy_BMEditSelIter_Type.tp_flags = Py_TPFLAGS_DEFAULT;
453
454 PyType_Ready(&BPy_BMEditSelSeq_Type);
455 PyType_Ready(&BPy_BMEditSelIter_Type);
456}
457
458/* utility function */
459
460int BPy_BMEditSel_Assign(BPy_BMesh *self, PyObject *value)
461{
462 const char *error_prefix = "BMesh.select_history = value";
463 BPY_BM_CHECK_INT(self);
464
465 BMesh *bm = self->bm;
466
467 Py_ssize_t value_num;
468 BMElem **value_array = static_cast<BMElem **>(
470 value,
471 0,
472 PY_SSIZE_T_MAX,
473 &value_num,
475 true,
476 true,
477 error_prefix));
478
479 if (value_array == nullptr) {
480 return -1;
481 }
482
484
485 for (Py_ssize_t i = 0; i < value_num; i++) {
486 BM_select_history_store_notest(bm, value_array[i]);
487 }
488
489 PyMem_FREE(value_array);
490 return 0;
491}
492
493} // namespace blender
#define CLAMP_MIN(a, b)
#define BM_select_history_store_notest(bm, ele)
#define BM_select_history_store(bm, ele)
#define BM_select_history_check(bm, ele)
#define BM_select_history_remove(bm, ele)
#define BPy_BMFace_Check(v)
#define BPY_BM_CHECK_OBJ(obj)
#define BPy_BMVert_Check(v)
#define BPy_BMElem_Check(v)
#define BPy_BMEdge_Check(v)
#define BPY_BM_CHECK_SOURCE_OBJ(bm, errmsg,...)
#define BPY_BM_CHECK_INT(obj)
VecBase< float, D > step(VecOp< float, D >, VecOp< float, D >) RET
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
BMesh Iterators.
static PyMappingMethods bpy_bmeditselseq_as_mapping
void * BLI_rfindlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:556
static PyObject * bpy_bmeditselseq_discard(BPy_BMEditSelSeq *self, BPy_BMElem *value)
static PyObject * bpy_bmeditseliter_next(BPy_BMEditSelIter *self)
static PyObject * bpy_bmeditselseq_remove(BPy_BMEditSelSeq *self, BPy_BMElem *value)
void BPy_BM_init_types_select()
static PyObject * bpy_bmeditselseq_clear(BPy_BMEditSelSeq *self)
static Py_ssize_t bpy_bmeditselseq_length(BPy_BMEditSelSeq *self)
static PyObject * bpy_bmeditselseq_add(BPy_BMEditSelSeq *self, BPy_BMElem *value)
PyDoc_STRVAR(bpy_bm_new_doc, ".. function:: new(*, use_operators=True)\n" "\n" " :param use_operators: Support calling operators in :mod:`bmesh.ops` (uses some " "extra memory per vert/edge/face).\n" " :type use_operators: bool\n" " :return: Return a new, empty BMesh.\n" " :rtype: :class:`bmesh.types.BMesh`\n")
static PyMethodDef bpy_bmeditselseq_methods[]
PyObject * BPy_BMEditSel_CreatePyObject(BMesh *bm)
static PyGetSetDef bpy_bmeditselseq_getseters[]
void * BLI_findlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:541
static PyObject * bpy_bmeditselseq_active_get(BPy_BMEditSelSeq *self, void *)
PyTypeObject BPy_BMEditSelSeq_Type
PyObject * BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele)
static PyObject * bpy_bmeditselseq_subscript(BPy_BMEditSelSeq *self, PyObject *key)
static PyObject * bpy_bmeditselseq_subscript_int(BPy_BMEditSelSeq *self, Py_ssize_t keynum)
static PySequenceMethods bpy_bmeditselseq_as_sequence
void BM_select_history_validate(BMesh *bm)
static PyObject * bpy_bmeditselseq_iter(BPy_BMEditSelSeq *self)
static PyObject * bpy_bmeditselseq_validate(BPy_BMEditSelSeq *self)
void BM_select_history_clear(BMesh *bm)
int BPy_BMEditSel_Assign(BPy_BMesh *self, PyObject *value)
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_BMEditSelIter_CreatePyObject(BMesh *bm)
static PyObject * bpy_bmeditselseq_subscript_slice(BPy_BMEditSelSeq *self, Py_ssize_t start, Py_ssize_t stop)
static int bpy_bmeditselseq_contains(BPy_BMEditSelSeq *self, PyObject *value)
PyTypeObject BPy_BMEditSelIter_Type
header-only utilities
struct BMEditSelection * next
PyObject_HEAD BMesh * bm
PyObject_HEAD BMesh * bm
ListBaseT< BMEditSelection > selected