KDTree: deprecate 'normal' argument
[blender-staging.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  * Contributor(s): Janne Karhu
19  *                 Brecht Van Lommel
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23  
24 #ifndef __BLI_KDTREE_H__
25 #define __BLI_KDTREE_H__
26
27 /** \file BLI_kdtree.h
28  *  \ingroup bli
29  *  \brief A kd-tree for nearest neighbor search.
30  *  \author Janne Karhu
31  *  \author Brecht van Lommel
32  */
33
34 #include "BLI_compiler_attrs.h"
35
36 struct KDTree;
37 typedef struct KDTree KDTree;
38
39 typedef struct KDTreeNearest {
40         int index;
41         float dist;
42         float co[3];
43 } KDTreeNearest;
44
45 KDTree *BLI_kdtree_new(unsigned int maxsize);
46 void BLI_kdtree_free(KDTree *tree);
47 void BLI_kdtree_balance(KDTree *tree) ATTR_NONNULL(1);
48
49 void BLI_kdtree_insert(
50         KDTree *tree, int index,
51         const float co[3]) ATTR_NONNULL(1, 3);
52 int BLI_kdtree_find_nearest(
53         KDTree *tree, const float co[3],
54         KDTreeNearest *r_nearest) ATTR_NONNULL(1, 2);
55
56 #define BLI_kdtree_find_nearest_n(tree, co, r_nearest, n) \
57         BLI_kdtree_find_nearest_n__normal(tree, co, NULL, r_nearest, n)
58 #define BLI_kdtree_range_search(tree, co, r_nearest, range) \
59         BLI_kdtree_range_search__normal(tree, co, NULL, r_nearest, range)
60
61 /* Normal use is deprecated */
62 /* remove __normal functions when last users drop */
63 int BLI_kdtree_find_nearest_n__normal(
64         KDTree *tree, const float co[3], const float nor[3],
65         KDTreeNearest *r_nearest,
66         unsigned int n) ATTR_NONNULL(1, 2, 4);
67 int BLI_kdtree_range_search__normal(
68         KDTree *tree, const float co[3], const float nor[3],
69         KDTreeNearest **r_nearest,
70         float range) ATTR_NONNULL(1, 2, 4) ATTR_WARN_UNUSED_RESULT;
71
72 #endif  /* __BLI_KDTREE_H__ */