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