doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_subdiv.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) 2018 by Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #ifndef __BKE_SUBDIV_H__
25 #define __BKE_SUBDIV_H__
26
27 #include "BLI_compiler_compat.h"
28 #include "BLI_sys_types.h"
29
30 struct Mesh;
31 struct MultiresModifierData;
32 struct Object;
33 struct OpenSubdiv_Converter;
34 struct OpenSubdiv_Evaluator;
35 struct OpenSubdiv_TopologyRefiner;
36 struct Subdiv;
37 struct SubdivToMeshSettings;
38
39 typedef enum eSubdivVtxBoundaryInterpolation {
40   /* Do not interpolate boundaries. */
41   SUBDIV_VTX_BOUNDARY_NONE,
42   /* Sharpen edges. */
43   SUBDIV_VTX_BOUNDARY_EDGE_ONLY,
44   /* sharpen edges and corners, */
45   SUBDIV_VTX_BOUNDARY_EDGE_AND_CORNER,
46 } eSubdivVtxBoundaryInterpolation;
47
48 typedef enum eSubdivFVarLinearInterpolation {
49         SUBDIV_FVAR_LINEAR_INTERPOLATION_NONE,
50         SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_ONLY,
51         SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_AND_JUNCTIONS,
52         SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_JUNCTIONS_AND_CONCAVE,
53         SUBDIV_FVAR_LINEAR_INTERPOLATION_BOUNDARIES,
54         SUBDIV_FVAR_LINEAR_INTERPOLATION_ALL,
55 } eSubdivFVarLinearInterpolation;
56
57 typedef struct SubdivSettings {
58         bool is_simple;
59         bool is_adaptive;
60         int level;
61         eSubdivVtxBoundaryInterpolation vtx_boundary_interpolation;
62         eSubdivFVarLinearInterpolation fvar_linear_interpolation;
63 } SubdivSettings;
64
65 /* NOTE: Order of enumerators MUST match order of values in SubdivStats. */
66 typedef enum eSubdivStatsValue {
67         SUBDIV_STATS_TOPOLOGY_REFINER_CREATION_TIME = 0,
68         SUBDIV_STATS_SUBDIV_TO_MESH,
69         SUBDIV_STATS_SUBDIV_TO_MESH_GEOMETRY,
70         SUBDIV_STATS_EVALUATOR_CREATE,
71         SUBDIV_STATS_EVALUATOR_REFINE,
72         SUBDIV_STATS_SUBDIV_TO_CCG,
73         SUBDIV_STATS_SUBDIV_TO_CCG_ELEMENTS,
74         SUBDIV_STATS_TOPOLOGY_COMPARE,
75
76         NUM_SUBDIV_STATS_VALUES,
77 } eSubdivStatsValue;
78
79 typedef struct SubdivStats {
80         union {
81                 struct {
82                         /* Time spend on creating topology refiner, which includes time
83                          * spend on conversion from Blender data to OpenSubdiv data, and
84                          * time spend on topology orientation on OpenSubdiv C-API side. */
85                         double topology_refiner_creation_time;
86                         /* Total time spent in BKE_subdiv_to_mesh(). */
87                         double subdiv_to_mesh_time;
88                         /* Geometry (MVert and co) creation time during SUBDIV_TYO_MESH. */
89                         double subdiv_to_mesh_geometry_time;
90                         /* Time spent on evaluator creation from topology refiner. */
91                         double evaluator_creation_time;
92                         /* Time spent on evaluator->refine(). */
93                         double evaluator_refine_time;
94                         /* Total time spent on whole CCG creation. */
95                         double subdiv_to_ccg_time;
96                         /* Time spent on CCG elements evaluation/initialization. */
97                         double subdiv_to_ccg_elements_time;
98                         /* Time spent on CCG elements evaluation/initialization. */
99                         double topology_compare_time;
100                 };
101                 double values_[NUM_SUBDIV_STATS_VALUES];
102         };
103
104         /* Per-value timestamp on when corresponding BKE_subdiv_stats_begin() was
105          * called. */
106         double begin_timestamp_[NUM_SUBDIV_STATS_VALUES];
107 } SubdivStats;
108
109 /* Functor which evaluates dispalcement at a given (u, v) of given ptex face. */
110 typedef struct SubdivDisplacement {
111         /* Initialize displacement evaluator.
112          *
113          * Is called right before evaluation is actually needed. This allows to do
114          * some lazy initialization, like allocate evaluator from a main thread but
115          * then do actual evaluation from background job. */
116         void (*initialize)(struct SubdivDisplacement *displacement);
117
118         /* Return displacement which is to be added to the original coordinate.
119          *
120          * NOTE: This function is supposed to return "continuous" displacement for
121          * each pf PTex faces created for special (non-quad) polygon. This means,
122          * if displacement is stored on per-corner manner (like MDisps for multires)
123          * this is up the displacement implementation to average boundaries of the
124          * displacement grids if needed.
125          *
126          * Averaging of displacement for vertices created for over coarse vertices
127          * and edges is done by subdiv code. */
128         void (*eval_displacement)(struct SubdivDisplacement *displacement,
129                                   const int ptex_face_index,
130                                   const float u, const float v,
131                                   const float dPdu[3], const float dPdv[3],
132                                   float r_D[3]);
133
134         /* Free the data, not the evaluator itself. */
135         void (*free)(struct SubdivDisplacement *displacement);
136
137         void *user_data;
138 } SubdivDisplacement;
139
140 /* This structure contains everything needed to construct subdivided surface.
141  * It does not specify storage, memory layout or anything else.
142  * It is possible to create different storages (like, grid based CPU side
143  * buffers, GPU subdivision mesh, CPU side fully qualified mesh) from the same
144  * Subdiv structure. */
145 typedef struct Subdiv {
146         /* Settings this subdivision surface is created for.
147          *
148          * It is read-only after assignment in BKE_subdiv_new_from_FOO().
149          */
150         SubdivSettings settings;
151         /* Topology refiner includes all the glue logic to feed Blender side
152          * topology to OpenSubdiv. It can be shared by both evaluator and GL mesh
153          * drawer. */
154         struct OpenSubdiv_TopologyRefiner *topology_refiner;
155         /* CPU side evaluator. */
156         struct OpenSubdiv_Evaluator *evaluator;
157         /* Optional displacement evaluator. */
158         struct SubdivDisplacement *displacement_evaluator;
159         /* Statistics for debugging. */
160         SubdivStats stats;
161
162         /* Cached values, are not supposed to be accessed directly. */
163         struct {
164                 /* Indexed by base face index, element indicates total number of ptex
165                  *faces created for preceding base faces. */
166                 int *face_ptex_offset;
167         } cache_;
168 } Subdiv;
169
170 /* ========================== CONVERSION HELPERS ============================ */
171
172 /* NOTE: uv_smooth is eSubsurfUVSmooth. */
173 eSubdivFVarLinearInterpolation
174 BKE_subdiv_fvar_interpolation_from_uv_smooth(int uv_smooth);
175
176 /* =============================== STATISTICS =============================== */
177
178 void BKE_subdiv_stats_init(SubdivStats *stats);
179
180 void BKE_subdiv_stats_begin(SubdivStats *stats, eSubdivStatsValue value);
181 void BKE_subdiv_stats_end(SubdivStats *stats, eSubdivStatsValue value);
182
183 void BKE_subdiv_stats_reset(SubdivStats *stats, eSubdivStatsValue value);
184
185 void BKE_subdiv_stats_print(const SubdivStats *stats);
186
187 /* ================================ SETTINGS ================================ */
188
189 void BKE_subdiv_settings_validate_for_mesh(SubdivSettings *settings,
190                                            const struct Mesh *mesh);
191
192 bool BKE_subdiv_settings_equal(const SubdivSettings *settings_a,
193                                const SubdivSettings *settings_b);
194
195 /* ============================== CONSTRUCTION ============================== */
196
197 /* Construct new subdivision surface descriptor, from scratch, using given
198  * settings and topology. */
199 Subdiv *BKE_subdiv_new_from_converter(const SubdivSettings *settings,
200                                       struct OpenSubdiv_Converter *converter);
201 Subdiv *BKE_subdiv_new_from_mesh(const SubdivSettings *settings,
202                                  const struct Mesh *mesh);
203
204 /* Similar to above, but will not re-create descriptor if it was created for the
205  * same settings and topology.
206  * If settings or topology did change, the existing descriptor is freed and a
207  * new one is created from scratch.
208  *
209  * NOTE: It is allowed to pass NULL as an existing subdivision surface
210  * descriptor. This will create enw descriptor without any extra checks.
211  */
212 Subdiv *BKE_subdiv_update_from_converter(
213         Subdiv *subdiv,
214         const SubdivSettings *settings,
215         struct OpenSubdiv_Converter *converter);
216 Subdiv *BKE_subdiv_update_from_mesh(
217         Subdiv *subdiv,
218         const SubdivSettings *settings,
219         const struct Mesh *mesh);
220
221 void BKE_subdiv_free(Subdiv *subdiv);
222
223 /* ============================ DISPLACEMENT API ============================ */
224
225 void BKE_subdiv_displacement_attach_from_multires(
226         Subdiv *subdiv,
227         struct Mesh *mesh,
228         const struct MultiresModifierData *mmd);
229
230 void BKE_subdiv_displacement_detach(Subdiv *subdiv);
231
232 /* ============================ TOPOLOGY HELPERS ============================ */
233
234 int *BKE_subdiv_face_ptex_offset_get(Subdiv *subdiv);
235
236 /* =========================== PTEX FACES AND GRIDS ========================= */
237
238 /* For a given (ptex_u, ptex_v) within a ptex face get corresponding
239  * (grid_u, grid_v) within a grid. */
240 BLI_INLINE void BKE_subdiv_ptex_face_uv_to_grid_uv(
241         const float ptex_u, const float ptex_v,
242         float *r_grid_u, float *r_grid_v);
243
244 /* Onverse of above. */
245 BLI_INLINE void BKE_subdiv_grid_uv_to_ptex_face_uv(
246         const float grid_u, const float grid_v,
247         float *r_ptex_u, float *r_ptex_v);
248
249 /* For a given subdivision level (which is NOT refinement level) get size of
250  * CCG grid (number of grid points on a side).
251  */
252 BLI_INLINE int BKE_subdiv_grid_size_from_level(const int level);
253
254 /* Simplified version of mdisp_rot_face_to_crn, only handles quad and
255  * works in normalized coordinates.
256  *
257  * NOTE: Output coordinates are in ptex coordinates. */
258 BLI_INLINE int BKE_subdiv_rotate_quad_to_corner(
259         const float quad_u, const float quad_v,
260         float *r_corner_u, float *r_corner_v);
261
262 /* Converts (u, v) coordinate from within a grid to a quad coordinate in
263  * normalized ptex coordinates. */
264 BLI_INLINE void BKE_subdiv_rotate_grid_to_quad(
265         const int corner,
266         const float grid_u, const float grid_v,
267         float *r_quad_u, float *r_quad_v);
268
269 #include "intern/subdiv_inline.h"
270
271 #endif  /* __BKE_SUBDIV_H__ */