OpenSubdiv: Commit of OpenSubdiv integration into Blender
[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 struct CCGElem;
38 struct DMFlagMat;
39 struct DMGridAdjacency;
40 struct DerivedMesh;
41 struct MeshElemMap;
42 struct Mesh;
43 struct MPoly;
44 struct Object;
45 struct PBVH;
46 struct SubsurfModifierData;
47 struct CCGEdge;
48 struct CCGFace;
49 struct CCGVert;
50 struct EdgeHash;
51 struct PBVH;
52
53 /**************************** External *****************************/
54
55 typedef enum {
56         SUBSURF_USE_RENDER_PARAMS = 1,
57         SUBSURF_IS_FINAL_CALC = 2,
58         SUBSURF_FOR_EDIT_MODE = 4,
59         SUBSURF_IN_EDIT_MODE = 8,
60         SUBSURF_ALLOC_PAINT_MASK = 16,
61         SUBSURF_USE_GPU_BACKEND = 32,
62 } SubsurfFlags;
63
64 struct DerivedMesh *subsurf_make_derived_from_derived(
65         struct DerivedMesh *dm,
66         struct SubsurfModifierData *smd,
67         float (*vertCos)[3],
68         SubsurfFlags flags);
69
70 void subsurf_calculate_limit_positions(struct Mesh *me, float (*r_positions)[3]);
71
72 /* get gridsize from 'level', level must be greater than zero */
73 int BKE_ccg_gridsize(int level);
74
75 /* x/y grid coordinates at 'low_level' can be multiplied by the result
76  * of this function to convert to grid coordinates at 'high_level' */
77 int BKE_ccg_factor(int low_level, int high_level);
78
79 void subsurf_copy_grid_hidden(struct DerivedMesh *dm,
80                               const struct MPoly *mpoly,
81                               struct MVert *mvert,
82                               const struct MDisps *mdisps);
83
84 void subsurf_copy_grid_paint_mask(struct DerivedMesh *dm,
85                                   const struct MPoly *mpoly, float *paint_mask,
86                                   const struct GridPaintMask *grid_paint_mask);
87
88 typedef enum MultiresModifiedFlags {
89         /* indicates the grids have been sculpted on, so MDisps
90          * have to be updated */
91         MULTIRES_COORDS_MODIFIED = 1,
92         /* indicates elements have been hidden or unhidden */
93         MULTIRES_HIDDEN_MODIFIED = 2
94 } MultiresModifiedFlags;
95
96 /**************************** Internal *****************************/
97
98 typedef struct CCGDerivedMesh {
99         DerivedMesh dm;
100
101         struct CCGSubSurf *ss;
102         int freeSS;
103         int drawInteriorEdges, useSubsurfUv, useGpuBackend;
104
105         struct {int startVert; struct CCGVert *vert; } *vertMap;
106         struct {int startVert; int startEdge; struct CCGEdge *edge; } *edgeMap;
107         struct {int startVert; int startEdge;
108                     int startFace; struct CCGFace *face; } *faceMap;
109
110         short *edgeFlags;
111         struct DMFlagMat *faceFlags;
112
113         int *reverseFaceMap;
114
115         struct PBVH *pbvh;
116
117         struct MeshElemMap *pmap;
118         int *pmap_mem;
119
120         struct CCGElem **gridData;
121         int *gridOffset;
122         struct CCGFace **gridFaces;
123         struct DMFlagMat *gridFlagMats;
124         unsigned int **gridHidden;
125
126         struct {
127                 struct MultiresModifierData *mmd;
128                 int local_mmd;
129
130                 int lvl, totlvl;
131                 float (*orco)[3];
132
133                 struct Object *ob;
134                 MultiresModifiedFlags modified_flags;
135         } multires;
136
137         struct EdgeHash *ehash;
138 } CCGDerivedMesh;
139
140 #endif
141