Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_kdopbvh.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) 2006 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Daniel Genrich, Andre Pinto
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28
29 #ifndef __BLI_KDOPBVH_H__
30 #define __BLI_KDOPBVH_H__
31
32 /** \file BLI_kdopbvh.h
33  *  \ingroup bli
34  *  \author Daniel Genrich
35  *  \author Andre Pinto
36  */
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct BVHTree;
43 struct DistProjectedAABBPrecalc;
44
45 typedef struct BVHTree BVHTree;
46 #define USE_KDOPBVH_WATERTIGHT
47
48 typedef struct BVHTreeAxisRange {
49         union {
50                 struct {
51                         float min, max;
52                 };
53                 /* alternate access */
54                 float range[2];
55         };
56 } BVHTreeAxisRange;
57
58 typedef struct BVHTreeOverlap {
59         int indexA;
60         int indexB;
61 } BVHTreeOverlap;
62
63 typedef struct BVHTreeNearest {
64         /** The index of the nearest found
65          * (untouched if none is found within a dist radius from the given coordinates) */
66         int index;
67         /** Nearest coordinates
68          * (untouched it none is found within a dist radius from the given coordinates). */
69         float co[3];
70         /** Normal at nearest coordinates
71          * (untouched it none is found within a dist radius from the given coordinates). */
72         float no[3];
73         /** squared distance to search around */
74         float dist_sq;
75         int flags;
76 } BVHTreeNearest;
77
78 typedef struct BVHTreeRay {
79         /** ray origin */
80         float origin[3];
81         /** ray direction */
82         float direction[3];
83         /** radius around ray */
84         float radius;
85 #ifdef USE_KDOPBVH_WATERTIGHT
86         struct IsectRayPrecalc *isect_precalc;
87 #endif
88 } BVHTreeRay;
89
90 typedef struct BVHTreeRayHit {
91         /** Index of the tree node (untouched if no hit is found). */
92         int index;
93         /** Coordinates of the hit point. */
94         float co[3];
95         /** Normal on hit point. */
96         float no[3];
97         /** Distance to the hit point. */
98         float dist;
99 } BVHTreeRayHit;
100
101 enum {
102         /* Use a priority queue to process nodes in the optimal order (for slow callbacks) */
103         BVH_NEAREST_OPTIMAL_ORDER   = (1 << 0),
104 };
105 enum {
106         /* calculate IsectRayPrecalc data */
107         BVH_RAYCAST_WATERTIGHT          = (1 << 0),
108 };
109 #define BVH_RAYCAST_DEFAULT (BVH_RAYCAST_WATERTIGHT)
110 #define BVH_RAYCAST_DIST_MAX (FLT_MAX / 2.0f)
111
112 /* callback must update nearest in case it finds a nearest result */
113 typedef void (*BVHTree_NearestPointCallback)(void *userdata, int index, const float co[3], BVHTreeNearest *nearest);
114
115 /* callback must update hit in case it finds a nearest successful hit */
116 typedef void (*BVHTree_RayCastCallback)(void *userdata, int index, const BVHTreeRay *ray, BVHTreeRayHit *hit);
117
118 /* callback to check if 2 nodes overlap (use thread if intersection results need to be stored) */
119 typedef bool (*BVHTree_OverlapCallback)(void *userdata, int index_a, int index_b, int thread);
120
121 /* callback to range search query */
122 typedef void (*BVHTree_RangeQuery)(void *userdata, int index, const float co[3], float dist_sq);
123
124 /* callback to find nearest projected */
125 typedef void (*BVHTree_NearestProjectedCallback)(
126         void *userdata, int index,
127         const struct DistProjectedAABBPrecalc *precalc,
128         const float (*clip_plane)[4], const int clip_plane_len,
129         BVHTreeNearest *nearest);
130
131
132 /* callbacks to BLI_bvhtree_walk_dfs */
133 /* return true to traverse into this nodes children, else skip. */
134 typedef bool (*BVHTree_WalkParentCallback)(const BVHTreeAxisRange *bounds, void *userdata);
135 /* return true to keep walking, else early-exit the search. */
136 typedef bool (*BVHTree_WalkLeafCallback)(const BVHTreeAxisRange *bounds, int index, void *userdata);
137 /* return true to search (min, max) else (max, min). */
138 typedef bool (*BVHTree_WalkOrderCallback)(const BVHTreeAxisRange *bounds, char axis, void *userdata);
139
140
141 BVHTree *BLI_bvhtree_new(int maxsize, float epsilon, char tree_type, char axis);
142 void BLI_bvhtree_free(BVHTree *tree);
143
144 /* construct: first insert points, then call balance */
145 void BLI_bvhtree_insert(BVHTree *tree, int index, const float co[3], int numpoints);
146 void BLI_bvhtree_balance(BVHTree *tree);
147
148 /* update: first update points/nodes, then call update_tree to refit the bounding volumes */
149 bool BLI_bvhtree_update_node(BVHTree *tree, int index, const float co[3], const float co_moving[3], int numpoints);
150 void BLI_bvhtree_update_tree(BVHTree *tree);
151
152 int BLI_bvhtree_overlap_thread_num(const BVHTree *tree);
153
154 /* collision/overlap: check two trees if they overlap, alloc's *overlap with length of the int return value */
155 BVHTreeOverlap *BLI_bvhtree_overlap(
156         const BVHTree *tree1, const BVHTree *tree2, unsigned int *r_overlap_tot,
157         BVHTree_OverlapCallback callback, void *userdata);
158
159 int   BLI_bvhtree_get_len(const BVHTree *tree);
160 int   BLI_bvhtree_get_tree_type(const BVHTree *tree);
161 float BLI_bvhtree_get_epsilon(const BVHTree *tree);
162
163 /* find nearest node to the given coordinates
164  * (if nearest is given it will only search nodes where square distance is smaller than nearest->dist) */
165 int BLI_bvhtree_find_nearest_ex(
166         BVHTree *tree, const float co[3], BVHTreeNearest *nearest,
167         BVHTree_NearestPointCallback callback, void *userdata,
168         int flag);
169 int BLI_bvhtree_find_nearest(
170         BVHTree *tree, const float co[3], BVHTreeNearest *nearest,
171         BVHTree_NearestPointCallback callback, void *userdata);
172
173 int BLI_bvhtree_ray_cast_ex(
174         BVHTree *tree, const float co[3], const float dir[3], float radius, BVHTreeRayHit *hit,
175         BVHTree_RayCastCallback callback, void *userdata,
176         int flag);
177 int BLI_bvhtree_ray_cast(
178         BVHTree *tree, const float co[3], const float dir[3], float radius, BVHTreeRayHit *hit,
179         BVHTree_RayCastCallback callback, void *userdata);
180
181 void BLI_bvhtree_ray_cast_all_ex(
182         BVHTree *tree, const float co[3], const float dir[3], float radius, float hit_dist,
183         BVHTree_RayCastCallback callback, void *userdata,
184         int flag);
185 void BLI_bvhtree_ray_cast_all(
186         BVHTree *tree, const float co[3], const float dir[3], float radius, float hit_dist,
187         BVHTree_RayCastCallback callback, void *userdata);
188
189 float BLI_bvhtree_bb_raycast(const float bv[6], const float light_start[3], const float light_end[3], float pos[3]);
190
191 /* range query */
192 int BLI_bvhtree_range_query(
193         BVHTree *tree, const float co[3], float radius,
194         BVHTree_RangeQuery callback, void *userdata);
195
196 int BLI_bvhtree_find_nearest_projected(
197         BVHTree *tree, float projmat[4][4], float winsize[2], float mval[2],
198         float clip_planes[6][4], int clip_num,
199         BVHTreeNearest *nearest,
200         BVHTree_NearestProjectedCallback callback, void *userdata);
201
202 void BLI_bvhtree_walk_dfs(
203         BVHTree *tree,
204         BVHTree_WalkParentCallback walk_parent_cb,
205         BVHTree_WalkLeafCallback walk_leaf_cb,
206         BVHTree_WalkOrderCallback walk_order_cb,
207         void *userdata);
208
209
210 /* expose for bvh callbacks to use */
211 extern const float bvhtree_kdop_axes[13][3];
212
213 #ifdef __cplusplus
214 }
215 #endif
216
217 #endif  /* __BLI_KDOPBVH_H__ */