1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2018 by Blender Foundation.
* All rights reserved.
*
* Contributor(s): Sergey Sharybin.
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef __BKE_SUBDIV_H__
#define __BKE_SUBDIV_H__
#include "BLI_sys_types.h"
struct Mesh;
struct MultiresModifierData;
struct Object;
struct OpenSubdiv_Converter;
struct OpenSubdiv_Evaluator;
struct OpenSubdiv_TopologyRefiner;
struct Subdiv;
struct SubdivToMeshSettings;
/** \file BKE_subdiv.h
* \ingroup bke
* \since July 2018
* \author Sergey Sharybin
*/
typedef enum {
SUBDIV_FVAR_LINEAR_INTERPOLATION_NONE,
SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_ONLY,
SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_AND_JUNCTIONS,
SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_JUNCTIONS_AND_CONCAVE,
SUBDIV_FVAR_LINEAR_INTERPOLATION_BOUNDARIES,
SUBDIV_FVAR_LINEAR_INTERPOLATION_ALL,
} eSubdivFVarLinearInterpolation;
typedef struct SubdivSettings {
bool is_simple;
bool is_adaptive;
int level;
eSubdivFVarLinearInterpolation fvar_linear_interpolation;
} SubdivSettings;
/* NOTE: Order of enumerators MUST match order of values in SubdivStats. */
typedef enum eSubdivStatsValue {
SUBDIV_STATS_TOPOLOGY_REFINER_CREATION_TIME = 0,
SUBDIV_STATS_SUBDIV_TO_MESH,
SUBDIV_STATS_SUBDIV_TO_MESH_GEOMETRY,
SUBDIV_STATS_EVALUATOR_CREATE,
SUBDIV_STATS_EVALUATOR_REFINE,
NUM_SUBDIV_STATS_VALUES,
} eSubdivStatsValue;
typedef struct SubdivStats {
union {
struct {
/* Time spend on creating topology refiner, which includes time
* spend on conversion from Blender data to OpenSubdiv data, and
* time spend on topology orientation on OpenSubdiv C-API side.
*/
double topology_refiner_creation_time;
/* Total time spent in BKE_subdiv_to_mesh(). */
double subdiv_to_mesh_time;
/* Geometry (MVert and co) creation time during SUBDIV_TYO_MESH. */
double subdiv_to_mesh_geometry_time;
/* Time spent on evaluator creation from topology refiner. */
double evaluator_creation_time;
/* Time spent on evaluator->refine(). */
double evaluator_refine_time;
};
double values_[NUM_SUBDIV_STATS_VALUES];
};
/* Per-value timestamp on when corresponding BKE_subdiv_stats_begin() was
* called.
*/
double begin_timestamp_[NUM_SUBDIV_STATS_VALUES];
} SubdivStats;
/* Functor which evaluates dispalcement at a given (u, v) of given ptex face. */
typedef struct SubdivDisplacement {
/* Return displacement which is to be added to the original coordinate.
*
* NOTE: This function is supposed to return "continuous" displacement for
* each pf PTex faces created for special (non-quad) polygon. This means,
* if displacement is stored on per-corner manner (like MDisps for multires)
* this is up the displacement implementation to average boundaries of the
* displacement grids if needed.
*
* Averaging of displacement for vertices created for over coarse vertices
* and edges is done by subdiv code.
*/
void (*eval_displacement)(struct SubdivDisplacement *displacement,
const int ptex_face_index,
const float u, const float v,
const float dPdu[3], const float dPdv[3],
float r_D[3]);
/* Free the data, not the evaluator itself. */
void (*free)(struct SubdivDisplacement *displacement);
void *user_data;
} SubdivDisplacement;
typedef struct Subdiv {
/* Settings this subdivision surface is created for.
*
* It is read-only after assignment in BKE_subdiv_new_from_FOO().
*/
SubdivSettings settings;
/* Topology refiner includes all the glue logic to feed Blender side
* topology to OpenSubdiv. It can be shared by both evaluator and GL mesh
* drawer.
*/
struct OpenSubdiv_TopologyRefiner *topology_refiner;
/* CPU side evaluator. */
struct OpenSubdiv_Evaluator *evaluator;
/* Optional displacement evaluator. */
struct SubdivDisplacement *displacement_evaluator;
/* Statistics for debugging. */
SubdivStats stats;
} Subdiv;
/* ================================ HELPERS ================================= */
/* NOTE: uv_smooth is eSubsurfUVSmooth. */
eSubdivFVarLinearInterpolation
BKE_subdiv_fvar_interpolation_from_uv_smooth(int uv_smooth);
/* =============================== STATISTICS =============================== */
void BKE_subdiv_stats_init(SubdivStats *stats);
void BKE_subdiv_stats_begin(SubdivStats *stats, eSubdivStatsValue value);
void BKE_subdiv_stats_end(SubdivStats *stats, eSubdivStatsValue value);
void BKE_subdiv_stats_print(const SubdivStats *stats);
/* ============================== CONSTRUCTION ============================== */
Subdiv *BKE_subdiv_new_from_converter(const SubdivSettings *settings,
struct OpenSubdiv_Converter *converter);
Subdiv *BKE_subdiv_new_from_mesh(const SubdivSettings *settings,
struct Mesh *mesh);
void BKE_subdiv_free(Subdiv *subdiv);
/* ============================= EVALUATION API ============================= */
/* Returns true if evaluator is ready for use. */
bool BKE_subdiv_eval_begin(Subdiv *subdiv);
bool BKE_subdiv_eval_update_from_mesh(Subdiv *subdiv, const struct Mesh *mesh);
/* Single point queries. */
void BKE_subdiv_eval_limit_point(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
float r_P[3]);
void BKE_subdiv_eval_limit_point_and_derivatives(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
float r_P[3], float r_dPdu[3], float r_dPdv[3]);
void BKE_subdiv_eval_limit_point_and_normal(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
float r_P[3], float r_N[3]);
void BKE_subdiv_eval_limit_point_and_short_normal(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
float r_P[3], short r_N[3]);
void BKE_subdiv_eval_face_varying(
Subdiv *subdiv,
const int face_varying_channel,
const int ptex_face_index,
const float u, const float v,
float r_varying[2]);
/* NOTE: Expects derivatives to be correct.
*
* TODO(sergey): This is currently used together with
* BKE_subdiv_eval_final_point() which cas easily evaluate derivatives.
* Would be nice to have dispalcement evaluation function which does not require
* knowing derivatives ahead of a time.
*/
void BKE_subdiv_eval_displacement(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
const float dPdu[3], const float dPdv[3],
float r_D[3]);
void BKE_subdiv_eval_final_point(
Subdiv *subdiv,
const int ptex_face_index,
const float u, const float v,
float r_P[3]);
/* Patch queries at given resolution.
*
* Will evaluate patch at uniformly distributed (u, v) coordinates on a grid
* of given resolution, producing resolution^2 evaluation points. The order
* goes as u in rows, v in columns.
*/
void BKE_subdiv_eval_limit_patch_resolution_point(
Subdiv *subdiv,
const int ptex_face_index,
const int resolution,
void *buffer, const int offset, const int stride);
void BKE_subdiv_eval_limit_patch_resolution_point_and_derivatives(
Subdiv *subdiv,
const int ptex_face_index,
const int resolution,
void *point_buffer, const int point_offset, const int point_stride,
void *du_buffer, const int du_offset, const int du_stride,
void *dv_buffer, const int dv_offset, const int dv_stride);
void BKE_subdiv_eval_limit_patch_resolution_point_and_normal(
Subdiv *subdiv,
const int ptex_face_index,
const int resolution,
void *point_buffer, const int point_offset, const int point_stride,
void *normal_buffer, const int normal_offset, const int normal_stride);
void BKE_subdiv_eval_limit_patch_resolution_point_and_short_normal(
Subdiv *subdiv,
const int ptex_face_index,
const int resolution,
void *point_buffer, const int point_offset, const int point_stride,
void *normal_buffer, const int normal_offset, const int normal_stride);
/* ========================== FOREACH/TRAVERSE API ========================== */
struct SubdivForeachContext;
typedef bool (*SubdivForeachTopologyInformationCb)(
const struct SubdivForeachContext *context,
const int num_vertices,
const int num_edges,
const int num_loops,
const int num_polygons);
typedef void (*SubdivForeachVertexFromCornerCb)(
const struct SubdivForeachContext *context,
void *tls,
const int ptex_face_index,
const float u, const float v,
const int coarse_vertex_index,
const int coarse_poly_index,
const int coarse_corner,
const int subdiv_vertex_index);
typedef void (*SubdivForeachVertexFromEdgeCb)(
const struct SubdivForeachContext *context,
void *tls,
const int ptex_face_index,
const float u, const float v,
const int coarse_edge_index,
const int coarse_poly_index,
const int coarse_corner,
const int subdiv_vertex_index);
typedef void (*SubdivForeachVertexInnerCb)(
const struct SubdivForeachContext *context,
void *tls,
const int ptex_face_index,
const float u, const float v,
const int coarse_poly_index,
const int coarse_corner,
const int subdiv_vertex_index);
typedef void (*SubdivForeachEdgeCb)(
const struct SubdivForeachContext *context,
void *tls,
const int coarse_edge_index,
const int subdiv_edge_index,
const int subdiv_v1, const int subdiv_v2);
typedef void (*SubdivForeachLoopCb)(
const struct SubdivForeachContext *context,
void *tls,
const int ptex_face_index,
const float u, const float v,
const int coarse_loop_index,
const int coarse_poly_index,
const int coarse_corner,
const int subdiv_loop_index,
const int subdiv_vertex_index, const int subdiv_edge_index);
typedef void (*SubdivForeachPolygonCb)(
const struct SubdivForeachContext *context,
void *tls,
const int coarse_poly_index,
const int subdiv_poly_index,
const int start_loop_index, const int num_loops);
typedef void (*SubdivForeachLooseCb)(
const struct SubdivForeachContext *context,
void *tls,
const int coarse_vertex_index,
const int subdiv_vertex_index);
typedef void (*SubdivForeachVertexOfLooseEdgeCb)(
const struct SubdivForeachContext *context,
void *tls,
const int coarse_edge_index,
const float u,
const int subdiv_vertex_index);
typedef struct SubdivForeachContext {
/* Is called when topology information becomes available.
* Is only called once.
*
* NOTE: If this callback returns false, the foreach loop is aborted.
*/
SubdivForeachTopologyInformationCb topology_info;
/* These callbacks are called from every ptex which shares "emitting"
* vertex or edge.
*/
SubdivForeachVertexFromCornerCb vertex_every_corner;
SubdivForeachVertexFromEdgeCb vertex_every_edge;
/* Those callbacks are run once per subdivision vertex, ptex is undefined
* as in it will be whatever first ptex face happened to be tarversed in
* the multi-threaded environment ahd which shares "emitting" vertex or
* edge.
*/
SubdivForeachVertexFromCornerCb vertex_corner;
SubdivForeachVertexFromEdgeCb vertex_edge;
/* Called exactly once, always corresponds to a single ptex face. */
SubdivForeachVertexInnerCb vertex_inner;
/* Called once for each loose vertex. One loose coarse vertexcorresponds
* to a single subdivision vertex.
*/
SubdivForeachLooseCb vertex_loose;
/* Called once per vertex created for loose edge. */
SubdivForeachVertexOfLooseEdgeCb vertex_of_loose_edge;
/* NOTE: If subdivided edge does not come from coarse edge, ORIGINDEX_NONE
* will be passed as coarse_edge_index.
*/
SubdivForeachEdgeCb edge;
/* NOTE: If subdivided loop does not come from coarse loop, ORIGINDEX_NONE
* will be passed as coarse_loop_index.
*/
SubdivForeachLoopCb loop;
SubdivForeachPolygonCb poly;
/* User-defined pointer, to allow callbacks know something about context the
* traversal is happening for,
*/
void *user_data;
/* Initial value of TLS data. */
void *user_data_tls;
/* Size of TLS data. */
size_t user_data_tls_size;
/* Function to free TLS storage. */
void (*user_data_tls_free)(void *tls);
} SubdivForeachContext;
/* Invokes callbacks in the order and with values which corresponds to creation
* of final subdivided mesh.
*
* Returns truth if the whole topology was traversed, without any early exits.
*
* TODO(sergey): Need to either get rid of subdiv or of coarse_mesh.
* The main point here is th be abel to get base level topology, which can be
* done with either of those. Having both of them is kind of redundant.
*/
bool BKE_subdiv_foreach_subdiv_geometry(
struct Subdiv *subdiv,
const struct SubdivForeachContext *context,
const struct SubdivToMeshSettings *mesh_settings,
const struct Mesh *coarse_mesh);
/* =========================== SUBDIV TO MESH API =========================== */
typedef struct SubdivToMeshSettings {
/* Resolution at which ptex are being evaluated.
* This defines how many vertices final mesh will have: every ptex has
* resolution^2 vertices.
*/
int resolution;
} SubdivToMeshSettings;
/* Create real hi-res mesh from subdivision, all geometry is "real". */
struct Mesh *BKE_subdiv_to_mesh(
Subdiv *subdiv,
const SubdivToMeshSettings *settings,
const struct Mesh *coarse_mesh);
/* ============================ DISPLACEMENT API ============================ */
void BKE_subdiv_displacement_attach_from_multires(
Subdiv *subdiv,
const struct Object *object,
const struct MultiresModifierData *mmd);
void BKE_subdiv_displacement_detach(Subdiv *subdiv);
#endif /* __BKE_SUBDIV_H__ */
|