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