Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_kdtree.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
17 #ifndef __BLI_KDTREE_H__
18 #define __BLI_KDTREE_H__
19
20 /** \file \ingroup bli
21  *  \brief A kd-tree for nearest neighbor search.
22  */
23
24 #include "BLI_compiler_attrs.h"
25
26 struct KDTree;
27 typedef struct KDTree KDTree;
28
29 typedef struct KDTreeNearest {
30         int index;
31         float dist;
32         float co[3];
33 } KDTreeNearest;
34
35 KDTree *BLI_kdtree_new(unsigned int maxsize);
36 void BLI_kdtree_free(KDTree *tree);
37 void BLI_kdtree_balance(KDTree *tree) ATTR_NONNULL(1);
38
39 void BLI_kdtree_insert(
40         KDTree *tree, int index,
41         const float co[3]) ATTR_NONNULL(1, 3);
42 int BLI_kdtree_find_nearest(
43         const KDTree *tree, const float co[3],
44         KDTreeNearest *r_nearest) ATTR_NONNULL(1, 2);
45
46 #define BLI_kdtree_find_nearest_n(tree, co, r_nearest, n) \
47         BLI_kdtree_find_nearest_n__normal(tree, co, NULL, r_nearest, n)
48 #define BLI_kdtree_range_search(tree, co, r_nearest, range) \
49         BLI_kdtree_range_search__normal(tree, co, NULL, r_nearest, range)
50
51 int BLI_kdtree_find_nearest_cb(
52         const KDTree *tree, const float co[3],
53         int (*filter_cb)(void *user_data, int index, const float co[3], float dist_sq), void *user_data,
54         KDTreeNearest *r_nearest);
55 void BLI_kdtree_range_search_cb(
56         const KDTree *tree, const float co[3], float range,
57         bool (*search_cb)(void *user_data, int index, const float co[3], float dist_sq), void *user_data);
58
59 int BLI_kdtree_calc_duplicates_fast(
60         const KDTree *tree, const float range, bool use_index_order,
61         int *doubles);
62
63 /* Normal use is deprecated */
64 /* remove __normal functions when last users drop */
65 int BLI_kdtree_find_nearest_n__normal(
66         const KDTree *tree, const float co[3], const float nor[3],
67         KDTreeNearest *r_nearest,
68         unsigned int n) ATTR_NONNULL(1, 2, 4);
69 int BLI_kdtree_range_search__normal(
70         const KDTree *tree, const float co[3], const float nor[3],
71         KDTreeNearest **r_nearest,
72         float range) ATTR_NONNULL(1, 2, 4) ATTR_WARN_UNUSED_RESULT;
73
74 #endif  /* __BLI_KDTREE_H__ */