Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_editmesh.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BKE_EDITMESH_H__
18 #define __BKE_EDITMESH_H__
19
20 /** \file \ingroup bke
21  *
22  * The \link edmesh EDBM module\endlink is for editmode bmesh stuff.
23  * In contrast, this module is for code shared with blenkernel that's
24  * only concerned with low level operations on the #BMEditMesh structure.
25  */
26
27 #include "BKE_customdata.h"
28 #include "bmesh.h"
29
30 struct BMLoop;
31 struct BMesh;
32 struct Depsgraph;
33 struct DerivedMesh;
34 struct EditMeshData;
35 struct Mesh;
36 struct MeshStatVis;
37 struct Scene;
38
39 /**
40  * This structure is used for mesh edit-mode.
41  *
42  * through this, you get access to both the edit #BMesh,
43  * it's tessellation, and various stuff that doesn't belong in the BMesh
44  * struct itself.
45  *
46  * the entire derivedmesh and modifier system works with this structure,
47  * and not BMesh.  Mesh->edit_bmesh stores a pointer to this structure. */
48 typedef struct BMEditMesh {
49         struct BMesh *bm;
50
51         /*this is for undoing failed operations*/
52         struct BMEditMesh *emcopy;
53         int emcopyusers;
54
55         /* we store tessellations as triplets of three loops,
56          * which each define a triangle.*/
57         struct BMLoop *(*looptris)[3];
58         int tottri;
59
60         struct Mesh *mesh_eval_final, *mesh_eval_cage;
61
62         /*derivedmesh stuff*/
63         CustomDataMask lastDataMask;
64         unsigned char (*derivedVertColor)[4];
65         int derivedVertColorLen;
66         unsigned char (*derivedFaceColor)[4];
67         int derivedFaceColorLen;
68
69         /*selection mode*/
70         short selectmode;
71         short mat_nr;
72
73         /* Object this editmesh came from (if it came from one) */
74         struct Object *ob;
75
76         /*temp variables for x-mirror editing*/
77         int mirror_cdlayer; /* -1 is invalid */
78 } BMEditMesh;
79
80 /* editmesh.c */
81 void        BKE_editmesh_tessface_calc(BMEditMesh *em);
82 BMEditMesh *BKE_editmesh_create(BMesh *bm, const bool do_tessellate);
83 BMEditMesh *BKE_editmesh_copy(BMEditMesh *em);
84 BMEditMesh *BKE_editmesh_from_object(struct Object *ob);
85 void        BKE_editmesh_free_derivedmesh(BMEditMesh *em);
86 void        BKE_editmesh_free(BMEditMesh *em);
87
88 void        BKE_editmesh_color_free(BMEditMesh *em);
89 void        BKE_editmesh_color_ensure(BMEditMesh *em, const char htype);
90 float     (*BKE_editmesh_vertexCos_get_orco(BMEditMesh *em, int *r_numVerts))[3];
91 void        BKE_editmesh_lnorspace_update(BMEditMesh *em);
92
93 /* editderivedmesh.c */
94 /* should really be defined in editmesh.c, but they use 'EditDerivedBMesh' */
95 void BKE_editmesh_statvis_calc(
96         BMEditMesh *em, struct EditMeshData *emd, const struct MeshStatVis *statvis);
97
98 float (*BKE_editmesh_vertexCos_get(
99            struct Depsgraph *depsgraph, struct BMEditMesh *em, struct Scene *scene, int *r_numVerts))[3];
100
101 #endif /* __BKE_EDITMESH_H__ */