Replace hardcoded DMGridData structure with CCGElem/CCGKey.
[blender-staging.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 MultiresSubsurf;
45 struct Object;
46 struct PBVH;
47 struct SubsurfModifierData;
48 struct CCGEdge;
49 struct CCGFace;
50 struct CCGSubsurf;
51 struct CCGVert;
52 struct EdgeHash;
53 struct PBVH;
54 struct DMGridAdjacency;
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 } SubsurfFlags;
64
65 struct DerivedMesh *subsurf_make_derived_from_derived(
66                                                 struct DerivedMesh *dm,
67                                                 struct SubsurfModifierData *smd,
68                                                 float (*vertCos)[3],
69                                                 SubsurfFlags flags);
70
71 void subsurf_calculate_limit_positions(struct Mesh *me, float (*positions_r)[3]);
72
73 /* get gridsize from 'level', level must be greater than zero */
74 int ccg_gridsize(int level);
75
76 /* x/y grid coordinates at 'low_level' can be multiplied by the result
77  * of this function to convert to grid coordinates at 'high_level' */
78 int ccg_factor(int low_level, int high_level);
79
80 void subsurf_copy_grid_hidden(struct DerivedMesh *dm,
81                                                           const struct MPoly *mpoly,
82                                                           struct MVert *mvert,
83                                                           const struct MDisps *mdisps);
84
85 typedef enum MultiresModifiedFlags {
86         /* indicates the grids have been sculpted on, so MDisps
87          * have to be updated */
88         MULTIRES_COORDS_MODIFIED = 1,
89         /* indicates elements have been hidden or unhidden */
90         MULTIRES_HIDDEN_MODIFIED = 2
91 } MultiresModifiedFlags;
92
93 /**************************** Internal *****************************/
94
95 typedef struct CCGDerivedMesh {
96         DerivedMesh dm;
97
98         struct CCGSubSurf *ss;
99         int freeSS;
100         int drawInteriorEdges, useSubsurfUv;
101
102         struct {int startVert; struct CCGVert *vert;} *vertMap;
103         struct {int startVert; int startEdge; struct CCGEdge *edge;} *edgeMap;
104         struct {int startVert; int startEdge;
105                         int startFace; struct CCGFace *face;} *faceMap;
106
107         short *edgeFlags;
108         struct DMFlagMat *faceFlags;
109
110         int *reverseFaceMap;
111
112         struct PBVH *pbvh;
113
114         struct MeshElemMap *pmap;
115         int *pmap_mem;
116
117         struct CCGElem **gridData;
118         struct DMGridAdjacency *gridAdjacency;
119         int *gridOffset;
120         struct CCGFace **gridFaces;
121         struct DMFlagMat *gridFlagMats;
122         unsigned int **gridHidden;
123
124         struct {
125                 struct MultiresModifierData *mmd;
126                 int local_mmd;
127
128                 int lvl, totlvl;
129                 float (*orco)[3];
130
131                 struct Object *ob;
132                 MultiresModifiedFlags modified_flags;
133         } multires;
134
135         struct EdgeHash *ehash;
136 } CCGDerivedMesh;
137
138 #endif
139