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