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