Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / intern / BLI_kdopbvh.c
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  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bli
22  * \brief BVH-tree implementation.
23  *
24  * k-DOP BVH (Discrete Oriented Polytope, Bounding Volume Hierarchy).
25  * A k-DOP is represented as k/2 pairs of min , max values for k/2 directions (intervals, "slabs").
26  *
27  * See: http://www.gris.uni-tuebingen.de/people/staff/jmezger/papers/bvh.pdf
28  *
29  * implements a bvh-tree structure with support for:
30  *
31  * - Ray-cast:
32  *   #BLI_bvhtree_ray_cast, #BVHRayCastData
33  * - Nearest point on surface:
34  *   #BLI_bvhtree_find_nearest, #BVHNearestData
35  * - Overlapping 2 trees:
36  *   #BLI_bvhtree_overlap, #BVHOverlapData_Shared, #BVHOverlapData_Thread
37  * - Range Query:
38  *   #BLI_bvhtree_range_query
39  */
40
41 #include <assert.h>
42
43 #include "MEM_guardedalloc.h"
44
45 #include "BLI_utildefines.h"
46 #include "BLI_alloca.h"
47 #include "BLI_stack.h"
48 #include "BLI_kdopbvh.h"
49 #include "BLI_math.h"
50 #include "BLI_task.h"
51 #include "BLI_heap_simple.h"
52
53 #include "BLI_strict_flags.h"
54
55 /* used for iterative_raycast */
56 // #define USE_SKIP_LINKS
57
58 /* Use to print balanced output. */
59 // #define USE_PRINT_TREE
60
61 /* Check tree is valid. */
62 // #define USE_VERIFY_TREE
63
64 #define MAX_TREETYPE 32
65
66 /* Setting zero so we can catch bugs in BLI_task/KDOPBVH.
67  * TODO(sergey): Deduplicate the limits with PBVH from BKE.
68  */
69 #ifdef DEBUG
70 #  define KDOPBVH_THREAD_LEAF_THRESHOLD 0
71 #else
72 #  define KDOPBVH_THREAD_LEAF_THRESHOLD 1024
73 #endif
74
75 /* -------------------------------------------------------------------- */
76 /** \name Struct Definitions
77  * \{ */
78
79 typedef unsigned char axis_t;
80
81 typedef struct BVHNode {
82   struct BVHNode **children;
83   struct BVHNode *parent; /* some user defined traversed need that */
84 #ifdef USE_SKIP_LINKS
85   struct BVHNode *skip[2];
86 #endif
87   float *bv;      /* Bounding volume of all nodes, max 13 axis */
88   int index;      /* face, edge, vertex index */
89   char totnode;   /* how many nodes are used, used for speedup */
90   char main_axis; /* Axis used to split this node */
91 } BVHNode;
92
93 /* keep under 26 bytes for speed purposes */
94 struct BVHTree {
95   BVHNode **nodes;
96   BVHNode *nodearray;  /* pre-alloc branch nodes */
97   BVHNode **nodechild; /* pre-alloc childs for nodes */
98   float *nodebv;       /* pre-alloc bounding-volumes for nodes */
99   float epsilon;       /* epslion is used for inflation of the k-dop      */
100   int totleaf;         /* leafs */
101   int totbranch;
102   axis_t start_axis, stop_axis; /* bvhtree_kdop_axes array indices according to axis */
103   axis_t axis;                  /* kdop type (6 => OBB, 7 => AABB, ...) */
104   char tree_type;               /* type of tree (4 => quadtree) */
105 };
106
107 /* optimization, ensure we stay small */
108 BLI_STATIC_ASSERT((sizeof(void *) == 8 && sizeof(BVHTree) <= 48) ||
109                       (sizeof(void *) == 4 && sizeof(BVHTree) <= 32),
110                   "over sized")
111
112 /* avoid duplicating vars in BVHOverlapData_Thread */
113 typedef struct BVHOverlapData_Shared {
114   const BVHTree *tree1, *tree2;
115   axis_t start_axis, stop_axis;
116
117   /* use for callbacks */
118   BVHTree_OverlapCallback callback;
119   void *userdata;
120 } BVHOverlapData_Shared;
121
122 typedef struct BVHOverlapData_Thread {
123   BVHOverlapData_Shared *shared;
124   struct BLI_Stack *overlap; /* store BVHTreeOverlap */
125   /* use for callbacks */
126   int thread;
127 } BVHOverlapData_Thread;
128
129 typedef struct BVHNearestData {
130   const BVHTree *tree;
131   const float *co;
132   BVHTree_NearestPointCallback callback;
133   void *userdata;
134   float proj[13]; /* coordinates projection over axis */
135   BVHTreeNearest nearest;
136
137 } BVHNearestData;
138
139 typedef struct BVHRayCastData {
140   const BVHTree *tree;
141
142   BVHTree_RayCastCallback callback;
143   void *userdata;
144
145   BVHTreeRay ray;
146
147 #ifdef USE_KDOPBVH_WATERTIGHT
148   struct IsectRayPrecalc isect_precalc;
149 #endif
150
151   /* initialized by bvhtree_ray_cast_data_precalc */
152   float ray_dot_axis[13];
153   float idot_axis[13];
154   int index[6];
155
156   BVHTreeRayHit hit;
157 } BVHRayCastData;
158
159 typedef struct BVHNearestProjectedData {
160   const BVHTree *tree;
161   struct DistProjectedAABBPrecalc precalc;
162   bool closest_axis[3];
163   float clip_plane[6][4];
164   int clip_plane_len;
165   BVHTree_NearestProjectedCallback callback;
166   void *userdata;
167   BVHTreeNearest nearest;
168
169 } BVHNearestProjectedData;
170
171 /** \} */
172
173 /**
174  * Bounding Volume Hierarchy Definition
175  *
176  * Notes: From OBB until 26-DOP --> all bounding volumes possible, just choose type below
177  * Notes: You have to choose the type at compile time ITM
178  * Notes: You can choose the tree type --> binary, quad, octree, choose below
179  */
180
181 const float bvhtree_kdop_axes[13][3] = {
182     {1.0, 0, 0},
183     {0, 1.0, 0},
184     {0, 0, 1.0},
185     {1.0, 1.0, 1.0},
186     {1.0, -1.0, 1.0},
187     {1.0, 1.0, -1.0},
188     {1.0, -1.0, -1.0},
189     {1.0, 1.0, 0},
190     {1.0, 0, 1.0},
191     {0, 1.0, 1.0},
192     {1.0, -1.0, 0},
193     {1.0, 0, -1.0},
194     {0, 1.0, -1.0},
195 };
196
197 /* -------------------------------------------------------------------- */
198 /** \name Utility Functions
199  * \{ */
200
201 MINLINE axis_t min_axis(axis_t a, axis_t b)
202 {
203   return (a < b) ? a : b;
204 }
205 #if 0
206 MINLINE axis_t max_axis(axis_t a, axis_t b)
207 {
208   return (b < a) ? a : b;
209 }
210 #endif
211
212 /**
213  * Introsort
214  * with permission deriven from the following Java code:
215  * http://ralphunden.net/content/tutorials/a-guide-to-introsort/
216  * and he derived it from the SUN STL
217  */
218
219 static void node_minmax_init(const BVHTree *tree, BVHNode *node)
220 {
221   axis_t axis_iter;
222   float(*bv)[2] = (float(*)[2])node->bv;
223
224   for (axis_iter = tree->start_axis; axis_iter != tree->stop_axis; axis_iter++) {
225     bv[axis_iter][0] = FLT_MAX;
226     bv[axis_iter][1] = -FLT_MAX;
227   }
228 }
229
230 /** \} */
231
232 /* -------------------------------------------------------------------- */
233 /** \name Balance Utility Functions
234  * \{ */
235
236 /**
237  * Insertion sort algorithm
238  */
239 static void bvh_insertionsort(BVHNode **a, int lo, int hi, int axis)
240 {
241   int i, j;
242   BVHNode *t;
243   for (i = lo; i < hi; i++) {
244     j = i;
245     t = a[i];
246     while ((j != lo) && (t->bv[axis] < (a[j - 1])->bv[axis])) {
247       a[j] = a[j - 1];
248       j--;
249     }
250     a[j] = t;
251   }
252 }
253
254 static int bvh_partition(BVHNode **a, int lo, int hi, BVHNode *x, int axis)
255 {
256   int i = lo, j = hi;
257   while (1) {
258     while (a[i]->bv[axis] < x->bv[axis]) {
259       i++;
260     }
261     j--;
262     while (x->bv[axis] < a[j]->bv[axis]) {
263       j--;
264     }
265     if (!(i < j)) {
266       return i;
267     }
268     SWAP(BVHNode *, a[i], a[j]);
269     i++;
270   }
271 }
272
273 /* returns Sortable */
274 static BVHNode *bvh_medianof3(BVHNode **a, int lo, int mid, int hi, int axis)
275 {
276   if ((a[mid])->bv[axis] < (a[lo])->bv[axis]) {
277     if ((a[hi])->bv[axis] < (a[mid])->bv[axis]) {
278       return a[mid];
279     }
280     else {
281       if ((a[hi])->bv[axis] < (a[lo])->bv[axis]) {
282         return a[hi];
283       }
284       else {
285         return a[lo];
286       }
287     }
288   }
289   else {
290     if ((a[hi])->bv[axis] < (a[mid])->bv[axis]) {
291       if ((a[hi])->bv[axis] < (a[lo])->bv[axis]) {
292         return a[lo];
293       }
294       else {
295         return a[hi];
296       }
297     }
298     else {
299       return a[mid];
300     }
301   }
302 }
303
304 /**
305  * \note after a call to this function you can expect one of:
306  * - every node to left of a[n] are smaller or equal to it
307  * - every node to the right of a[n] are greater or equal to it */
308 static void partition_nth_element(BVHNode **a, int begin, int end, const int n, const int axis)
309 {
310   while (end - begin > 3) {
311     const int cut = bvh_partition(
312         a, begin, end, bvh_medianof3(a, begin, (begin + end) / 2, end - 1, axis), axis);
313     if (cut <= n) {
314       begin = cut;
315     }
316     else {
317       end = cut;
318     }
319   }
320   bvh_insertionsort(a, begin, end, axis);
321 }
322
323 #ifdef USE_SKIP_LINKS
324 static void build_skip_links(BVHTree *tree, BVHNode *node, BVHNode *left, BVHNode *right)
325 {
326   int i;
327
328   node->skip[0] = left;
329   node->skip[1] = right;
330
331   for (i = 0; i < node->totnode; i++) {
332     if (i + 1 < node->totnode) {
333       build_skip_links(tree, node->children[i], left, node->children[i + 1]);
334     }
335     else {
336       build_skip_links(tree, node->children[i], left, right);
337     }
338
339     left = node->children[i];
340   }
341 }
342 #endif
343
344 /*
345  * BVHTree bounding volumes functions
346  */
347 static void create_kdop_hull(
348     const BVHTree *tree, BVHNode *node, const float *co, int numpoints, int moving)
349 {
350   float newminmax;
351   float *bv = node->bv;
352   int k;
353   axis_t axis_iter;
354
355   /* don't init boudings for the moving case */
356   if (!moving) {
357     node_minmax_init(tree, node);
358   }
359
360   for (k = 0; k < numpoints; k++) {
361     /* for all Axes. */
362     for (axis_iter = tree->start_axis; axis_iter < tree->stop_axis; axis_iter++) {
363       newminmax = dot_v3v3(&co[k * 3], bvhtree_kdop_axes[axis_iter]);
364       if (newminmax < bv[2 * axis_iter]) {
365         bv[2 * axis_iter] = newminmax;
366       }
367       if (newminmax > bv[(2 * axis_iter) + 1]) {
368         bv[(2 * axis_iter) + 1] = newminmax;
369       }
370     }
371   }
372 }
373
374 /**
375  * \note depends on the fact that the BVH's for each face is already built
376  */
377 static void refit_kdop_hull(const BVHTree *tree, BVHNode *node, int start, int end)
378 {
379   float newmin, newmax;
380   float *__restrict bv = node->bv;
381   int j;
382   axis_t axis_iter;
383
384   node_minmax_init(tree, node);
385
386   for (j = start; j < end; j++) {
387     float *__restrict node_bv = tree->nodes[j]->bv;
388
389     /* for all Axes. */
390     for (axis_iter = tree->start_axis; axis_iter < tree->stop_axis; axis_iter++) {
391       newmin = node_bv[(2 * axis_iter)];
392       if ((newmin < bv[(2 * axis_iter)])) {
393         bv[(2 * axis_iter)] = newmin;
394       }
395
396       newmax = node_bv[(2 * axis_iter) + 1];
397       if ((newmax > bv[(2 * axis_iter) + 1])) {
398         bv[(2 * axis_iter) + 1] = newmax;
399       }
400     }
401   }
402 }
403
404 /**
405  * only supports x,y,z axis in the moment
406  * but we should use a plain and simple function here for speed sake */
407 static char get_largest_axis(const float *bv)
408 {
409   float middle_point[3];
410
411   middle_point[0] = (bv[1]) - (bv[0]); /* x axis */
412   middle_point[1] = (bv[3]) - (bv[2]); /* y axis */
413   middle_point[2] = (bv[5]) - (bv[4]); /* z axis */
414   if (middle_point[0] > middle_point[1]) {
415     if (middle_point[0] > middle_point[2]) {
416       return 1; /* max x axis */
417     }
418     else {
419       return 5; /* max z axis */
420     }
421   }
422   else {
423     if (middle_point[1] > middle_point[2]) {
424       return 3; /* max y axis */
425     }
426     else {
427       return 5; /* max z axis */
428     }
429   }
430 }
431
432 /**
433  * bottom-up update of bvh node BV
434  * join the children on the parent BV */
435 static void node_join(BVHTree *tree, BVHNode *node)
436 {
437   int i;
438   axis_t axis_iter;
439
440   node_minmax_init(tree, node);
441
442   for (i = 0; i < tree->tree_type; i++) {
443     if (node->children[i]) {
444       for (axis_iter = tree->start_axis; axis_iter < tree->stop_axis; axis_iter++) {
445         /* update minimum */
446         if (node->children[i]->bv[(2 * axis_iter)] < node->bv[(2 * axis_iter)]) {
447           node->bv[(2 * axis_iter)] = node->children[i]->bv[(2 * axis_iter)];
448         }
449
450         /* update maximum */
451         if (node->children[i]->bv[(2 * axis_iter) + 1] > node->bv[(2 * axis_iter) + 1]) {
452           node->bv[(2 * axis_iter) + 1] = node->children[i]->bv[(2 * axis_iter) + 1];
453         }
454       }
455     }
456     else {
457       break;
458     }
459   }
460 }
461
462 #ifdef USE_PRINT_TREE
463
464 /**
465  * Debug and information functions
466  */
467
468 static void bvhtree_print_tree(BVHTree *tree, BVHNode *node, int depth)
469 {
470   int i;
471   axis_t axis_iter;
472
473   for (i = 0; i < depth; i++) {
474     printf(" ");
475   }
476   printf(" - %d (%ld): ", node->index, (long int)(node - tree->nodearray));
477   for (axis_iter = (axis_t)(2 * tree->start_axis); axis_iter < (axis_t)(2 * tree->stop_axis);
478        axis_iter++) {
479     printf("%.3f ", node->bv[axis_iter]);
480   }
481   printf("\n");
482
483   for (i = 0; i < tree->tree_type; i++) {
484     if (node->children[i]) {
485       bvhtree_print_tree(tree, node->children[i], depth + 1);
486     }
487   }
488 }
489
490 static void bvhtree_info(BVHTree *tree)
491 {
492   printf("BVHTree Info: tree_type = %d, axis = %d, epsilon = %f\n",
493          tree->tree_type,
494          tree->axis,
495          tree->epsilon);
496   printf("nodes = %d, branches = %d, leafs = %d\n",
497          tree->totbranch + tree->totleaf,
498          tree->totbranch,
499          tree->totleaf);
500   printf(
501       "Memory per node = %ubytes\n",
502       (uint)(sizeof(BVHNode) + sizeof(BVHNode *) * tree->tree_type + sizeof(float) * tree->axis));
503   printf("BV memory = %ubytes\n", (uint)MEM_allocN_len(tree->nodebv));
504
505   printf("Total memory = %ubytes\n",
506          (uint)(sizeof(BVHTree) + MEM_allocN_len(tree->nodes) + MEM_allocN_len(tree->nodearray) +
507                 MEM_allocN_len(tree->nodechild) + MEM_allocN_len(tree->nodebv)));
508
509   bvhtree_print_tree(tree, tree->nodes[tree->totleaf], 0);
510 }
511 #endif /* USE_PRINT_TREE */
512
513 #ifdef USE_VERIFY_TREE
514
515 static void bvhtree_verify(BVHTree *tree)
516 {
517   int i, j, check = 0;
518
519   /* check the pointer list */
520   for (i = 0; i < tree->totleaf; i++) {
521     if (tree->nodes[i]->parent == NULL) {
522       printf("Leaf has no parent: %d\n", i);
523     }
524     else {
525       for (j = 0; j < tree->tree_type; j++) {
526         if (tree->nodes[i]->parent->children[j] == tree->nodes[i]) {
527           check = 1;
528         }
529       }
530       if (!check) {
531         printf("Parent child relationship doesn't match: %d\n", i);
532       }
533       check = 0;
534     }
535   }
536
537   /* check the leaf list */
538   for (i = 0; i < tree->totleaf; i++) {
539     if (tree->nodearray[i].parent == NULL) {
540       printf("Leaf has no parent: %d\n", i);
541     }
542     else {
543       for (j = 0; j < tree->tree_type; j++) {
544         if (tree->nodearray[i].parent->children[j] == &tree->nodearray[i]) {
545           check = 1;
546         }
547       }
548       if (!check) {
549         printf("Parent child relationship doesn't match: %d\n", i);
550       }
551       check = 0;
552     }
553   }
554
555   printf("branches: %d, leafs: %d, total: %d\n",
556          tree->totbranch,
557          tree->totleaf,
558          tree->totbranch + tree->totleaf);
559 }
560 #endif /* USE_VERIFY_TREE */
561
562 /* Helper data and structures to build a min-leaf generalized implicit tree
563  * This code can be easily reduced
564  * (basicly this is only method to calculate pow(k, n) in O(1).. and stuff like that) */
565 typedef struct BVHBuildHelper {
566   int tree_type;
567   int totleafs;
568
569   /** Min number of leafs that are archievable from a node at depth N */
570   int leafs_per_child[32];
571   /** Number of nodes at depth N (tree_type^N) */
572   int branches_on_level[32];
573
574   /** Number of leafs that are placed on the level that is not 100% filled */
575   int remain_leafs;
576
577 } BVHBuildHelper;
578
579 static void build_implicit_tree_helper(const BVHTree *tree, BVHBuildHelper *data)
580 {
581   int depth = 0;
582   int remain;
583   int nnodes;
584
585   data->totleafs = tree->totleaf;
586   data->tree_type = tree->tree_type;
587
588   /* Calculate the smallest tree_type^n such that tree_type^n >= num_leafs */
589   for (data->leafs_per_child[0] = 1; data->leafs_per_child[0] < data->totleafs;
590        data->leafs_per_child[0] *= data->tree_type) {
591     /* pass */
592   }
593
594   data->branches_on_level[0] = 1;
595
596   for (depth = 1; (depth < 32) && data->leafs_per_child[depth - 1]; depth++) {
597     data->branches_on_level[depth] = data->branches_on_level[depth - 1] * data->tree_type;
598     data->leafs_per_child[depth] = data->leafs_per_child[depth - 1] / data->tree_type;
599   }
600
601   remain = data->totleafs - data->leafs_per_child[1];
602   nnodes = (remain + data->tree_type - 2) / (data->tree_type - 1);
603   data->remain_leafs = remain + nnodes;
604 }
605
606 // return the min index of all the leafs archivable with the given branch
607 static int implicit_leafs_index(const BVHBuildHelper *data, const int depth, const int child_index)
608 {
609   int min_leaf_index = child_index * data->leafs_per_child[depth - 1];
610   if (min_leaf_index <= data->remain_leafs) {
611     return min_leaf_index;
612   }
613   else if (data->leafs_per_child[depth]) {
614     return data->totleafs -
615            (data->branches_on_level[depth - 1] - child_index) * data->leafs_per_child[depth];
616   }
617   else {
618     return data->remain_leafs;
619   }
620 }
621
622 /**
623  * Generalized implicit tree build
624  *
625  * An implicit tree is a tree where its structure is implied,
626  * thus there is no need to store child pointers or indexs.
627  * Its possible to find the position of the child or the parent with simple maths
628  * (multiplication and adittion).
629  * This type of tree is for example used on heaps..
630  * where node N has its childs at indexs N*2 and N*2+1.
631  *
632  * Although in this case the tree type is general.. and not know until runtime.
633  * tree_type stands for the maximum number of childs that a tree node can have.
634  * All tree types >= 2 are supported.
635  *
636  * Advantages of the used trees include:
637  * - No need to store child/parent relations (they are implicit);
638  * - Any node child always has an index greater than the parent;
639  * - Brother nodes are sequential in memory;
640  * Some math relations derived for general implicit trees:
641  *
642  *   K = tree_type, ( 2 <= K )
643  *   ROOT = 1
644  *   N child of node A = A * K + (2 - K) + N, (0 <= N < K)
645  *
646  * Util methods:
647  *   TODO...
648  *    (looping elements, knowing if its a leaf or not.. etc...)
649  */
650
651 /* This functions returns the number of branches needed to have the requested number of leafs. */
652 static int implicit_needed_branches(int tree_type, int leafs)
653 {
654   return max_ii(1, (leafs + tree_type - 3) / (tree_type - 1));
655 }
656
657 /**
658  * This function handles the problem of "sorting" the leafs (along the split_axis).
659  *
660  * It arranges the elements in the given partitions such that:
661  * - any element in partition N is less or equal to any element in partition N+1.
662  * - if all elements are different all partition will get the same subset of elements
663  *   as if the array was sorted.
664  *
665  * partition P is described as the elements in the range ( nth[P], nth[P+1] ]
666  *
667  * TODO: This can be optimized a bit by doing a specialized nth_element instead of K nth_elements
668  */
669 static void split_leafs(BVHNode **leafs_array,
670                         const int nth[],
671                         const int partitions,
672                         const int split_axis)
673 {
674   int i;
675   for (i = 0; i < partitions - 1; i++) {
676     if (nth[i] >= nth[partitions]) {
677       break;
678     }
679
680     partition_nth_element(leafs_array, nth[i], nth[partitions], nth[i + 1], split_axis);
681   }
682 }
683
684 typedef struct BVHDivNodesData {
685   const BVHTree *tree;
686   BVHNode *branches_array;
687   BVHNode **leafs_array;
688
689   int tree_type;
690   int tree_offset;
691
692   const BVHBuildHelper *data;
693
694   int depth;
695   int i;
696   int first_of_next_level;
697 } BVHDivNodesData;
698
699 static void non_recursive_bvh_div_nodes_task_cb(void *__restrict userdata,
700                                                 const int j,
701                                                 const ParallelRangeTLS *__restrict UNUSED(tls))
702 {
703   BVHDivNodesData *data = userdata;
704
705   int k;
706   const int parent_level_index = j - data->i;
707   BVHNode *parent = &data->branches_array[j];
708   int nth_positions[MAX_TREETYPE + 1];
709   char split_axis;
710
711   int parent_leafs_begin = implicit_leafs_index(data->data, data->depth, parent_level_index);
712   int parent_leafs_end = implicit_leafs_index(data->data, data->depth, parent_level_index + 1);
713
714   /* This calculates the bounding box of this branch
715    * and chooses the largest axis as the axis to divide leafs */
716   refit_kdop_hull(data->tree, parent, parent_leafs_begin, parent_leafs_end);
717   split_axis = get_largest_axis(parent->bv);
718
719   /* Save split axis (this can be used on raytracing to speedup the query time) */
720   parent->main_axis = split_axis / 2;
721
722   /* Split the childs along the split_axis, note: its not needed to sort the whole leafs array
723    * Only to assure that the elements are partitioned on a way that each child takes the elements
724    * it would take in case the whole array was sorted.
725    * Split_leafs takes care of that "sort" problem. */
726   nth_positions[0] = parent_leafs_begin;
727   nth_positions[data->tree_type] = parent_leafs_end;
728   for (k = 1; k < data->tree_type; k++) {
729     const int child_index = j * data->tree_type + data->tree_offset + k;
730     /* child level index */
731     const int child_level_index = child_index - data->first_of_next_level;
732     nth_positions[k] = implicit_leafs_index(data->data, data->depth + 1, child_level_index);
733   }
734
735   split_leafs(data->leafs_array, nth_positions, data->tree_type, split_axis);
736
737   /* Setup children and totnode counters
738    * Not really needed but currently most of BVH code
739    * relies on having an explicit children structure */
740   for (k = 0; k < data->tree_type; k++) {
741     const int child_index = j * data->tree_type + data->tree_offset + k;
742     /* child level index */
743     const int child_level_index = child_index - data->first_of_next_level;
744
745     const int child_leafs_begin = implicit_leafs_index(
746         data->data, data->depth + 1, child_level_index);
747     const int child_leafs_end = implicit_leafs_index(
748         data->data, data->depth + 1, child_level_index + 1);
749
750     if (child_leafs_end - child_leafs_begin > 1) {
751       parent->children[k] = &data->branches_array[child_index];
752       parent->children[k]->parent = parent;
753     }
754     else if (child_leafs_end - child_leafs_begin == 1) {
755       parent->children[k] = data->leafs_array[child_leafs_begin];
756       parent->children[k]->parent = parent;
757     }
758     else {
759       break;
760     }
761   }
762   parent->totnode = (char)k;
763 }
764
765 /**
766  * This functions builds an optimal implicit tree from the given leafs.
767  * Where optimal stands for:
768  * - The resulting tree will have the smallest number of branches;
769  * - At most only one branch will have NULL childs;
770  * - All leafs will be stored at level N or N+1.
771  *
772  * This function creates an implicit tree on branches_array,
773  * the leafs are given on the leafs_array.
774  *
775  * The tree is built per depth levels. First branches at depth 1.. then branches at depth 2.. etc..
776  * The reason is that we can build level N+1 from level N without any data dependencies..
777  * thus it allows to use multithread building.
778  *
779  * To archive this is necessary to find how much leafs are accessible from a certain branch,
780  * #BVHBuildHelper, #implicit_needed_branches and #implicit_leafs_index
781  * are auxiliary functions to solve that "optimal-split".
782  */
783 static void non_recursive_bvh_div_nodes(const BVHTree *tree,
784                                         BVHNode *branches_array,
785                                         BVHNode **leafs_array,
786                                         int num_leafs)
787 {
788   int i;
789
790   const int tree_type = tree->tree_type;
791   /* this value is 0 (on binary trees) and negative on the others */
792   const int tree_offset = 2 - tree->tree_type;
793
794   const int num_branches = implicit_needed_branches(tree_type, num_leafs);
795
796   BVHBuildHelper data;
797   int depth;
798
799   {
800     /* set parent from root node to NULL */
801     BVHNode *root = &branches_array[1];
802     root->parent = NULL;
803
804     /* Most of bvhtree code relies on 1-leaf trees having at least one branch
805      * We handle that special case here */
806     if (num_leafs == 1) {
807       refit_kdop_hull(tree, root, 0, num_leafs);
808       root->main_axis = get_largest_axis(root->bv) / 2;
809       root->totnode = 1;
810       root->children[0] = leafs_array[0];
811       root->children[0]->parent = root;
812       return;
813     }
814   }
815
816   build_implicit_tree_helper(tree, &data);
817
818   BVHDivNodesData cb_data = {
819       .tree = tree,
820       .branches_array = branches_array,
821       .leafs_array = leafs_array,
822       .tree_type = tree_type,
823       .tree_offset = tree_offset,
824       .data = &data,
825       .first_of_next_level = 0,
826       .depth = 0,
827       .i = 0,
828   };
829
830   /* Loop tree levels (log N) loops */
831   for (i = 1, depth = 1; i <= num_branches; i = i * tree_type + tree_offset, depth++) {
832     const int first_of_next_level = i * tree_type + tree_offset;
833     /* index of last branch on this level */
834     const int i_stop = min_ii(first_of_next_level, num_branches + 1);
835
836     /* Loop all branches on this level */
837     cb_data.first_of_next_level = first_of_next_level;
838     cb_data.i = i;
839     cb_data.depth = depth;
840
841     if (true) {
842       ParallelRangeSettings settings;
843       BLI_parallel_range_settings_defaults(&settings);
844       settings.use_threading = (num_leafs > KDOPBVH_THREAD_LEAF_THRESHOLD);
845       BLI_task_parallel_range(i, i_stop, &cb_data, non_recursive_bvh_div_nodes_task_cb, &settings);
846     }
847     else {
848       /* Less hassle for debugging. */
849       ParallelRangeTLS tls = {0};
850       for (int i_task = i; i_task < i_stop; i_task++) {
851         non_recursive_bvh_div_nodes_task_cb(&cb_data, i_task, &tls);
852       }
853     }
854   }
855 }
856
857 /** \} */
858
859 /* -------------------------------------------------------------------- */
860 /** \name BLI_bvhtree API
861  * \{ */
862
863 /**
864  * \note many callers don't check for ``NULL`` return.
865  */
866 BVHTree *BLI_bvhtree_new(int maxsize, float epsilon, char tree_type, char axis)
867 {
868   BVHTree *tree;
869   int numnodes, i;
870
871   BLI_assert(tree_type >= 2 && tree_type <= MAX_TREETYPE);
872
873   tree = MEM_callocN(sizeof(BVHTree), "BVHTree");
874
875   /* tree epsilon must be >= FLT_EPSILON
876    * so that tangent rays can still hit a bounding volume..
877    * this bug would show up when casting a ray aligned with a kdop-axis
878    * and with an edge of 2 faces */
879   epsilon = max_ff(FLT_EPSILON, epsilon);
880
881   if (tree) {
882     tree->epsilon = epsilon;
883     tree->tree_type = tree_type;
884     tree->axis = axis;
885
886     if (axis == 26) {
887       tree->start_axis = 0;
888       tree->stop_axis = 13;
889     }
890     else if (axis == 18) {
891       tree->start_axis = 7;
892       tree->stop_axis = 13;
893     }
894     else if (axis == 14) {
895       tree->start_axis = 0;
896       tree->stop_axis = 7;
897     }
898     else if (axis == 8) { /* AABB */
899       tree->start_axis = 0;
900       tree->stop_axis = 4;
901     }
902     else if (axis == 6) { /* OBB */
903       tree->start_axis = 0;
904       tree->stop_axis = 3;
905     }
906     else {
907       /* should never happen! */
908       BLI_assert(0);
909
910       goto fail;
911     }
912
913     /* Allocate arrays */
914     numnodes = maxsize + implicit_needed_branches(tree_type, maxsize) + tree_type;
915
916     tree->nodes = MEM_callocN(sizeof(BVHNode *) * (size_t)numnodes, "BVHNodes");
917     tree->nodebv = MEM_callocN(sizeof(float) * (size_t)(axis * numnodes), "BVHNodeBV");
918     tree->nodechild = MEM_callocN(sizeof(BVHNode *) * (size_t)(tree_type * numnodes), "BVHNodeBV");
919     tree->nodearray = MEM_callocN(sizeof(BVHNode) * (size_t)numnodes, "BVHNodeArray");
920
921     if (UNLIKELY((!tree->nodes) || (!tree->nodebv) || (!tree->nodechild) || (!tree->nodearray))) {
922       goto fail;
923     }
924
925     /* link the dynamic bv and child links */
926     for (i = 0; i < numnodes; i++) {
927       tree->nodearray[i].bv = &tree->nodebv[i * axis];
928       tree->nodearray[i].children = &tree->nodechild[i * tree_type];
929     }
930   }
931   return tree;
932
933 fail:
934   BLI_bvhtree_free(tree);
935   return NULL;
936 }
937
938 void BLI_bvhtree_free(BVHTree *tree)
939 {
940   if (tree) {
941     MEM_SAFE_FREE(tree->nodes);
942     MEM_SAFE_FREE(tree->nodearray);
943     MEM_SAFE_FREE(tree->nodebv);
944     MEM_SAFE_FREE(tree->nodechild);
945     MEM_freeN(tree);
946   }
947 }
948
949 void BLI_bvhtree_balance(BVHTree *tree)
950 {
951   BVHNode **leafs_array = tree->nodes;
952
953   /* This function should only be called once
954    * (some big bug goes here if its being called more than once per tree) */
955   BLI_assert(tree->totbranch == 0);
956
957   /* Build the implicit tree */
958   non_recursive_bvh_div_nodes(
959       tree, tree->nodearray + (tree->totleaf - 1), leafs_array, tree->totleaf);
960
961   /* current code expects the branches to be linked to the nodes array
962    * we perform that linkage here */
963   tree->totbranch = implicit_needed_branches(tree->tree_type, tree->totleaf);
964   for (int i = 0; i < tree->totbranch; i++) {
965     tree->nodes[tree->totleaf + i] = &tree->nodearray[tree->totleaf + i];
966   }
967
968 #ifdef USE_SKIP_LINKS
969   build_skip_links(tree, tree->nodes[tree->totleaf], NULL, NULL);
970 #endif
971
972 #ifdef USE_VERIFY_TREE
973   bvhtree_verify(tree);
974 #endif
975
976 #ifdef USE_PRINT_TREE
977   bvhtree_info(tree);
978 #endif
979 }
980
981 void BLI_bvhtree_insert(BVHTree *tree, int index, const float co[3], int numpoints)
982 {
983   axis_t axis_iter;
984   BVHNode *node = NULL;
985
986   /* insert should only possible as long as tree->totbranch is 0 */
987   BLI_assert(tree->totbranch <= 0);
988   BLI_assert((size_t)tree->totleaf < MEM_allocN_len(tree->nodes) / sizeof(*(tree->nodes)));
989
990   node = tree->nodes[tree->totleaf] = &(tree->nodearray[tree->totleaf]);
991   tree->totleaf++;
992
993   create_kdop_hull(tree, node, co, numpoints, 0);
994   node->index = index;
995
996   /* inflate the bv with some epsilon */
997   for (axis_iter = tree->start_axis; axis_iter < tree->stop_axis; axis_iter++) {
998     node->bv[(2 * axis_iter)] -= tree->epsilon;     /* minimum */
999     node->bv[(2 * axis_iter) + 1] += tree->epsilon; /* maximum */
1000   }
1001 }
1002
1003 /* call before BLI_bvhtree_update_tree() */
1004 bool BLI_bvhtree_update_node(
1005     BVHTree *tree, int index, const float co[3], const float co_moving[3], int numpoints)
1006 {
1007   BVHNode *node = NULL;
1008   axis_t axis_iter;
1009
1010   /* check if index exists */
1011   if (index > tree->totleaf) {
1012     return false;
1013   }
1014
1015   node = tree->nodearray + index;
1016
1017   create_kdop_hull(tree, node, co, numpoints, 0);
1018
1019   if (co_moving) {
1020     create_kdop_hull(tree, node, co_moving, numpoints, 1);
1021   }
1022
1023   /* inflate the bv with some epsilon */
1024   for (axis_iter = tree->start_axis; axis_iter < tree->stop_axis; axis_iter++) {
1025     node->bv[(2 * axis_iter)] -= tree->epsilon;     /* minimum */
1026     node->bv[(2 * axis_iter) + 1] += tree->epsilon; /* maximum */
1027   }
1028
1029   return true;
1030 }
1031
1032 /* call BLI_bvhtree_update_node() first for every node/point/triangle */
1033 void BLI_bvhtree_update_tree(BVHTree *tree)
1034 {
1035   /* Update bottom=>top
1036    * TRICKY: the way we build the tree all the childs have an index greater than the parent
1037    * This allows us todo a bottom up update by starting on the bigger numbered branch */
1038
1039   BVHNode **root = tree->nodes + tree->totleaf;
1040   BVHNode **index = tree->nodes + tree->totleaf + tree->totbranch - 1;
1041
1042   for (; index >= root; index--) {
1043     node_join(tree, *index);
1044   }
1045 }
1046 /**
1047  * Number of times #BLI_bvhtree_insert has been called.
1048  * mainly useful for asserts functions to check we added the correct number.
1049  */
1050 int BLI_bvhtree_get_len(const BVHTree *tree)
1051 {
1052   return tree->totleaf;
1053 }
1054
1055 /**
1056  * Maximum number of children that a node can have.
1057  */
1058 int BLI_bvhtree_get_tree_type(const BVHTree *tree)
1059 {
1060   return tree->tree_type;
1061 }
1062
1063 float BLI_bvhtree_get_epsilon(const BVHTree *tree)
1064 {
1065   return tree->epsilon;
1066 }
1067
1068 /** \} */
1069
1070 /* -------------------------------------------------------------------- */
1071 /** \name BLI_bvhtree_overlap
1072  * \{ */
1073
1074 /**
1075  * overlap - is it possible for 2 bv's to collide ?
1076  */
1077 static bool tree_overlap_test(const BVHNode *node1,
1078                               const BVHNode *node2,
1079                               axis_t start_axis,
1080                               axis_t stop_axis)
1081 {
1082   const float *bv1 = node1->bv + (start_axis << 1);
1083   const float *bv2 = node2->bv + (start_axis << 1);
1084   const float *bv1_end = node1->bv + (stop_axis << 1);
1085
1086   /* test all axis if min + max overlap */
1087   for (; bv1 != bv1_end; bv1 += 2, bv2 += 2) {
1088     if ((bv1[0] > bv2[1]) || (bv2[0] > bv1[1])) {
1089       return 0;
1090     }
1091   }
1092
1093   return 1;
1094 }
1095
1096 static void tree_overlap_traverse(BVHOverlapData_Thread *data_thread,
1097                                   const BVHNode *node1,
1098                                   const BVHNode *node2)
1099 {
1100   BVHOverlapData_Shared *data = data_thread->shared;
1101   int j;
1102
1103   if (tree_overlap_test(node1, node2, data->start_axis, data->stop_axis)) {
1104     /* check if node1 is a leaf */
1105     if (!node1->totnode) {
1106       /* check if node2 is a leaf */
1107       if (!node2->totnode) {
1108         BVHTreeOverlap *overlap;
1109
1110         if (UNLIKELY(node1 == node2)) {
1111           return;
1112         }
1113
1114         /* both leafs, insert overlap! */
1115         overlap = BLI_stack_push_r(data_thread->overlap);
1116         overlap->indexA = node1->index;
1117         overlap->indexB = node2->index;
1118       }
1119       else {
1120         for (j = 0; j < data->tree2->tree_type; j++) {
1121           if (node2->children[j]) {
1122             tree_overlap_traverse(data_thread, node1, node2->children[j]);
1123           }
1124         }
1125       }
1126     }
1127     else {
1128       for (j = 0; j < data->tree2->tree_type; j++) {
1129         if (node1->children[j]) {
1130           tree_overlap_traverse(data_thread, node1->children[j], node2);
1131         }
1132       }
1133     }
1134   }
1135 }
1136
1137 /**
1138  * a version of #tree_overlap_traverse that runs a callback to check if the nodes really intersect.
1139  */
1140 static void tree_overlap_traverse_cb(BVHOverlapData_Thread *data_thread,
1141                                      const BVHNode *node1,
1142                                      const BVHNode *node2)
1143 {
1144   BVHOverlapData_Shared *data = data_thread->shared;
1145   int j;
1146
1147   if (tree_overlap_test(node1, node2, data->start_axis, data->stop_axis)) {
1148     /* check if node1 is a leaf */
1149     if (!node1->totnode) {
1150       /* check if node2 is a leaf */
1151       if (!node2->totnode) {
1152         BVHTreeOverlap *overlap;
1153
1154         if (UNLIKELY(node1 == node2)) {
1155           return;
1156         }
1157
1158         /* only difference to tree_overlap_traverse! */
1159         if (data->callback(data->userdata, node1->index, node2->index, data_thread->thread)) {
1160           /* both leafs, insert overlap! */
1161           overlap = BLI_stack_push_r(data_thread->overlap);
1162           overlap->indexA = node1->index;
1163           overlap->indexB = node2->index;
1164         }
1165       }
1166       else {
1167         for (j = 0; j < data->tree2->tree_type; j++) {
1168           if (node2->children[j]) {
1169             tree_overlap_traverse_cb(data_thread, node1, node2->children[j]);
1170           }
1171         }
1172       }
1173     }
1174     else {
1175       for (j = 0; j < data->tree2->tree_type; j++) {
1176         if (node1->children[j]) {
1177           tree_overlap_traverse_cb(data_thread, node1->children[j], node2);
1178         }
1179       }
1180     }
1181   }
1182 }
1183
1184 /**
1185  * Use to check the total number of threads #BLI_bvhtree_overlap will use.
1186  *
1187  * \warning Must be the first tree passed to #BLI_bvhtree_overlap!
1188  */
1189 int BLI_bvhtree_overlap_thread_num(const BVHTree *tree)
1190 {
1191   return (int)MIN2(tree->tree_type, tree->nodes[tree->totleaf]->totnode);
1192 }
1193
1194 static void bvhtree_overlap_task_cb(void *__restrict userdata,
1195                                     const int j,
1196                                     const ParallelRangeTLS *__restrict UNUSED(tls))
1197 {
1198   BVHOverlapData_Thread *data = &((BVHOverlapData_Thread *)userdata)[j];
1199   BVHOverlapData_Shared *data_shared = data->shared;
1200
1201   if (data_shared->callback) {
1202     tree_overlap_traverse_cb(data,
1203                              data_shared->tree1->nodes[data_shared->tree1->totleaf]->children[j],
1204                              data_shared->tree2->nodes[data_shared->tree2->totleaf]);
1205   }
1206   else {
1207     tree_overlap_traverse(data,
1208                           data_shared->tree1->nodes[data_shared->tree1->totleaf]->children[j],
1209                           data_shared->tree2->nodes[data_shared->tree2->totleaf]);
1210   }
1211 }
1212
1213 BVHTreeOverlap *BLI_bvhtree_overlap(
1214     const BVHTree *tree1,
1215     const BVHTree *tree2,
1216     uint *r_overlap_tot,
1217     /* optional callback to test the overlap before adding (must be thread-safe!) */
1218     BVHTree_OverlapCallback callback,
1219     void *userdata)
1220 {
1221   const int thread_num = BLI_bvhtree_overlap_thread_num(tree1);
1222   int j;
1223   size_t total = 0;
1224   BVHTreeOverlap *overlap = NULL, *to = NULL;
1225   BVHOverlapData_Shared data_shared;
1226   BVHOverlapData_Thread *data = BLI_array_alloca(data, (size_t)thread_num);
1227   axis_t start_axis, stop_axis;
1228
1229   /* check for compatibility of both trees (can't compare 14-DOP with 18-DOP) */
1230   if (UNLIKELY((tree1->axis != tree2->axis) && (tree1->axis == 14 || tree2->axis == 14) &&
1231                (tree1->axis == 18 || tree2->axis == 18))) {
1232     BLI_assert(0);
1233     return NULL;
1234   }
1235
1236   start_axis = min_axis(tree1->start_axis, tree2->start_axis);
1237   stop_axis = min_axis(tree1->stop_axis, tree2->stop_axis);
1238
1239   /* fast check root nodes for collision before doing big splitting + traversal */
1240   if (!tree_overlap_test(
1241           tree1->nodes[tree1->totleaf], tree2->nodes[tree2->totleaf], start_axis, stop_axis)) {
1242     return NULL;
1243   }
1244
1245   data_shared.tree1 = tree1;
1246   data_shared.tree2 = tree2;
1247   data_shared.start_axis = start_axis;
1248   data_shared.stop_axis = stop_axis;
1249
1250   /* can be NULL */
1251   data_shared.callback = callback;
1252   data_shared.userdata = userdata;
1253
1254   for (j = 0; j < thread_num; j++) {
1255     /* init BVHOverlapData_Thread */
1256     data[j].shared = &data_shared;
1257     data[j].overlap = BLI_stack_new(sizeof(BVHTreeOverlap), __func__);
1258
1259     /* for callback */
1260     data[j].thread = j;
1261   }
1262
1263   ParallelRangeSettings settings;
1264   BLI_parallel_range_settings_defaults(&settings);
1265   settings.use_threading = (tree1->totleaf > KDOPBVH_THREAD_LEAF_THRESHOLD);
1266   BLI_task_parallel_range(0, thread_num, data, bvhtree_overlap_task_cb, &settings);
1267
1268   for (j = 0; j < thread_num; j++) {
1269     total += BLI_stack_count(data[j].overlap);
1270   }
1271
1272   to = overlap = MEM_mallocN(sizeof(BVHTreeOverlap) * total, "BVHTreeOverlap");
1273
1274   for (j = 0; j < thread_num; j++) {
1275     uint count = (uint)BLI_stack_count(data[j].overlap);
1276     BLI_stack_pop_n(data[j].overlap, to, count);
1277     BLI_stack_free(data[j].overlap);
1278     to += count;
1279   }
1280
1281   *r_overlap_tot = (uint)total;
1282   return overlap;
1283 }
1284
1285 /** \} */
1286
1287 /* -------------------------------------------------------------------- */
1288 /** \name BLI_bvhtree_find_nearest
1289  * \{ */
1290
1291 /* Determines the nearest point of the given node BV.
1292  * Returns the squared distance to that point. */
1293 static float calc_nearest_point_squared(const float proj[3], BVHNode *node, float nearest[3])
1294 {
1295   int i;
1296   const float *bv = node->bv;
1297
1298   /* nearest on AABB hull */
1299   for (i = 0; i != 3; i++, bv += 2) {
1300     float val = proj[i];
1301     if (bv[0] > val) {
1302       val = bv[0];
1303     }
1304     if (bv[1] < val) {
1305       val = bv[1];
1306     }
1307     nearest[i] = val;
1308   }
1309
1310   return len_squared_v3v3(proj, nearest);
1311 }
1312
1313 /* Depth first search method */
1314 static void dfs_find_nearest_dfs(BVHNearestData *data, BVHNode *node)
1315 {
1316   if (node->totnode == 0) {
1317     if (data->callback) {
1318       data->callback(data->userdata, node->index, data->co, &data->nearest);
1319     }
1320     else {
1321       data->nearest.index = node->index;
1322       data->nearest.dist_sq = calc_nearest_point_squared(data->proj, node, data->nearest.co);
1323     }
1324   }
1325   else {
1326     /* Better heuristic to pick the closest node to dive on */
1327     int i;
1328     float nearest[3];
1329
1330     if (data->proj[node->main_axis] <= node->children[0]->bv[node->main_axis * 2 + 1]) {
1331
1332       for (i = 0; i != node->totnode; i++) {
1333         if (calc_nearest_point_squared(data->proj, node->children[i], nearest) >=
1334             data->nearest.dist_sq) {
1335           continue;
1336         }
1337         dfs_find_nearest_dfs(data, node->children[i]);
1338       }
1339     }
1340     else {
1341       for (i = node->totnode - 1; i >= 0; i--) {
1342         if (calc_nearest_point_squared(data->proj, node->children[i], nearest) >=
1343             data->nearest.dist_sq) {
1344           continue;
1345         }
1346         dfs_find_nearest_dfs(data, node->children[i]);
1347       }
1348     }
1349   }
1350 }
1351
1352 static void dfs_find_nearest_begin(BVHNearestData *data, BVHNode *node)
1353 {
1354   float nearest[3], dist_sq;
1355   dist_sq = calc_nearest_point_squared(data->proj, node, nearest);
1356   if (dist_sq >= data->nearest.dist_sq) {
1357     return;
1358   }
1359   dfs_find_nearest_dfs(data, node);
1360 }
1361
1362 /* Priority queue method */
1363 static void heap_find_nearest_inner(BVHNearestData *data, HeapSimple *heap, BVHNode *node)
1364 {
1365   if (node->totnode == 0) {
1366     if (data->callback) {
1367       data->callback(data->userdata, node->index, data->co, &data->nearest);
1368     }
1369     else {
1370       data->nearest.index = node->index;
1371       data->nearest.dist_sq = calc_nearest_point_squared(data->proj, node, data->nearest.co);
1372     }
1373   }
1374   else {
1375     float nearest[3];
1376
1377     for (int i = 0; i != node->totnode; i++) {
1378       float dist_sq = calc_nearest_point_squared(data->proj, node->children[i], nearest);
1379
1380       if (dist_sq < data->nearest.dist_sq) {
1381         BLI_heapsimple_insert(heap, dist_sq, node->children[i]);
1382       }
1383     }
1384   }
1385 }
1386
1387 static void heap_find_nearest_begin(BVHNearestData *data, BVHNode *root)
1388 {
1389   float nearest[3];
1390   float dist_sq = calc_nearest_point_squared(data->proj, root, nearest);
1391
1392   if (dist_sq < data->nearest.dist_sq) {
1393     HeapSimple *heap = BLI_heapsimple_new_ex(32);
1394
1395     heap_find_nearest_inner(data, heap, root);
1396
1397     while (!BLI_heapsimple_is_empty(heap) &&
1398            BLI_heapsimple_top_value(heap) < data->nearest.dist_sq) {
1399       BVHNode *node = BLI_heapsimple_pop_min(heap);
1400       heap_find_nearest_inner(data, heap, node);
1401     }
1402
1403     BLI_heapsimple_free(heap, NULL);
1404   }
1405 }
1406
1407 int BLI_bvhtree_find_nearest_ex(BVHTree *tree,
1408                                 const float co[3],
1409                                 BVHTreeNearest *nearest,
1410                                 BVHTree_NearestPointCallback callback,
1411                                 void *userdata,
1412                                 int flag)
1413 {
1414   axis_t axis_iter;
1415
1416   BVHNearestData data;
1417   BVHNode *root = tree->nodes[tree->totleaf];
1418
1419   /* init data to search */
1420   data.tree = tree;
1421   data.co = co;
1422
1423   data.callback = callback;
1424   data.userdata = userdata;
1425
1426   for (axis_iter = data.tree->start_axis; axis_iter != data.tree->stop_axis; axis_iter++) {
1427     data.proj[axis_iter] = dot_v3v3(data.co, bvhtree_kdop_axes[axis_iter]);
1428   }
1429
1430   if (nearest) {
1431     memcpy(&data.nearest, nearest, sizeof(*nearest));
1432   }
1433   else {
1434     data.nearest.index = -1;
1435     data.nearest.dist_sq = FLT_MAX;
1436   }
1437
1438   /* dfs search */
1439   if (root) {
1440     if (flag & BVH_NEAREST_OPTIMAL_ORDER) {
1441       heap_find_nearest_begin(&data, root);
1442     }
1443     else {
1444       dfs_find_nearest_begin(&data, root);
1445     }
1446   }
1447
1448   /* copy back results */
1449   if (nearest) {
1450     memcpy(nearest, &data.nearest, sizeof(*nearest));
1451   }
1452
1453   return data.nearest.index;
1454 }
1455
1456 int BLI_bvhtree_find_nearest(BVHTree *tree,
1457                              const float co[3],
1458                              BVHTreeNearest *nearest,
1459                              BVHTree_NearestPointCallback callback,
1460                              void *userdata)
1461 {
1462   return BLI_bvhtree_find_nearest_ex(tree, co, nearest, callback, userdata, 0);
1463 }
1464
1465 /** \} */
1466
1467 /* -------------------------------------------------------------------- */
1468 /** \name BLI_bvhtree_ray_cast
1469  *
1470  * raycast is done by performing a DFS on the BVHTree and saving the closest hit.
1471  *
1472  * \{ */
1473
1474 /* Determines the distance that the ray must travel to hit the bounding volume of the given node */
1475 static float ray_nearest_hit(const BVHRayCastData *data, const float bv[6])
1476 {
1477   int i;
1478
1479   float low = 0, upper = data->hit.dist;
1480
1481   for (i = 0; i != 3; i++, bv += 2) {
1482     if (data->ray_dot_axis[i] == 0.0f) {
1483       /* axis aligned ray */
1484       if (data->ray.origin[i] < bv[0] - data->ray.radius ||
1485           data->ray.origin[i] > bv[1] + data->ray.radius) {
1486         return FLT_MAX;
1487       }
1488     }
1489     else {
1490       float ll = (bv[0] - data->ray.radius - data->ray.origin[i]) / data->ray_dot_axis[i];
1491       float lu = (bv[1] + data->ray.radius - data->ray.origin[i]) / data->ray_dot_axis[i];
1492
1493       if (data->ray_dot_axis[i] > 0.0f) {
1494         if (ll > low) {
1495           low = ll;
1496         }
1497         if (lu < upper) {
1498           upper = lu;
1499         }
1500       }
1501       else {
1502         if (lu > low) {
1503           low = lu;
1504         }
1505         if (ll < upper) {
1506           upper = ll;
1507         }
1508       }
1509
1510       if (low > upper) {
1511         return FLT_MAX;
1512       }
1513     }
1514   }
1515   return low;
1516 }
1517
1518 /**
1519  * Determines the distance that the ray must travel to hit the bounding volume of the given node
1520  * Based on Tactical Optimization of Ray/Box Intersection, by Graham Fyffe
1521  * [http://tog.acm.org/resources/RTNews/html/rtnv21n1.html#art9]
1522  *
1523  * TODO this doesn't take data->ray.radius into consideration */
1524 static float fast_ray_nearest_hit(const BVHRayCastData *data, const BVHNode *node)
1525 {
1526   const float *bv = node->bv;
1527
1528   float t1x = (bv[data->index[0]] - data->ray.origin[0]) * data->idot_axis[0];
1529   float t2x = (bv[data->index[1]] - data->ray.origin[0]) * data->idot_axis[0];
1530   float t1y = (bv[data->index[2]] - data->ray.origin[1]) * data->idot_axis[1];
1531   float t2y = (bv[data->index[3]] - data->ray.origin[1]) * data->idot_axis[1];
1532   float t1z = (bv[data->index[4]] - data->ray.origin[2]) * data->idot_axis[2];
1533   float t2z = (bv[data->index[5]] - data->ray.origin[2]) * data->idot_axis[2];
1534
1535   if ((t1x > t2y || t2x < t1y || t1x > t2z || t2x < t1z || t1y > t2z || t2y < t1z) ||
1536       (t2x < 0.0f || t2y < 0.0f || t2z < 0.0f) ||
1537       (t1x > data->hit.dist || t1y > data->hit.dist || t1z > data->hit.dist)) {
1538     return FLT_MAX;
1539   }
1540   else {
1541     return max_fff(t1x, t1y, t1z);
1542   }
1543 }
1544
1545 static void dfs_raycast(BVHRayCastData *data, BVHNode *node)
1546 {
1547   int i;
1548
1549   /* ray-bv is really fast.. and simple tests revealed its worth to test it
1550    * before calling the ray-primitive functions */
1551   /* XXX: temporary solution for particles until fast_ray_nearest_hit supports ray.radius */
1552   float dist = (data->ray.radius == 0.0f) ? fast_ray_nearest_hit(data, node) :
1553                                             ray_nearest_hit(data, node->bv);
1554   if (dist >= data->hit.dist) {
1555     return;
1556   }
1557
1558   if (node->totnode == 0) {
1559     if (data->callback) {
1560       data->callback(data->userdata, node->index, &data->ray, &data->hit);
1561     }
1562     else {
1563       data->hit.index = node->index;
1564       data->hit.dist = dist;
1565       madd_v3_v3v3fl(data->hit.co, data->ray.origin, data->ray.direction, dist);
1566     }
1567   }
1568   else {
1569     /* pick loop direction to dive into the tree (based on ray direction and split axis) */
1570     if (data->ray_dot_axis[node->main_axis] > 0.0f) {
1571       for (i = 0; i != node->totnode; i++) {
1572         dfs_raycast(data, node->children[i]);
1573       }
1574     }
1575     else {
1576       for (i = node->totnode - 1; i >= 0; i--) {
1577         dfs_raycast(data, node->children[i]);
1578       }
1579     }
1580   }
1581 }
1582
1583 /**
1584  * A version of #dfs_raycast with minor changes to reset the index & dist each ray cast.
1585  */
1586 static void dfs_raycast_all(BVHRayCastData *data, BVHNode *node)
1587 {
1588   int i;
1589
1590   /* ray-bv is really fast.. and simple tests revealed its worth to test it
1591    * before calling the ray-primitive functions */
1592   /* XXX: temporary solution for particles until fast_ray_nearest_hit supports ray.radius */
1593   float dist = (data->ray.radius == 0.0f) ? fast_ray_nearest_hit(data, node) :
1594                                             ray_nearest_hit(data, node->bv);
1595   if (dist >= data->hit.dist) {
1596     return;
1597   }
1598
1599   if (node->totnode == 0) {
1600     /* no need to check for 'data->callback' (using 'all' only makes sense with a callback). */
1601     dist = data->hit.dist;
1602     data->callback(data->userdata, node->index, &data->ray, &data->hit);
1603     data->hit.index = -1;
1604     data->hit.dist = dist;
1605   }
1606   else {
1607     /* pick loop direction to dive into the tree (based on ray direction and split axis) */
1608     if (data->ray_dot_axis[node->main_axis] > 0.0f) {
1609       for (i = 0; i != node->totnode; i++) {
1610         dfs_raycast_all(data, node->children[i]);
1611       }
1612     }
1613     else {
1614       for (i = node->totnode - 1; i >= 0; i--) {
1615         dfs_raycast_all(data, node->children[i]);
1616       }
1617     }
1618   }
1619 }
1620
1621 static void bvhtree_ray_cast_data_precalc(BVHRayCastData *data, int flag)
1622 {
1623   int i;
1624
1625   for (i = 0; i < 3; i++) {
1626     data->ray_dot_axis[i] = dot_v3v3(data->ray.direction, bvhtree_kdop_axes[i]);
1627     data->idot_axis[i] = 1.0f / data->ray_dot_axis[i];
1628
1629     if (fabsf(data->ray_dot_axis[i]) < FLT_EPSILON) {
1630       data->ray_dot_axis[i] = 0.0;
1631     }
1632     data->index[2 * i] = data->idot_axis[i] < 0.0f ? 1 : 0;
1633     data->index[2 * i + 1] = 1 - data->index[2 * i];
1634     data->index[2 * i] += 2 * i;
1635     data->index[2 * i + 1] += 2 * i;
1636   }
1637
1638 #ifdef USE_KDOPBVH_WATERTIGHT
1639   if (flag & BVH_RAYCAST_WATERTIGHT) {
1640     isect_ray_tri_watertight_v3_precalc(&data->isect_precalc, data->ray.direction);
1641     data->ray.isect_precalc = &data->isect_precalc;
1642   }
1643   else {
1644     data->ray.isect_precalc = NULL;
1645   }
1646 #else
1647   UNUSED_VARS(flag);
1648 #endif
1649 }
1650
1651 int BLI_bvhtree_ray_cast_ex(BVHTree *tree,
1652                             const float co[3],
1653                             const float dir[3],
1654                             float radius,
1655                             BVHTreeRayHit *hit,
1656                             BVHTree_RayCastCallback callback,
1657                             void *userdata,
1658                             int flag)
1659 {
1660   BVHRayCastData data;
1661   BVHNode *root = tree->nodes[tree->totleaf];
1662
1663   BLI_ASSERT_UNIT_V3(dir);
1664
1665   data.tree = tree;
1666
1667   data.callback = callback;
1668   data.userdata = userdata;
1669
1670   copy_v3_v3(data.ray.origin, co);
1671   copy_v3_v3(data.ray.direction, dir);
1672   data.ray.radius = radius;
1673
1674   bvhtree_ray_cast_data_precalc(&data, flag);
1675
1676   if (hit) {
1677     memcpy(&data.hit, hit, sizeof(*hit));
1678   }
1679   else {
1680     data.hit.index = -1;
1681     data.hit.dist = BVH_RAYCAST_DIST_MAX;
1682   }
1683
1684   if (root) {
1685     dfs_raycast(&data, root);
1686     //      iterative_raycast(&data, root);
1687   }
1688
1689   if (hit) {
1690     memcpy(hit, &data.hit, sizeof(*hit));
1691   }
1692
1693   return data.hit.index;
1694 }
1695
1696 int BLI_bvhtree_ray_cast(BVHTree *tree,
1697                          const float co[3],
1698                          const float dir[3],
1699                          float radius,
1700                          BVHTreeRayHit *hit,
1701                          BVHTree_RayCastCallback callback,
1702                          void *userdata)
1703 {
1704   return BLI_bvhtree_ray_cast_ex(
1705       tree, co, dir, radius, hit, callback, userdata, BVH_RAYCAST_DEFAULT);
1706 }
1707
1708 float BLI_bvhtree_bb_raycast(const float bv[6],
1709                              const float light_start[3],
1710                              const float light_end[3],
1711                              float pos[3])
1712 {
1713   BVHRayCastData data;
1714   float dist;
1715
1716   data.hit.dist = BVH_RAYCAST_DIST_MAX;
1717
1718   /* get light direction */
1719   sub_v3_v3v3(data.ray.direction, light_end, light_start);
1720
1721   data.ray.radius = 0.0;
1722
1723   copy_v3_v3(data.ray.origin, light_start);
1724
1725   normalize_v3(data.ray.direction);
1726   copy_v3_v3(data.ray_dot_axis, data.ray.direction);
1727
1728   dist = ray_nearest_hit(&data, bv);
1729
1730   madd_v3_v3v3fl(pos, light_start, data.ray.direction, dist);
1731
1732   return dist;
1733 }
1734
1735 /**
1736  * Calls the callback for every ray intersection
1737  *
1738  * \note Using a \a callback which resets or never sets the #BVHTreeRayHit index & dist works too,
1739  * however using this function means existing generic callbacks can be used from custom callbacks
1740  * without having to handle resetting the hit beforehand.
1741  * It also avoid redundant argument and return value which aren't meaningful
1742  * when collecting multiple hits.
1743  */
1744 void BLI_bvhtree_ray_cast_all_ex(BVHTree *tree,
1745                                  const float co[3],
1746                                  const float dir[3],
1747                                  float radius,
1748                                  float hit_dist,
1749                                  BVHTree_RayCastCallback callback,
1750                                  void *userdata,
1751                                  int flag)
1752 {
1753   BVHRayCastData data;
1754   BVHNode *root = tree->nodes[tree->totleaf];
1755
1756   BLI_ASSERT_UNIT_V3(dir);
1757   BLI_assert(callback != NULL);
1758
1759   data.tree = tree;
1760
1761   data.callback = callback;
1762   data.userdata = userdata;
1763
1764   copy_v3_v3(data.ray.origin, co);
1765   copy_v3_v3(data.ray.direction, dir);
1766   data.ray.radius = radius;
1767
1768   bvhtree_ray_cast_data_precalc(&data, flag);
1769
1770   data.hit.index = -1;
1771   data.hit.dist = hit_dist;
1772
1773   if (root) {
1774     dfs_raycast_all(&data, root);
1775   }
1776 }
1777
1778 void BLI_bvhtree_ray_cast_all(BVHTree *tree,
1779                               const float co[3],
1780                               const float dir[3],
1781                               float radius,
1782                               float hit_dist,
1783                               BVHTree_RayCastCallback callback,
1784                               void *userdata)
1785 {
1786   BLI_bvhtree_ray_cast_all_ex(
1787       tree, co, dir, radius, hit_dist, callback, userdata, BVH_RAYCAST_DEFAULT);
1788 }
1789
1790 /** \} */
1791
1792 /* -------------------------------------------------------------------- */
1793 /** \name BLI_bvhtree_range_query
1794  *
1795  * Allocs and fills an array with the indexs of node that are on the given spherical range
1796  * (center, radius).
1797  * Returns the size of the array.
1798  *
1799  * \{ */
1800
1801 typedef struct RangeQueryData {
1802   BVHTree *tree;
1803   const float *center;
1804   float radius_sq; /* squared radius */
1805
1806   int hits;
1807
1808   BVHTree_RangeQuery callback;
1809   void *userdata;
1810 } RangeQueryData;
1811
1812 static void dfs_range_query(RangeQueryData *data, BVHNode *node)
1813 {
1814   if (node->totnode == 0) {
1815 #if 0 /*UNUSED*/
1816     /* Calculate the node min-coords
1817      * (if the node was a point then this is the point coordinates) */
1818     float co[3];
1819     co[0] = node->bv[0];
1820     co[1] = node->bv[2];
1821     co[2] = node->bv[4];
1822 #endif
1823   }
1824   else {
1825     int i;
1826     for (i = 0; i != node->totnode; i++) {
1827       float nearest[3];
1828       float dist_sq = calc_nearest_point_squared(data->center, node->children[i], nearest);
1829       if (dist_sq < data->radius_sq) {
1830         /* Its a leaf.. call the callback */
1831         if (node->children[i]->totnode == 0) {
1832           data->hits++;
1833           data->callback(data->userdata, node->children[i]->index, data->center, dist_sq);
1834         }
1835         else {
1836           dfs_range_query(data, node->children[i]);
1837         }
1838       }
1839     }
1840   }
1841 }
1842
1843 int BLI_bvhtree_range_query(
1844     BVHTree *tree, const float co[3], float radius, BVHTree_RangeQuery callback, void *userdata)
1845 {
1846   BVHNode *root = tree->nodes[tree->totleaf];
1847
1848   RangeQueryData data;
1849   data.tree = tree;
1850   data.center = co;
1851   data.radius_sq = radius * radius;
1852   data.hits = 0;
1853
1854   data.callback = callback;
1855   data.userdata = userdata;
1856
1857   if (root != NULL) {
1858     float nearest[3];
1859     float dist_sq = calc_nearest_point_squared(data.center, root, nearest);
1860     if (dist_sq < data.radius_sq) {
1861       /* Its a leaf.. call the callback */
1862       if (root->totnode == 0) {
1863         data.hits++;
1864         data.callback(data.userdata, root->index, co, dist_sq);
1865       }
1866       else {
1867         dfs_range_query(&data, root);
1868       }
1869     }
1870   }
1871
1872   return data.hits;
1873 }
1874
1875 /** \} */
1876
1877 /* -------------------------------------------------------------------- */
1878 /** \name BLI_bvhtree_nearest_projected
1879  * \{ */
1880
1881 static void bvhtree_nearest_projected_dfs_recursive(BVHNearestProjectedData *__restrict data,
1882                                                     const BVHNode *node)
1883 {
1884   if (node->totnode == 0) {
1885     if (data->callback) {
1886       data->callback(data->userdata, node->index, &data->precalc, NULL, 0, &data->nearest);
1887     }
1888     else {
1889       data->nearest.index = node->index;
1890       data->nearest.dist_sq = dist_squared_to_projected_aabb(
1891           &data->precalc,
1892           (float[3]){node->bv[0], node->bv[2], node->bv[4]},
1893           (float[3]){node->bv[1], node->bv[3], node->bv[5]},
1894           data->closest_axis);
1895     }
1896   }
1897   else {
1898     /* First pick the closest node to recurse into */
1899     if (data->closest_axis[node->main_axis]) {
1900       for (int i = 0; i != node->totnode; i++) {
1901         const float *bv = node->children[i]->bv;
1902
1903         if (dist_squared_to_projected_aabb(&data->precalc,
1904                                            (float[3]){bv[0], bv[2], bv[4]},
1905                                            (float[3]){bv[1], bv[3], bv[5]},
1906                                            data->closest_axis) <= data->nearest.dist_sq) {
1907           bvhtree_nearest_projected_dfs_recursive(data, node->children[i]);
1908         }
1909       }
1910     }
1911     else {
1912       for (int i = node->totnode; i--;) {
1913         const float *bv = node->children[i]->bv;
1914
1915         if (dist_squared_to_projected_aabb(&data->precalc,
1916                                            (float[3]){bv[0], bv[2], bv[4]},
1917                                            (float[3]){bv[1], bv[3], bv[5]},
1918                                            data->closest_axis) <= data->nearest.dist_sq) {
1919           bvhtree_nearest_projected_dfs_recursive(data, node->children[i]);
1920         }
1921       }
1922     }
1923   }
1924 }
1925
1926 static void bvhtree_nearest_projected_with_clipplane_test_dfs_recursive(
1927     BVHNearestProjectedData *__restrict data, const BVHNode *node)
1928 {
1929   if (node->totnode == 0) {
1930     if (data->callback) {
1931       data->callback(data->userdata,
1932                      node->index,
1933                      &data->precalc,
1934                      data->clip_plane,
1935                      data->clip_plane_len,
1936                      &data->nearest);
1937     }
1938     else {
1939       data->nearest.index = node->index;
1940       data->nearest.dist_sq = dist_squared_to_projected_aabb(
1941           &data->precalc,
1942           (float[3]){node->bv[0], node->bv[2], node->bv[4]},
1943           (float[3]){node->bv[1], node->bv[3], node->bv[5]},
1944           data->closest_axis);
1945     }
1946   }
1947   else {
1948     /* First pick the closest node to recurse into */
1949     if (data->closest_axis[node->main_axis]) {
1950       for (int i = 0; i != node->totnode; i++) {
1951         const float *bv = node->children[i]->bv;
1952         const float bb_min[3] = {bv[0], bv[2], bv[4]};
1953         const float bb_max[3] = {bv[1], bv[3], bv[5]};
1954
1955         int isect_type = isect_aabb_planes_v3(
1956             data->clip_plane, data->clip_plane_len, bb_min, bb_max);
1957
1958         if ((isect_type != ISECT_AABB_PLANE_BEHIND_ANY) &&
1959             dist_squared_to_projected_aabb(&data->precalc, bb_min, bb_max, data->closest_axis) <=
1960                 data->nearest.dist_sq) {
1961           if (isect_type == ISECT_AABB_PLANE_CROSS_ANY) {
1962             bvhtree_nearest_projected_with_clipplane_test_dfs_recursive(data, node->children[i]);
1963           }
1964           else {
1965             /* ISECT_AABB_PLANE_IN_FRONT_ALL */
1966             bvhtree_nearest_projected_dfs_recursive(data, node->children[i]);
1967           }
1968         }
1969       }
1970     }
1971     else {
1972       for (int i = node->totnode; i--;) {
1973         const float *bv = node->children[i]->bv;
1974         const float bb_min[3] = {bv[0], bv[2], bv[4]};
1975         const float bb_max[3] = {bv[1], bv[3], bv[5]};
1976
1977         int isect_type = isect_aabb_planes_v3(
1978             data->clip_plane, data->clip_plane_len, bb_min, bb_max);
1979
1980         if (isect_type != ISECT_AABB_PLANE_BEHIND_ANY &&
1981             dist_squared_to_projected_aabb(&data->precalc, bb_min, bb_max, data->closest_axis) <=
1982                 data->nearest.dist_sq) {
1983           if (isect_type == ISECT_AABB_PLANE_CROSS_ANY) {
1984             bvhtree_nearest_projected_with_clipplane_test_dfs_recursive(data, node->children[i]);
1985           }
1986           else {
1987             /* ISECT_AABB_PLANE_IN_FRONT_ALL */
1988             bvhtree_nearest_projected_dfs_recursive(data, node->children[i]);
1989           }
1990         }
1991       }
1992     }
1993   }
1994 }
1995
1996 int BLI_bvhtree_find_nearest_projected(BVHTree *tree,
1997                                        float projmat[4][4],
1998                                        float winsize[2],
1999                                        float mval[2],
2000                                        float clip_plane[6][4],
2001                                        int clip_plane_len,
2002                                        BVHTreeNearest *nearest,
2003                                        BVHTree_NearestProjectedCallback callback,
2004                                        void *userdata)
2005 {
2006   BVHNode *root = tree->nodes[tree->totleaf];
2007   if (root != NULL) {
2008     BVHNearestProjectedData data;
2009     dist_squared_to_projected_aabb_precalc(&data.precalc, projmat, winsize, mval);
2010
2011     data.callback = callback;
2012     data.userdata = userdata;
2013
2014     if (clip_plane) {
2015       data.clip_plane_len = clip_plane_len;
2016       for (int i = 0; i < data.clip_plane_len; i++) {
2017         copy_v4_v4(data.clip_plane[i], clip_plane[i]);
2018       }
2019     }
2020     else {
2021       data.clip_plane_len = 1;
2022       planes_from_projmat(projmat, NULL, NULL, NULL, NULL, data.clip_plane[0], NULL);
2023     }
2024
2025     if (nearest) {
2026       memcpy(&data.nearest, nearest, sizeof(*nearest));
2027     }
2028     else {
2029       data.nearest.index = -1;
2030       data.nearest.dist_sq = FLT_MAX;
2031     }
2032     {
2033       const float bb_min[3] = {root->bv[0], root->bv[2], root->bv[4]};
2034       const float bb_max[3] = {root->bv[1], root->bv[3], root->bv[5]};
2035
2036       int isect_type = isect_aabb_planes_v3(data.clip_plane, data.clip_plane_len, bb_min, bb_max);
2037
2038       if (isect_type != 0 &&
2039           dist_squared_to_projected_aabb(&data.precalc, bb_min, bb_max, data.closest_axis) <=
2040               data.nearest.dist_sq) {
2041         if (isect_type == 1) {
2042           bvhtree_nearest_projected_with_clipplane_test_dfs_recursive(&data, root);
2043         }
2044         else {
2045           bvhtree_nearest_projected_dfs_recursive(&data, root);
2046         }
2047       }
2048     }
2049
2050     if (nearest) {
2051       memcpy(nearest, &data.nearest, sizeof(*nearest));
2052     }
2053
2054     return data.nearest.index;
2055   }
2056   return -1;
2057 }
2058
2059 /** \} */
2060
2061 /* -------------------------------------------------------------------- */
2062 /** \name BLI_bvhtree_walk_dfs
2063  * \{ */
2064
2065 typedef struct BVHTree_WalkData {
2066   BVHTree_WalkParentCallback walk_parent_cb;
2067   BVHTree_WalkLeafCallback walk_leaf_cb;
2068   BVHTree_WalkOrderCallback walk_order_cb;
2069   void *userdata;
2070 } BVHTree_WalkData;
2071
2072 /**
2073  * Runs first among nodes children of the first node before going
2074  * to the next node in the same layer.
2075  *
2076  * \return false to break out of the search early.
2077  */
2078 static bool bvhtree_walk_dfs_recursive(BVHTree_WalkData *walk_data, const BVHNode *node)
2079 {
2080   if (node->totnode == 0) {
2081     return walk_data->walk_leaf_cb(
2082         (const BVHTreeAxisRange *)node->bv, node->index, walk_data->userdata);
2083   }
2084   else {
2085     /* First pick the closest node to recurse into */
2086     if (walk_data->walk_order_cb(
2087             (const BVHTreeAxisRange *)node->bv, node->main_axis, walk_data->userdata)) {
2088       for (int i = 0; i != node->totnode; i++) {
2089         if (walk_data->walk_parent_cb((const BVHTreeAxisRange *)node->children[i]->bv,
2090                                       walk_data->userdata)) {
2091           if (!bvhtree_walk_dfs_recursive(walk_data, node->children[i])) {
2092             return false;
2093           }
2094         }
2095       }
2096     }
2097     else {
2098       for (int i = node->totnode - 1; i >= 0; i--) {
2099         if (walk_data->walk_parent_cb((const BVHTreeAxisRange *)node->children[i]->bv,
2100                                       walk_data->userdata)) {
2101           if (!bvhtree_walk_dfs_recursive(walk_data, node->children[i])) {
2102             return false;
2103           }
2104         }
2105       }
2106     }
2107   }
2108   return true;
2109 }
2110
2111 /**
2112  * This is a generic function to perform a depth first search on the BVHTree
2113  * where the search order and nodes traversed depend on callbacks passed in.
2114  *
2115  * \param tree: Tree to walk.
2116  * \param walk_parent_cb: Callback on a parents bound-box to test if it should be traversed.
2117  * \param walk_leaf_cb: Callback to test leaf nodes, callback must store its own result,
2118  * returning false exits early.
2119  * \param walk_order_cb: Callback that indicates which direction to search,
2120  * either from the node with the lower or higher k-dop axis value.
2121  * \param userdata: Argument passed to all callbacks.
2122  */
2123 void BLI_bvhtree_walk_dfs(BVHTree *tree,
2124                           BVHTree_WalkParentCallback walk_parent_cb,
2125                           BVHTree_WalkLeafCallback walk_leaf_cb,
2126                           BVHTree_WalkOrderCallback walk_order_cb,
2127                           void *userdata)
2128 {
2129   const BVHNode *root = tree->nodes[tree->totleaf];
2130   if (root != NULL) {
2131     BVHTree_WalkData walk_data = {walk_parent_cb, walk_leaf_cb, walk_order_cb, userdata};
2132     /* first make sure the bv of root passes in the test too */
2133     if (walk_parent_cb((const BVHTreeAxisRange *)root->bv, userdata)) {
2134       bvhtree_walk_dfs_recursive(&walk_data, root);
2135     }
2136   }
2137 }
2138
2139 /** \} */