Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_pbvh.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BKE_PBVH_H__
22 #define __BKE_PBVH_H__
23
24 /** \file BKE_pbvh.h
25  *  \ingroup bke
26  *  \brief A BVH for high poly meshes.
27  */
28
29 #include "BLI_bitmap.h"
30 #include "BLI_ghash.h"
31 #include "BLI_utildefines.h"
32
33 struct GPUBatch;
34 struct CCGElem;
35 struct CCGKey;
36 struct CCGDerivedMesh;
37 struct CustomData;
38 struct DMFlagMat;
39 struct MPoly;
40 struct MLoop;
41 struct MLoopTri;
42 struct MVert;
43 struct PBVH;
44 struct PBVHNode;
45 struct BMesh;
46 struct BMLog;
47
48 typedef struct PBVH PBVH;
49 typedef struct PBVHNode PBVHNode;
50
51 typedef struct {
52         float (*co)[3];
53 } PBVHProxyNode;
54
55 /* Callbacks */
56
57 /* returns 1 if the search should continue from this node, 0 otherwise */
58 typedef bool (*BKE_pbvh_SearchCallback)(PBVHNode *node, void *data);
59
60 typedef void (*BKE_pbvh_HitCallback)(PBVHNode *node, void *data);
61 typedef void (*BKE_pbvh_HitOccludedCallback)(PBVHNode *node, void *data, float *tmin);
62
63 typedef void (*BKE_pbvh_SearchNearestCallback)(PBVHNode *node, void *data, float *tmin);
64
65 /* Building */
66
67 PBVH *BKE_pbvh_new(void);
68 void BKE_pbvh_build_mesh(
69         PBVH *bvh,
70         const struct MPoly *mpoly, const struct MLoop *mloop,
71         struct MVert *verts, int totvert, struct CustomData *vdata,
72         const struct MLoopTri *looptri, int looptri_num);
73 void BKE_pbvh_build_grids(PBVH *bvh, struct CCGElem **grid_elems,
74                           int totgrid,
75                           struct CCGKey *key, void **gridfaces, struct DMFlagMat *flagmats,
76                           unsigned int **grid_hidden);
77 void BKE_pbvh_build_bmesh(PBVH *bvh, struct BMesh *bm, bool smooth_shading, struct BMLog *log, const int cd_vert_node_offset, const int cd_face_node_offset);
78 void BKE_pbvh_free(PBVH *bvh);
79 void BKE_pbvh_free_layer_disp(PBVH *bvh);
80
81 /* Hierarchical Search in the BVH, two methods:
82  * - for each hit calling a callback
83  * - gather nodes in an array (easy to multithread) */
84
85 void BKE_pbvh_search_callback(PBVH *bvh,
86                               BKE_pbvh_SearchCallback scb, void *search_data,
87                               BKE_pbvh_HitCallback hcb, void *hit_data);
88
89 void BKE_pbvh_search_gather(PBVH *bvh,
90                             BKE_pbvh_SearchCallback scb, void *search_data,
91                             PBVHNode ***array, int *tot);
92
93 /* Raycast
94  * the hit callback is called for all leaf nodes intersecting the ray;
95  * it's up to the callback to find the primitive within the leaves that is
96  * hit first */
97
98 void BKE_pbvh_raycast(
99         PBVH *bvh, BKE_pbvh_HitOccludedCallback cb, void *data,
100         const float ray_start[3], const float ray_normal[3],
101         bool original);
102
103 bool BKE_pbvh_node_raycast(
104         PBVH *bvh, PBVHNode *node, float (*origco)[3], bool use_origco,
105         const float ray_start[3], const float ray_normal[3],
106         float *depth);
107
108 bool BKE_pbvh_bmesh_node_raycast_detail(
109         PBVHNode *node,
110         const float ray_start[3], const float ray_normal[3],
111         float *depth, float *r_detail);
112
113 /* for orthographic cameras, project the far away ray segment points to the root node so
114  * we can have better precision. */
115 void BKE_pbvh_raycast_project_ray_root(
116         PBVH *bvh, bool original,
117         float ray_start[3], float ray_end[3], float ray_normal[3]);
118
119 void BKE_pbvh_find_nearest_to_ray(
120         PBVH *bvh, BKE_pbvh_HitOccludedCallback cb, void *data,
121         const float ray_start[3], const float ray_normal[3],
122         bool original);
123
124 bool BKE_pbvh_node_find_nearest_to_ray(
125         PBVH *bvh, PBVHNode *node, float (*origco)[3], bool use_origco,
126         const float ray_start[3], const float ray_normal[3],
127         float *depth, float *dist_sq);
128
129 /* Drawing */
130
131 void BKE_pbvh_draw_cb(
132         PBVH *bvh, float (*planes)[4], float (*fnors)[3], bool fast, bool only_mask,
133         void (*draw_fn)(void *user_data, struct GPUBatch *batch), void *user_data);
134
135 /* PBVH Access */
136 typedef enum {
137         PBVH_FACES,
138         PBVH_GRIDS,
139         PBVH_BMESH
140 } PBVHType;
141
142 PBVHType BKE_pbvh_type(const PBVH *bvh);
143 bool     BKE_pbvh_has_faces(const PBVH *bvh);
144
145 /* Get the PBVH root's bounding box */
146 void BKE_pbvh_bounding_box(const PBVH *bvh, float min[3], float max[3]);
147
148 /* multires hidden data, only valid for type == PBVH_GRIDS */
149 unsigned int **BKE_pbvh_grid_hidden(const PBVH *bvh);
150
151 int BKE_pbvh_count_grid_quads(BLI_bitmap **grid_hidden,
152                               int *grid_indices, int totgrid,
153                               int gridsize);
154
155 /* multires level, only valid for type == PBVH_GRIDS */
156 void BKE_pbvh_get_grid_key(const PBVH *pbvh, struct CCGKey *key);
157
158 /* Only valid for type == PBVH_BMESH */
159 struct BMesh *BKE_pbvh_get_bmesh(PBVH *pbvh);
160 void BKE_pbvh_bmesh_detail_size_set(PBVH *pbvh, float detail_size);
161
162 typedef enum {
163         PBVH_Subdivide = 1,
164         PBVH_Collapse = 2,
165 } PBVHTopologyUpdateMode;
166 bool BKE_pbvh_bmesh_update_topology(
167         PBVH *bvh, PBVHTopologyUpdateMode mode,
168         const float center[3], const float view_normal[3],
169         float radius, const bool use_frontface, const bool use_projected);
170
171 /* Node Access */
172
173 typedef enum {
174         PBVH_Leaf = 1,
175
176         PBVH_UpdateNormals = 2,
177         PBVH_UpdateBB = 4,
178         PBVH_UpdateOriginalBB = 8,
179         PBVH_UpdateDrawBuffers = 16,
180         PBVH_UpdateRedraw = 32,
181
182         PBVH_RebuildDrawBuffers = 64,
183         PBVH_FullyHidden = 128,
184
185         PBVH_UpdateTopology = 256,
186 } PBVHNodeFlags;
187
188 void BKE_pbvh_node_mark_update(PBVHNode *node);
189 void BKE_pbvh_node_mark_rebuild_draw(PBVHNode *node);
190 void BKE_pbvh_node_mark_redraw(PBVHNode *node);
191 void BKE_pbvh_node_mark_normals_update(PBVHNode *node);
192 void BKE_pbvh_node_mark_topology_update(PBVHNode *node);
193 void BKE_pbvh_node_fully_hidden_set(PBVHNode *node, int fully_hidden);
194
195 void BKE_pbvh_node_get_grids(
196         PBVH *bvh, PBVHNode *node,
197         int **grid_indices, int *totgrid, int *maxgrid, int *gridsize,
198         struct CCGElem ***grid_elems);
199 void BKE_pbvh_node_num_verts(
200         PBVH *bvh, PBVHNode *node,
201         int *r_uniquevert, int *r_totvert);
202 void BKE_pbvh_node_get_verts(
203         PBVH *bvh, PBVHNode *node,
204         const int **r_vert_indices, struct MVert **r_verts);
205
206 void BKE_pbvh_node_get_BB(PBVHNode *node, float bb_min[3], float bb_max[3]);
207 void BKE_pbvh_node_get_original_BB(PBVHNode *node, float bb_min[3], float bb_max[3]);
208
209 float BKE_pbvh_node_get_tmin(PBVHNode *node);
210
211 /* test if AABB is at least partially inside the planes' volume */
212 bool BKE_pbvh_node_planes_contain_AABB(PBVHNode *node, void *data);
213 /* test if AABB is at least partially outside the planes' volume */
214 bool BKE_pbvh_node_planes_exclude_AABB(PBVHNode *node, void *data);
215
216 struct GSet *BKE_pbvh_bmesh_node_unique_verts(PBVHNode *node);
217 struct GSet *BKE_pbvh_bmesh_node_other_verts(PBVHNode *node);
218 struct GSet *BKE_pbvh_bmesh_node_faces(PBVHNode *node);
219 void BKE_pbvh_bmesh_node_save_orig(PBVHNode *node);
220 void BKE_pbvh_bmesh_after_stroke(PBVH *bvh);
221
222 /* Update Normals/Bounding Box/Redraw and clear flags */
223
224 void BKE_pbvh_update(PBVH *bvh, int flags, float (*face_nors)[3]);
225 void BKE_pbvh_redraw_BB(PBVH *bvh, float bb_min[3], float bb_max[3]);
226 void BKE_pbvh_get_grid_updates(PBVH *bvh, bool clear, void ***r_gridfaces, int *r_totface);
227 void BKE_pbvh_grids_update(PBVH *bvh, struct CCGElem **grid_elems,
228                            void **gridfaces,
229                            struct DMFlagMat *flagmats, unsigned int **grid_hidden);
230
231 /* Layer displacement */
232
233 /* Get the node's displacement layer, creating it if necessary */
234 float *BKE_pbvh_node_layer_disp_get(PBVH *pbvh, PBVHNode *node);
235
236 /* If the node has a displacement layer, free it and set to null */
237 void BKE_pbvh_node_layer_disp_free(PBVHNode *node);
238
239 /* vertex deformer */
240 float (*BKE_pbvh_get_vertCos(struct PBVH *pbvh))[3];
241 void BKE_pbvh_apply_vertCos(struct PBVH *pbvh, float (*vertCos)[3], const int totvert);
242 bool BKE_pbvh_isDeformed(struct PBVH *pbvh);
243
244 /* Vertex Iterator */
245
246 /* this iterator has quite a lot of code, but it's designed to:
247  * - allow the compiler to eliminate dead code and variables
248  * - spend most of the time in the relatively simple inner loop */
249
250 /* note: PBVH_ITER_ALL does not skip hidden vertices,
251  * PBVH_ITER_UNIQUE does */
252 #define PBVH_ITER_ALL       0
253 #define PBVH_ITER_UNIQUE    1
254
255 typedef struct PBVHVertexIter {
256         /* iteration */
257         int g;
258         int width;
259         int height;
260         int gx;
261         int gy;
262         int i;
263
264         /* grid */
265         struct CCGElem **grids;
266         struct CCGElem *grid;
267         struct CCGKey *key;
268         BLI_bitmap **grid_hidden, *gh;
269         int *grid_indices;
270         int totgrid;
271         int gridsize;
272
273         /* mesh */
274         struct MVert *mverts;
275         int totvert;
276         const int *vert_indices;
277         float *vmask;
278
279         /* bmesh */
280         struct GSetIterator bm_unique_verts;
281         struct GSetIterator bm_other_verts;
282         struct CustomData *bm_vdata;
283         int cd_vert_mask_offset;
284
285         /* result: these are all computed in the macro, but we assume
286          * that compiler optimization's will skip the ones we don't use */
287         struct MVert *mvert;
288         struct BMVert *bm_vert;
289         float *co;
290         short *no;
291         float *fno;
292         float *mask;
293 } PBVHVertexIter;
294
295 void pbvh_vertex_iter_init(PBVH *bvh, PBVHNode *node,
296                            PBVHVertexIter *vi, int mode);
297
298 #define BKE_pbvh_vertex_iter_begin(bvh, node, vi, mode) \
299         pbvh_vertex_iter_init(bvh, node, &vi, mode); \
300          \
301         for (vi.i = 0, vi.g = 0; vi.g < vi.totgrid; vi.g++) { \
302                 if (vi.grids) { \
303                         vi.width = vi.gridsize; \
304                         vi.height = vi.gridsize; \
305                         vi.grid = vi.grids[vi.grid_indices[vi.g]]; \
306                         if (mode == PBVH_ITER_UNIQUE) \
307                                 vi.gh = vi.grid_hidden[vi.grid_indices[vi.g]];   \
308                 } \
309                 else { \
310                         vi.width = vi.totvert; \
311                         vi.height = 1; \
312                 } \
313                  \
314                 for (vi.gy = 0; vi.gy < vi.height; vi.gy++) { \
315                         for (vi.gx = 0; vi.gx < vi.width; vi.gx++, vi.i++) { \
316                                 if (vi.grid) { \
317                                         vi.co = CCG_elem_co(vi.key, vi.grid); \
318                                         vi.fno = CCG_elem_no(vi.key, vi.grid); \
319                                         vi.mask = vi.key->has_mask ? CCG_elem_mask(vi.key, vi.grid) : NULL; \
320                                         vi.grid = CCG_elem_next(vi.key, vi.grid); \
321                                         if (vi.gh) { \
322                                                 if (BLI_BITMAP_TEST(vi.gh, vi.gy * vi.gridsize + vi.gx)) \
323                                                         continue; \
324                                         } \
325                                 } \
326                                 else if (vi.mverts) { \
327                                         vi.mvert = &vi.mverts[vi.vert_indices[vi.gx]]; \
328                                         if (mode == PBVH_ITER_UNIQUE && vi.mvert->flag & ME_HIDE) \
329                                                 continue; \
330                                         vi.co = vi.mvert->co; \
331                                         vi.no = vi.mvert->no; \
332                                         if (vi.vmask) \
333                                                 vi.mask = &vi.vmask[vi.vert_indices[vi.gx]]; \
334                                 } \
335                                 else { \
336                                         if (!BLI_gsetIterator_done(&vi.bm_unique_verts)) {\
337                                                 vi.bm_vert = BLI_gsetIterator_getKey(&vi.bm_unique_verts); \
338                                                 BLI_gsetIterator_step(&vi.bm_unique_verts); \
339                                         } \
340                                         else { \
341                                                 vi.bm_vert = BLI_gsetIterator_getKey(&vi.bm_other_verts); \
342                                                 BLI_gsetIterator_step(&vi.bm_other_verts); \
343                                         } \
344                                         if (mode == PBVH_ITER_UNIQUE && \
345                                                 BM_elem_flag_test(vi.bm_vert, BM_ELEM_HIDDEN)) \
346                                                 continue; \
347                                         vi.co = vi.bm_vert->co; \
348                                         vi.fno = vi.bm_vert->no; \
349                                         vi.mask = BM_ELEM_CD_GET_VOID_P(vi.bm_vert, vi.cd_vert_mask_offset); \
350                                 }
351
352 #define BKE_pbvh_vertex_iter_end \
353                         } \
354                 } \
355         }
356
357 void BKE_pbvh_node_get_proxies(PBVHNode *node, PBVHProxyNode **proxies, int *proxy_count);
358 void BKE_pbvh_node_free_proxies(PBVHNode *node);
359 PBVHProxyNode *BKE_pbvh_node_add_proxy(PBVH *bvh, PBVHNode *node);
360 void BKE_pbvh_gather_proxies(PBVH *pbvh, PBVHNode ***nodes,  int *totnode);
361 void BKE_pbvh_node_get_bm_orco_data(
362         PBVHNode *node,
363         int (**r_orco_tris)[3], int *r_orco_tris_num, float (**r_orco_coords)[3]);
364
365 bool BKE_pbvh_node_vert_update_check_any(PBVH *bvh, PBVHNode *node);
366
367 //void BKE_pbvh_node_BB_reset(PBVHNode *node);
368 //void BKE_pbvh_node_BB_expand(PBVHNode *node, float co[3]);
369
370 bool pbvh_has_mask(PBVH *bvh);
371 void pbvh_show_diffuse_color_set(PBVH *bvh, bool show_diffuse_color);
372 void pbvh_show_mask_set(PBVH *bvh, bool show_mask);
373
374 #endif /* __BKE_PBVH_H__ */