svn merge ^/trunk/blender -r47201:47210
[blender.git] / source / blender / blenlib / BLI_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 __BLI_PBVH_H__
22 #define __BLI_PBVH_H__
23
24 /** \file BLI_pbvh.h
25  *  \ingroup bli
26  *  \brief A BVH for high poly meshes.
27  */
28
29 #include "BLI_bitmap.h"
30
31 struct CCGElem;
32 struct CCGKey;
33 struct CustomData;
34 struct DMFlagMat;
35 struct DMGridAdjacency;
36 struct ListBase;
37 struct MFace;
38 struct MVert;
39 struct PBVH;
40 struct PBVHNode;
41
42 typedef struct PBVH PBVH;
43 typedef struct PBVHNode PBVHNode;
44
45 typedef struct {
46         float (*co)[3];
47 } PBVHProxyNode;
48
49 /* Callbacks */
50
51 /* returns 1 if the search should continue from this node, 0 otherwise */
52 typedef int (*BLI_pbvh_SearchCallback)(PBVHNode *node, void *data);
53
54 typedef void (*BLI_pbvh_HitCallback)(PBVHNode *node, void *data);
55 typedef void (*BLI_pbvh_HitOccludedCallback)(PBVHNode *node, void *data, float *tmin);
56
57 /* Building */
58
59 PBVH *BLI_pbvh_new(void);
60 void BLI_pbvh_build_mesh(PBVH *bvh, struct MFace *faces, struct MVert *verts,
61                          int totface, int totvert, struct CustomData *vdata);
62 void BLI_pbvh_build_grids(PBVH *bvh, struct CCGElem **grid_elems,
63                           struct DMGridAdjacency *gridadj, int totgrid,
64                           struct CCGKey *key, void **gridfaces, struct DMFlagMat *flagmats,
65                           unsigned int **grid_hidden);
66 void BLI_pbvh_free(PBVH *bvh);
67
68 /* Hierarchical Search in the BVH, two methods:
69  * - for each hit calling a callback
70  * - gather nodes in an array (easy to multithread) */
71
72 void BLI_pbvh_search_callback(PBVH *bvh,
73                               BLI_pbvh_SearchCallback scb, void *search_data,
74                               BLI_pbvh_HitCallback hcb, void *hit_data);
75
76 void BLI_pbvh_search_gather(PBVH *bvh,
77                             BLI_pbvh_SearchCallback scb, void *search_data,
78                             PBVHNode ***array, int *tot);
79
80 /* Raycast
81  * the hit callback is called for all leaf nodes intersecting the ray;
82  * it's up to the callback to find the primitive within the leaves that is
83  * hit first */
84
85 void BLI_pbvh_raycast(PBVH * bvh, BLI_pbvh_HitOccludedCallback cb, void *data,
86                       float ray_start[3], float ray_normal[3], int original);
87 int BLI_pbvh_node_raycast(PBVH * bvh, PBVHNode * node, float (*origco)[3],
88                           float ray_start[3], float ray_normal[3], float *dist);
89
90 /* Drawing */
91
92 void BLI_pbvh_node_draw(PBVHNode *node, void *data);
93 void BLI_pbvh_draw(PBVH *bvh, float (*planes)[4], float (*face_nors)[3],
94                    int (*setMaterial)(int, void *attribs));
95
96 /* PBVH Access */
97 typedef enum {
98         PBVH_FACES,
99         PBVH_GRIDS,
100 } PBVHType;
101
102 PBVHType BLI_pbvh_type(const PBVH *bvh);
103
104 /* multires hidden data, only valid for type == PBVH_GRIDS */
105 unsigned int **BLI_pbvh_grid_hidden(const PBVH *bvh);
106
107 /* multires level, only valid for type == PBVH_GRIDS */
108 void BLI_pbvh_get_grid_key(const PBVH *pbvh, struct CCGKey *key);
109
110 /* Node Access */
111
112 typedef enum {
113         PBVH_Leaf = 1,
114
115         PBVH_UpdateNormals = 2,
116         PBVH_UpdateBB = 4,
117         PBVH_UpdateOriginalBB = 8,
118         PBVH_UpdateDrawBuffers = 16,
119         PBVH_UpdateRedraw = 32,
120
121         PBVH_RebuildDrawBuffers = 64,
122         PBVH_FullyHidden = 128
123 } PBVHNodeFlags;
124
125 void BLI_pbvh_node_mark_update(PBVHNode *node);
126 void BLI_pbvh_node_mark_rebuild_draw(PBVHNode *node);
127 void BLI_pbvh_node_fully_hidden_set(PBVHNode *node, int fully_hidden);
128
129 void BLI_pbvh_node_get_grids(PBVH *bvh, PBVHNode *node,
130                              int **grid_indices, int *totgrid, int *maxgrid, int *gridsize,
131                              struct CCGElem ***grid_elems, struct DMGridAdjacency **gridadj);
132 void BLI_pbvh_node_num_verts(PBVH *bvh, PBVHNode *node,
133                              int *uniquevert, int *totvert);
134 void BLI_pbvh_node_get_verts(PBVH *bvh, PBVHNode *node,
135                              int **vert_indices, struct MVert **verts);
136
137 void BLI_pbvh_node_get_BB(PBVHNode * node, float bb_min[3], float bb_max[3]);
138 void BLI_pbvh_node_get_original_BB(PBVHNode * node, float bb_min[3], float bb_max[3]);
139
140 float BLI_pbvh_node_get_tmin(PBVHNode *node);
141
142 /* test if AABB is at least partially inside the planes' volume */
143 int BLI_pbvh_node_planes_contain_AABB(PBVHNode *node, void *data);
144 /* test if AABB is at least partially outside the planes' volume */
145 int BLI_pbvh_node_planes_exclude_AABB(PBVHNode *node, void *data);
146
147 /* Update Normals/Bounding Box/Draw Buffers/Redraw and clear flags */
148
149 void BLI_pbvh_update(PBVH *bvh, int flags, float (*face_nors)[3]);
150 void BLI_pbvh_redraw_BB(PBVH * bvh, float bb_min[3], float bb_max[3]);
151 void BLI_pbvh_get_grid_updates(PBVH *bvh, int clear, void ***gridfaces, int *totface);
152 void BLI_pbvh_grids_update(PBVH *bvh, struct CCGElem **grid_elems,
153                            struct DMGridAdjacency *gridadj, void **gridfaces);
154
155 /* vertex deformer */
156 float (*BLI_pbvh_get_vertCos(struct PBVH *pbvh))[3];
157 void BLI_pbvh_apply_vertCos(struct PBVH *pbvh, float (*vertCos)[3]);
158 int BLI_pbvh_isDeformed(struct PBVH *pbvh);
159
160
161 /* Vertex Iterator */
162
163 /* this iterator has quite a lot of code, but it's designed to:
164  * - allow the compiler to eliminate dead code and variables
165  * - spend most of the time in the relatively simple inner loop */
166
167 /* note: PBVH_ITER_ALL does not skip hidden vertices,
168  * PBVH_ITER_UNIQUE does */
169 #define PBVH_ITER_ALL       0
170 #define PBVH_ITER_UNIQUE    1
171
172 typedef struct PBVHVertexIter {
173         /* iteration */
174         int g;
175         int width;
176         int height;
177         int gx;
178         int gy;
179         int i;
180
181         /* grid */
182         struct CCGElem **grids;
183         struct CCGElem *grid;
184         struct CCGKey *key;
185         BLI_bitmap *grid_hidden, gh;
186         int *grid_indices;
187         int totgrid;
188         int gridsize;
189
190         /* mesh */
191         struct MVert *mverts;
192         int totvert;
193         int *vert_indices;
194         float *vmask;
195
196         /* result: these are all computed in the macro, but we assume
197          * that compiler optimization's will skip the ones we don't use */
198         struct MVert *mvert;
199         float *co;
200         short *no;
201         float *fno;
202         float *mask;
203 } PBVHVertexIter;
204
205 #ifdef _MSC_VER
206 #pragma warning (disable:4127) // conditional expression is constant
207 #endif
208
209 void pbvh_vertex_iter_init(PBVH *bvh, PBVHNode *node,
210                            PBVHVertexIter *vi, int mode);
211
212 #define BLI_pbvh_vertex_iter_begin(bvh, node, vi, mode) \
213         pbvh_vertex_iter_init(bvh, node, &vi, mode); \
214         \
215         for (vi.i = 0, vi.g = 0; vi.g < vi.totgrid; vi.g++) { \
216                 if (vi.grids) { \
217                         vi.width = vi.gridsize; \
218                         vi.height = vi.gridsize; \
219                         vi.grid = vi.grids[vi.grid_indices[vi.g]]; \
220                         if (mode == PBVH_ITER_UNIQUE) \
221                                 vi.gh = vi.grid_hidden[vi.grid_indices[vi.g]];   \
222                 } \
223                 else { \
224                         vi.width = vi.totvert; \
225                         vi.height = 1; \
226                 } \
227                  \
228                 for (vi.gy = 0; vi.gy < vi.height; vi.gy++) { \
229                         for (vi.gx = 0; vi.gx < vi.width; vi.gx++, vi.i++) { \
230                                 if (vi.grid) { \
231                                         vi.co = CCG_elem_co(vi.key, vi.grid); \
232                                         vi.fno = CCG_elem_no(vi.key, vi.grid); \
233                                         vi.mask = CCG_elem_mask(vi.key, vi.grid); \
234                                         vi.grid = CCG_elem_next(vi.key, vi.grid); \
235                                         if (vi.gh) { \
236                                                 if (BLI_BITMAP_GET(vi.gh, vi.gy * vi.gridsize + vi.gx)) \
237                                                         continue; \
238                                         } \
239                                 } \
240                                 else { \
241                                         vi.mvert = &vi.mverts[vi.vert_indices[vi.gx]]; \
242                                         if (mode == PBVH_ITER_UNIQUE && vi.mvert->flag & ME_HIDE) \
243                                                 continue; \
244                                         vi.co = vi.mvert->co; \
245                                         vi.no = vi.mvert->no; \
246                                         if (vi.vmask) \
247                                                 vi.mask = &vi.vmask[vi.vert_indices[vi.gx]]; \
248                                 } \
249
250 #define BLI_pbvh_vertex_iter_end \
251                         } \
252                 } \
253         }
254
255 void BLI_pbvh_node_get_proxies(PBVHNode *node, PBVHProxyNode **proxies, int *proxy_count);
256 void BLI_pbvh_node_free_proxies(PBVHNode *node);
257 PBVHProxyNode *BLI_pbvh_node_add_proxy(PBVH *bvh, PBVHNode *node);
258 void BLI_pbvh_gather_proxies(PBVH *pbvh, PBVHNode ***nodes,  int *totnode);
259
260 //void BLI_pbvh_node_BB_reset(PBVHNode* node);
261 //void BLI_pbvh_node_BB_expand(PBVHNode* node, float co[3]);
262
263 #endif /* __BLI_PBVH_H__ */
264