doxygen: editor entry
[blender.git] / source / blender / blenlib / BLI_kdopbvh.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Daniel Genrich, Andre Pinto
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30
31 #ifndef BLI_KDOPBVH_H
32 #define BLI_KDOPBVH_H
33
34 /** \file BLI_kdopbvh.h
35  *  \ingroup bli
36  *  \author Daniel Genrich
37  *  \author Andre Pinto
38  */
39
40 #ifdef __cplusplus
41 extern "C" { 
42 #endif
43
44 #include <float.h>
45
46 struct BVHTree;
47 typedef struct BVHTree BVHTree;
48
49 typedef struct BVHTreeOverlap {
50         int indexA;
51         int indexB;
52 } BVHTreeOverlap;
53
54 typedef struct BVHTreeNearest
55 {
56         int index;                      /* the index of the nearest found (untouched if none is found within a dist radius from the given coordinates) */
57         float co[3];            /* nearest coordinates (untouched it none is found within a dist radius from the given coordinates) */
58         float no[3];            /* normal at nearest coordinates (untouched it none is found within a dist radius from the given coordinates) */
59         float dist;                     /* squared distance to search arround */
60 } BVHTreeNearest;
61
62 typedef struct BVHTreeRay
63 {
64         float origin[3];        /* ray origin */
65         float direction[3];     /* ray direction */
66         float radius;           /* radius around ray */
67 } BVHTreeRay;
68
69 typedef struct BVHTreeRayHit
70 {
71         int index;                      /* index of the tree node (untouched if no hit is found) */
72         float co[3];            /* coordinates of the hit point */
73         float no[3];            /* normal on hit point */
74         float dist;                     /* distance to the hit point */
75 } BVHTreeRayHit;
76
77 /* callback must update nearest in case it finds a nearest result */
78 typedef void (*BVHTree_NearestPointCallback) (void *userdata, int index, const float *co, BVHTreeNearest *nearest);
79
80 /* callback must update hit in case it finds a nearest successful hit */
81 typedef void (*BVHTree_RayCastCallback) (void *userdata, int index, const BVHTreeRay *ray, BVHTreeRayHit *hit);
82
83 /* callback to range search query */
84 typedef void (*BVHTree_RangeQuery) (void *userdata, int index, float squared_dist);
85
86 BVHTree *BLI_bvhtree_new(int maxsize, float epsilon, char tree_type, char axis);
87 void BLI_bvhtree_free(BVHTree *tree);
88
89 /* construct: first insert points, then call balance */
90 int BLI_bvhtree_insert(BVHTree *tree, int index, float *co, int numpoints);
91 void BLI_bvhtree_balance(BVHTree *tree);
92
93 /* update: first update points/nodes, then call update_tree to refit the bounding volumes */
94 int BLI_bvhtree_update_node(BVHTree *tree, int index, float *co, float *co_moving, int numpoints);
95 void BLI_bvhtree_update_tree(BVHTree *tree);
96
97 /* collision/overlap: check two trees if they overlap, alloc's *overlap with length of the int return value */
98 BVHTreeOverlap *BLI_bvhtree_overlap(BVHTree *tree1, BVHTree *tree2, unsigned int *result);
99
100 float BLI_bvhtree_getepsilon(BVHTree *tree);
101
102 /* find nearest node to the given coordinates (if nearest is given it will only search nodes where square distance is smaller than nearest->dist) */
103 int BLI_bvhtree_find_nearest(BVHTree *tree, const float *co, BVHTreeNearest *nearest, BVHTree_NearestPointCallback callback, void *userdata);
104
105 int BLI_bvhtree_ray_cast(BVHTree *tree, const float *co, const float *dir, float radius, BVHTreeRayHit *hit, BVHTree_RayCastCallback callback, void *userdata);
106
107 float BLI_bvhtree_bb_raycast(float *bv, float *light_start, float *light_end, float *pos);
108
109 /* range query */
110 int BLI_bvhtree_range_query(BVHTree *tree, const float *co, float radius, BVHTree_RangeQuery callback, void *userdata);
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116 #endif // BLI_KDOPBVH_H
117