Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_editmesh.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  * Contributor(s): Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BKE_EDITMESH_H__
24 #define __BKE_EDITMESH_H__
25
26 /** \file BKE_editmesh.h
27  *  \ingroup bke
28  *
29  * The \link edmesh EDBM module\endlink is for editmode bmesh stuff.
30  * In contrast, the this module is for code shared with blenkernel thats
31  * only concerned with low level operations on the #BMEditMesh structure.
32  */
33
34 #include "BKE_customdata.h"
35 #include "bmesh.h"
36
37 struct BMesh;
38 struct BMLoop;
39 struct Mesh;
40 struct Scene;
41 struct DerivedMesh;
42 struct MeshStatVis;
43 struct Depsgraph;
44
45 /**
46  * This structure is used for mesh edit-mode.
47  *
48  * through this, you get access to both the edit #BMesh,
49  * it's tessellation, and various stuff that doesn't belong in the BMesh
50  * struct itself.
51  *
52  * the entire derivedmesh and modifier system works with this structure,
53  * and not BMesh.  Mesh->edit_bmesh stores a pointer to this structure. */
54 typedef struct BMEditMesh {
55         struct BMesh *bm;
56
57         /*this is for undoing failed operations*/
58         struct BMEditMesh *emcopy;
59         int emcopyusers;
60         
61         /* we store tessellations as triplets of three loops,
62          * which each define a triangle.*/
63         struct BMLoop *(*looptris)[3];
64         int tottri;
65
66         /*derivedmesh stuff*/
67         struct DerivedMesh *derivedFinal, *derivedCage;
68         CustomDataMask lastDataMask;
69         unsigned char (*derivedVertColor)[4];
70         int derivedVertColorLen;
71         unsigned char (*derivedFaceColor)[4];
72         int derivedFaceColorLen;
73
74         /*selection mode*/
75         short selectmode;
76         short mat_nr;
77
78         /* Object this editmesh came from (if it came from one) */
79         struct Object *ob;
80
81         /*temp variables for x-mirror editing*/
82         int mirror_cdlayer; /* -1 is invalid */
83 } BMEditMesh;
84
85 /* editmesh.c */
86 void        BKE_editmesh_tessface_calc(BMEditMesh *em);
87 BMEditMesh *BKE_editmesh_create(BMesh *bm, const bool do_tessellate);
88 BMEditMesh *BKE_editmesh_copy(BMEditMesh *em);
89 BMEditMesh *BKE_editmesh_from_object(struct Object *ob);
90 void        BKE_editmesh_free_derivedmesh(BMEditMesh *em);
91 void        BKE_editmesh_free(BMEditMesh *em);
92
93 void        BKE_editmesh_color_free(BMEditMesh *em);
94 void        BKE_editmesh_color_ensure(BMEditMesh *em, const char htype);
95 float     (*BKE_editmesh_vertexCos_get_orco(BMEditMesh *em, int *r_numVerts))[3];
96
97 /* editderivedmesh.c */
98 /* should really be defined in editmesh.c, but they use 'EditDerivedBMesh' */
99 void        BKE_editmesh_statvis_calc(BMEditMesh *em, struct DerivedMesh *dm,
100                                       const struct MeshStatVis *statvis);
101
102 float (*BKE_editmesh_vertexCos_get(
103            struct Depsgraph *depsgraph, struct BMEditMesh *em, struct Scene *scene, int *r_numVerts))[3];
104
105 #endif /* __BKE_EDITMESH_H__ */