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