Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_subsurf.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_SUBSURF_H__
28 #define __BKE_SUBSURF_H__
29
30 /** \file BKE_subsurf.h
31  *  \ingroup bke
32  */
33
34 /* struct DerivedMesh is used directly */
35 #include "BKE_DerivedMesh.h"
36
37 /* Thread sync primitives used directly.  */
38 #include "BLI_threads.h"
39
40 struct CCGElem;
41 struct DMFlagMat;
42 struct DMGridAdjacency;
43 struct DerivedMesh;
44 struct MeshElemMap;
45 struct Mesh;
46 struct MPoly;
47 struct Object;
48 struct PBVH;
49 struct SubsurfModifierData;
50 struct CCGEdge;
51 struct CCGFace;
52 struct CCGVert;
53 struct EdgeHash;
54 struct PBVH;
55
56 /**************************** External *****************************/
57
58 typedef enum {
59         SUBSURF_USE_RENDER_PARAMS = 1,
60         SUBSURF_IS_FINAL_CALC = 2,
61         SUBSURF_FOR_EDIT_MODE = 4,
62         SUBSURF_IN_EDIT_MODE = 8,
63         SUBSURF_ALLOC_PAINT_MASK = 16,
64         SUBSURF_USE_GPU_BACKEND = 32,
65 } SubsurfFlags;
66
67 struct DerivedMesh *subsurf_make_derived_from_derived(
68         struct DerivedMesh *dm,
69         struct SubsurfModifierData *smd,
70         float (*vertCos)[3],
71         SubsurfFlags flags);
72
73 void subsurf_calculate_limit_positions(struct Mesh *me, float (*r_positions)[3]);
74
75 /* get gridsize from 'level', level must be greater than zero */
76 int BKE_ccg_gridsize(int level);
77
78 /* x/y grid coordinates at 'low_level' can be multiplied by the result
79  * of this function to convert to grid coordinates at 'high_level' */
80 int BKE_ccg_factor(int low_level, int high_level);
81
82 void subsurf_copy_grid_hidden(struct DerivedMesh *dm,
83                               const struct MPoly *mpoly,
84                               struct MVert *mvert,
85                               const struct MDisps *mdisps);
86
87 void subsurf_copy_grid_paint_mask(struct DerivedMesh *dm,
88                                   const struct MPoly *mpoly, float *paint_mask,
89                                   const struct GridPaintMask *grid_paint_mask);
90
91 bool subsurf_has_edges(struct DerivedMesh *dm);
92 bool subsurf_has_faces(struct DerivedMesh *dm);
93
94 typedef enum MultiresModifiedFlags {
95         /* indicates the grids have been sculpted on, so MDisps
96          * have to be updated */
97         MULTIRES_COORDS_MODIFIED = 1,
98         /* indicates elements have been hidden or unhidden */
99         MULTIRES_HIDDEN_MODIFIED = 2
100 } MultiresModifiedFlags;
101
102 /**************************** Internal *****************************/
103
104 typedef struct CCGDerivedMesh {
105         DerivedMesh dm;
106
107         struct CCGSubSurf *ss;
108         int freeSS;
109         int drawInteriorEdges, useSubsurfUv, useGpuBackend;
110
111         struct {int startVert; struct CCGVert *vert; } *vertMap;
112         struct {int startVert; int startEdge; struct CCGEdge *edge; } *edgeMap;
113         struct {int startVert; int startEdge;
114                     int startFace; struct CCGFace *face; } *faceMap;
115
116         short *edgeFlags;
117         struct DMFlagMat *faceFlags;
118
119         int *reverseFaceMap;
120
121         struct PBVH *pbvh;
122
123         struct MeshElemMap *pmap;
124         int *pmap_mem;
125
126         struct CCGElem **gridData;
127         int *gridOffset;
128         struct CCGFace **gridFaces;
129         struct DMFlagMat *gridFlagMats;
130         unsigned int **gridHidden;
131         /* Elements in arrays above. */
132         unsigned int numGrid;
133
134         struct {
135                 struct MultiresModifierData *mmd;
136                 int local_mmd;
137
138                 int lvl, totlvl;
139                 float (*orco)[3];
140
141                 struct Object *ob;
142                 MultiresModifiedFlags modified_flags;
143         } multires;
144
145         struct EdgeHash *ehash;
146
147         ThreadMutex loops_cache_lock;
148         ThreadRWMutex origindex_cache_rwlock;
149 } CCGDerivedMesh;
150
151 #ifdef WITH_OPENSUBDIV
152 /* TODO(sergey): Not really ideal place, but we don't currently have better one. */
153 void BKE_subsurf_osd_init(void);
154 void BKE_subsurf_free_unused_buffers(void);
155 void BKE_subsurf_osd_cleanup(void);
156 #endif
157
158 #endif