source/blender/blenlib/BLI_kdopbvh.h

   1 /**
   2  *
   3  * $Id$
   4  *
   5  * ***** BEGIN GPL LICENSE BLOCK *****
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software Foundation,
  19  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20  *
  21  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
  22  * All rights reserved.
  23  *
  24  * The Original Code is: all of this file.
  25  *
  26  * Contributor(s): Daniel Genrich, Andre Pinto
  27  *
  28  * ***** END GPL LICENSE BLOCK *****
  29  */
  30
  31
  32 #ifndef BLI_KDOPBVH_H
  33 #define BLI_KDOPBVH_H
  34
  35 #include <float.h>
  36
  37 struct BVHTree;
  38 typedef struct BVHTree BVHTree;
  39
  40 typedef struct BVHTreeOverlap {
  41         int indexA;
  42         int indexB;
  43 } BVHTreeOverlap;
  44
  45 typedef struct BVHTreeNearest
  46 {
  47         int index;                      /* the index of the nearest found (untouched if none is found within a dist radius from the given coordinates) */
  48         float co[3];            /* nearest coordinates (untouched it none is found within a dist radius from the given coordinates) */
  49         float no[3];            /* normal at nearest coordinates (untouched it none is found within a dist radius from the given coordinates) */
  50         float dist;                     /* squared distance to search arround */
  51 } BVHTreeNearest;
  52
  53 typedef struct BVHTreeRay
  54 {
  55         float origin[3];        /* ray origin */
  56         float direction[3];     /* ray direction */
  57         float radius;           /* radius around ray */
  58 } BVHTreeRay;
  59
  60 typedef struct BVHTreeRayHit
  61 {
  62         int index;                      /* index of the tree node (untouched if no hit is found) */
  63         float co[3];            /* coordinates of the hit point */
  64         float no[3];            /* normal on hit point */
  65         float dist;                     /* distance to the hit point */
  66 } BVHTreeRayHit;
  67
  68 /* callback must update nearest in case it finds a nearest result */
  69 typedef void (*BVHTree_NearestPointCallback) (void *userdata, int index, const float *co, BVHTreeNearest *nearest);
  70
  71 /* callback must update hit in case it finds a nearest successful hit */
  72 typedef void (*BVHTree_RayCastCallback) (void *userdata, int index, const BVHTreeRay *ray, BVHTreeRayHit *hit);
  73
  74
  75 BVHTree *BLI_bvhtree_new(int maxsize, float epsilon, char tree_type, char axis);
  76 void BLI_bvhtree_free(BVHTree *tree);
  77
  78 /* construct: first insert points, then call balance */
  79 int BLI_bvhtree_insert(BVHTree *tree, int index, float *co, int numpoints);
  80 void BLI_bvhtree_balance(BVHTree *tree);
  81
  82 /* update: first update points/nodes, then call update_tree to refit the bounding volumes */
  83 int BLI_bvhtree_update_node(BVHTree *tree, int index, float *co, float *co_moving, int numpoints);
  84 void BLI_bvhtree_update_tree(BVHTree *tree);
  85
  86 /* collision/overlap: check two trees if they overlap, alloc's *overlap with length of the int return value */
  87 BVHTreeOverlap *BLI_bvhtree_overlap(BVHTree *tree1, BVHTree *tree2, int *result);
  88
  89 float BLI_bvhtree_getepsilon(BVHTree *tree);
  90
  91 /* find nearest node to the given coordinates (if nearest is given it will only search nodes where square distance is smaller than nearest->dist) */
  92 int BLI_bvhtree_find_nearest(BVHTree *tree, const float *co, BVHTreeNearest *nearest, BVHTree_NearestPointCallback callback, void *userdata);
  93
  94 int BLI_bvhtree_ray_cast(BVHTree *tree, const float *co, const float *dir, float radius, BVHTreeRayHit *hit, BVHTree_RayCastCallback callback, void *userdata);
  95
  96 #endif // BLI_KDOPBVH_H
  97