bmesh py api:
[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_TYPES_H__
31 #define __BMESH_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 extern PyTypeObject BPy_BMElemSeq_Type;
39 extern PyTypeObject BPy_BMIter_Type;
40
41 #define BPy_BMesh_Check(v)      (Py_TYPE(v) == &BPy_BMesh_Type)
42 #define BPy_BMVert_Check(v)     (Py_TYPE(v) == &BPy_BMVert_Type)
43 #define BPy_BMEdge_Check(v)     (Py_TYPE(v) == &BPy_BMEdge_Type)
44 #define BPy_BMFace_Check(v)     (Py_TYPE(v) == &BPy_BMFace_Type)
45 #define BPy_BMLoop_Check(v)     (Py_TYPE(v) == &BPy_BMLoop_Type)
46 #define BPy_BMElemSeq_Check(v)  (Py_TYPE(v) == &BPy_BMElemSeq_Type)
47 #define BPy_BMIter_Check(v)     (Py_TYPE(v) == &BPy_BMIter_Type)
48
49 /* cast from _any_ bmesh type - they all have BMesh first */
50 typedef struct BPy_BMGeneric {
51         PyObject_VAR_HEAD
52         struct BMesh *bm; /* keep first */
53 } BPy_BMGeneric;
54
55 /* BPy_BMVert/BPy_BMEdge/BPy_BMFace/BPy_BMLoop can cast to this */
56 typedef struct BPy_BMElem {
57         PyObject_VAR_HEAD
58         struct BMesh *bm; /* keep first */
59         struct BMElem *ele;
60 } BPy_BMElem;
61
62 typedef struct BPy_BMesh {
63         PyObject_VAR_HEAD
64         struct BMesh *bm; /* keep first */
65         int flag;
66 } BPy_BMesh;
67
68 /* element types */
69 typedef struct BPy_BMVert {
70         PyObject_VAR_HEAD
71         struct BMesh *bm; /* keep first */
72         struct BMVert *v;
73 } BPy_BMVert;
74
75 typedef struct BPy_BMEdge {
76         PyObject_VAR_HEAD
77         struct BMesh *bm; /* keep first */
78         struct BMEdge *e;
79 } BPy_BMEdge;
80
81 typedef struct BPy_BMFace {
82         PyObject_VAR_HEAD
83         struct BMesh *bm; /* keep first */
84         struct BMFace *f;
85 } BPy_BMFace;
86
87 typedef struct BPy_BMLoop {
88         PyObject_VAR_HEAD
89         struct BMesh *bm; /* keep first */
90         struct BMLoop *l;
91 } BPy_BMLoop;
92
93
94 /* iterators */
95
96 typedef struct BPy_BMElemSeq {
97         PyObject_VAR_HEAD
98         struct BMesh *bm; /* keep first */
99
100         /* if this is a sequence on an existing element,
101          * loops of faces for eg.
102          * If this veriable is set, it will be used */
103
104         /* we hold a reference to this.
105          * check in case the owner becomes invalid on access */
106         /* TODO - make this a GC'd object!, will function OK without this though */
107         BPy_BMElem *py_ele;
108
109         /* iterator type */
110         short itype;
111 } BPy_BMElemSeq;
112
113 typedef struct BPy_BMIter {
114         PyObject_VAR_HEAD
115         struct BMesh *bm; /* keep first */
116         BMIter iter;
117 } BPy_BMIter;
118
119 void BPy_BM_init_types(void);
120
121 PyObject *BPyInit_bmesh_types(void);
122
123 enum {
124         BPY_BMFLAG_NOP = 0,       /* do nothing */
125         BPY_BMFLAG_IS_WRAPPED = 1 /* the mesh is owned by editmode */
126 };
127
128 PyObject *BPy_BMesh_CreatePyObject(BMesh *bm, int flag);
129 PyObject *BPy_BMVert_CreatePyObject(BMesh *bm, BMVert *v);
130 PyObject *BPy_BMEdge_CreatePyObject(BMesh *bm, BMEdge *e);
131 PyObject *BPy_BMFace_CreatePyObject(BMesh *bm, BMFace *f);
132 PyObject *BPy_BMLoop_CreatePyObject(BMesh *bm, BMLoop *l);
133 PyObject *BPy_BMElemSeq_CreatePyObject(BMesh *bm, BPy_BMElem *py_ele, const char itype);
134 PyObject *BPy_BMIter_CreatePyObject(BMesh *bm);
135
136 PyObject *BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele); /* just checks type and creates v/e/f/l */
137
138 int  bpy_bm_generic_valid_check(BPy_BMGeneric *self);
139 void bpy_bm_generic_invalidate(BPy_BMGeneric *self);
140
141 void *BPy_BMElem_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_size,
142                                 const char htype,
143                                 const char do_unique_check, const char do_bm_check,
144                                 const char *error_prefix);
145
146 PyObject *BPy_BMElem_Array_As_Tuple(BMesh *bm, BMHeader **elem, Py_ssize_t elem_len);
147 int       BPy_BMElem_CheckHType(PyTypeObject *type, const char htype);
148 char     *BPy_BMElem_StringFromHType_ex(const char htype, char ret[32]);
149 char     *BPy_BMElem_StringFromHType(const char htype);
150
151
152 #define BPY_BM_CHECK_OBJ(obj) if (UNLIKELY(bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1)) { return NULL; } (void)0
153 #define BPY_BM_CHECK_INT(obj) if (UNLIKELY(bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1)) { return -1; }   (void)0
154
155 #define BPY_BM_IS_VALID(obj) (LIKELY((obj)->bm != NULL))
156
157 #define BM_ITER_BPY_BM_SEQ(ele, iter, bpy_bmelemseq)                \
158         BM_ITER(ele, iter, (bpy_bmelemseq)->bm, (bpy_bmelemseq)->itype, \
159         (bpy_bmelemseq)->py_ele ? ((BPy_BMElem *)(bpy_bmelemseq)->py_ele)->ele : NULL)
160
161 #endif /* __BMESH_TYPES_H__ */