ae5e32d73eb1967c988295240803a6ef107c3e30
[blender.git] / source / blender / blenlib / BLI_kdtree.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: none of this file.
22  *
23  * Contributor(s): Janne Karhu
24  *                 Brecht Van Lommel
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28  
29 #ifndef __BLI_KDTREE_H__
30 #define __BLI_KDTREE_H__
31
32 /** \file BLI_kdtree.h
33  *  \ingroup bli
34  *  \brief A kd-tree for nearest neighbor search.
35  *  \author Janne Karhu
36  *  \author Brecht van Lommel
37  */
38
39 struct KDTree;
40 typedef struct KDTree KDTree;
41
42 typedef struct KDTreeNearest {
43         int index;
44         float dist;
45         float co[3];
46 } KDTreeNearest;
47
48 /* Creates or free a kdtree */
49 KDTree *BLI_kdtree_new(int maxsize);
50 void BLI_kdtree_free(KDTree *tree);
51
52 /* Construction: first insert points, then call balance. Normal is optional. */
53 void BLI_kdtree_insert(KDTree *tree, int index, float *co, float *nor);
54 void BLI_kdtree_balance(KDTree *tree);
55
56 /* Find nearest returns index, and -1 if no node is found.
57  * Find n nearest returns number of points found, with results in nearest.
58  * Normal is optional, but if given will limit results to points in normal direction from co. */
59 int BLI_kdtree_find_nearest(KDTree *tree, float *co, float *nor, KDTreeNearest *nearest);
60 int BLI_kdtree_find_n_nearest(KDTree *tree, int n, float *co, float *nor, KDTreeNearest *nearest);
61
62 /* Range search returns number of points found, with results in nearest */
63 /* Normal is optional, but if given will limit results to points in normal direction from co. */
64 /* Remember to free nearest after use! */
65 int BLI_kdtree_range_search(KDTree *tree, float range, float *co, float *nor, KDTreeNearest **nearest);
66 #endif