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