Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_subdiv_foreach.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) 2018 by Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Sergey Sharybin.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file BKE_subdiv_foreach.h
27  *  \ingroup bke
28  *  \since September 2018
29  *  \author Sergey Sharybin
30  */
31
32 #ifndef __BKE_SUBDIV_FOREACH_H__
33 #define __BKE_SUBDIV_FOREACH_H__
34
35 #include "BLI_sys_types.h"
36
37 struct Mesh;
38 struct Subdiv;
39 struct SubdivForeachContext;
40 struct SubdivToMeshSettings;
41
42 typedef bool (*SubdivForeachTopologyInformationCb)(
43         const struct SubdivForeachContext *context,
44         const int num_vertices,
45         const int num_edges,
46         const int num_loops,
47         const int num_polygons);
48
49 typedef void (*SubdivForeachVertexFromCornerCb)(
50         const struct SubdivForeachContext *context,
51         void *tls,
52         const int ptex_face_index,
53         const float u, const float v,
54         const int coarse_vertex_index,
55         const int coarse_poly_index,
56         const int coarse_corner,
57         const int subdiv_vertex_index);
58
59 typedef void (*SubdivForeachVertexFromEdgeCb)(
60         const struct SubdivForeachContext *context,
61         void *tls,
62         const int ptex_face_index,
63         const float u, const float v,
64         const int coarse_edge_index,
65         const int coarse_poly_index,
66         const int coarse_corner,
67         const int subdiv_vertex_index);
68
69 typedef void (*SubdivForeachVertexInnerCb)(
70         const struct SubdivForeachContext *context,
71         void *tls,
72         const int ptex_face_index,
73         const float u, const float v,
74         const int coarse_poly_index,
75         const int coarse_corner,
76         const int subdiv_vertex_index);
77
78 typedef void (*SubdivForeachEdgeCb)(
79         const struct SubdivForeachContext *context,
80         void *tls,
81         const int coarse_edge_index,
82         const int subdiv_edge_index,
83         const int subdiv_v1, const int subdiv_v2);
84
85 typedef void (*SubdivForeachLoopCb)(
86         const struct SubdivForeachContext *context,
87         void *tls,
88         const int ptex_face_index,
89         const float u, const float v,
90         const int coarse_loop_index,
91         const int coarse_poly_index,
92         const int coarse_corner,
93         const int subdiv_loop_index,
94         const int subdiv_vertex_index, const int subdiv_edge_index);
95
96 typedef void (*SubdivForeachPolygonCb)(
97         const struct SubdivForeachContext *context,
98         void *tls,
99         const int coarse_poly_index,
100         const int subdiv_poly_index,
101         const int start_loop_index, const int num_loops);
102
103 typedef void (*SubdivForeachLooseCb)(
104         const struct SubdivForeachContext *context,
105         void *tls,
106         const int coarse_vertex_index,
107         const int subdiv_vertex_index);
108
109 typedef void (*SubdivForeachVertexOfLooseEdgeCb)(
110         const struct SubdivForeachContext *context,
111         void *tls,
112         const int coarse_edge_index,
113         const float u,
114         const int subdiv_vertex_index);
115
116 typedef struct SubdivForeachContext {
117         /* Is called when topology information becomes available.
118          * Is only called once.
119          *
120          * NOTE: If this callback returns false, the foreach loop is aborted.
121          */
122         SubdivForeachTopologyInformationCb topology_info;
123         /* These callbacks are called from every ptex which shares "emitting"
124          * vertex or edge.
125          */
126         SubdivForeachVertexFromCornerCb vertex_every_corner;
127         SubdivForeachVertexFromEdgeCb vertex_every_edge;
128         /* Those callbacks are run once per subdivision vertex, ptex is undefined
129          * as in it will be whatever first ptex face happened to be tarversed in
130          * the multi-threaded environment ahd which shares "emitting" vertex or
131          * edge.
132          */
133         SubdivForeachVertexFromCornerCb vertex_corner;
134         SubdivForeachVertexFromEdgeCb vertex_edge;
135         /* Called exactly once, always corresponds to a single ptex face. */
136         SubdivForeachVertexInnerCb vertex_inner;
137         /* Called once for each loose vertex. One loose coarse vertexcorresponds
138          * to a single subdivision vertex.
139          */
140         SubdivForeachLooseCb vertex_loose;
141         /* Called once per vertex created for loose edge. */
142         SubdivForeachVertexOfLooseEdgeCb vertex_of_loose_edge;
143         /* NOTE: If subdivided edge does not come from coarse edge, ORIGINDEX_NONE
144          * will be passed as coarse_edge_index.
145          */
146         SubdivForeachEdgeCb edge;
147         /* NOTE: If subdivided loop does not come from coarse loop, ORIGINDEX_NONE
148          * will be passed as coarse_loop_index.
149          */
150         SubdivForeachLoopCb loop;
151         SubdivForeachPolygonCb poly;
152
153         /* User-defined pointer, to allow callbacks know something about context the
154          * traversal is happening for,
155          */
156         void *user_data;
157
158         /* Initial value of TLS data. */
159         void *user_data_tls;
160         /* Size of TLS data. */
161         size_t user_data_tls_size;
162         /* Function to free TLS storage. */
163         void (*user_data_tls_free)(void *tls);
164 } SubdivForeachContext;
165
166 /* Invokes callbacks in the order and with values which corresponds to creation
167  * of final subdivided mesh.
168  *
169  * Returns truth if the whole topology was traversed, without any early exits.
170  *
171  * TODO(sergey): Need to either get rid of subdiv or of coarse_mesh.
172  * The main point here is th be abel to get base level topology, which can be
173  * done with either of those. Having both of them is kind of redundant.
174  */
175 bool BKE_subdiv_foreach_subdiv_geometry(
176         struct Subdiv *subdiv,
177         const struct SubdivForeachContext *context,
178         const struct SubdivToMeshSettings *mesh_settings,
179         const struct Mesh *coarse_mesh);
180
181 #endif  /* __BKE_SUBDIV_FOREACH_H__ */