05a36ee9897e8645110a63af2e62ea698caaa1e0
[blender-staging.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 BMHeader *ele;
60 } BPy_BMElem;
61
62 typedef struct BPy_BMesh {
63         PyObject_VAR_HEAD
64         struct BMesh *bm; /* keep first */
65 } BPy_BMesh;
66
67 /* element types */
68 typedef struct BPy_BMVert {
69         PyObject_VAR_HEAD
70         struct BMesh *bm; /* keep first */
71         struct BMVert *v;
72 } BPy_BMVert;
73
74 typedef struct BPy_BMEdge {
75         PyObject_VAR_HEAD
76         struct BMesh *bm; /* keep first */
77         struct BMEdge *e;
78 } BPy_BMEdge;
79
80 typedef struct BPy_BMFace {
81         PyObject_VAR_HEAD
82         struct BMesh *bm; /* keep first */
83         struct BMFace *f;
84 } BPy_BMFace;
85
86 typedef struct BPy_BMLoop {
87         PyObject_VAR_HEAD
88         struct BMesh *bm; /* keep first */
89         struct BMLoop *l;
90 } BPy_BMLoop;
91
92
93 /* iterators */
94
95 typedef struct BPy_BMElemSeq {
96         PyObject_VAR_HEAD
97         struct BMesh *bm; /* keep first */
98
99         /* if this is a sequence on an existing element,
100          * loops of faces for eg.
101          * If this veriable is set, it will be used */
102
103         /* we hold a reference to this.
104          * check incase the owner becomes invalid on access */
105         /* TODO - make this a GC'd object!, will function OK without this though */
106         BPy_BMElem *py_ele;
107
108         /* iterator type */
109         short itype;
110 } BPy_BMElemSeq;
111
112 typedef struct BPy_BMIter {
113         PyObject_VAR_HEAD
114         struct BMesh *bm; /* keep first */
115         BMIter iter;
116 } BPy_BMIter;
117
118 void BPy_BM_init_types(void);
119
120 PyObject *BPyInit_bmesh_types(void);
121
122 PyObject *BPy_BMesh_CreatePyObject(BMesh *bm);
123 PyObject *BPy_BMVert_CreatePyObject(BMesh *bm, BMVert *v);
124 PyObject *BPy_BMEdge_CreatePyObject(BMesh *bm, BMEdge *e);
125 PyObject *BPy_BMFace_CreatePyObject(BMesh *bm, BMFace *f);
126 PyObject *BPy_BMLoop_CreatePyObject(BMesh *bm, BMLoop *l);
127 PyObject *BPy_BMElemSeq_CreatePyObject(BMesh *bm, BPy_BMElem *py_ele, const char itype);
128 PyObject *BPy_BMIter_CreatePyObject(BMesh *bm);
129
130 PyObject *BPy_BMElem_CreatePyObject(BMesh *bm, BMHeader *ele); /* just checks type and creates v/e/f/l */
131
132 int  bpy_bm_generic_valid_check(BPy_BMGeneric *self);
133 void bpy_bm_generic_invalidate(BPy_BMGeneric *self);
134
135 void *BPy_BMElem_PySeq_As_Array(BMesh **r_bm, PyObject *seq, Py_ssize_t min, Py_ssize_t max, Py_ssize_t *r_size,
136                                 PyTypeObject *type,
137                                 const char do_unique_check, const char do_bm_check,
138                                 const char *error_prefix);
139
140 #define BPY_BM_CHECK_OBJ(obj) if (bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1) { return NULL; } (void)NULL
141 #define BPY_BM_CHECK_INT(obj) if (bpy_bm_generic_valid_check((BPy_BMGeneric *)obj) == -1) { return -1; }   (void)NULL
142
143 #define BM_ITER_BPY_BM_SEQ(ele, iter, bpy_bmelemseq) \
144         BM_ITER(ele, iter, (bpy_bmelemseq)->bm, (bpy_bmelemseq)->itype,\
145         (bpy_bmelemseq)->py_ele ? ((BPy_BMElem *)(bpy_bmelemseq)->py_ele)->ele : NULL)
146
147 #endif /* __BMESH_TYPES_H__ */