Fix T37445: Crash with snapping and shrink-wrap modifier.
[blender.git] / source / blender / blenkernel / BKE_bvhutils.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  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): AndrĂ© Pinto
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_BVHUTILS_H__
28 #define __BKE_BVHUTILS_H__
29
30 /** \file BKE_bvhutils.h
31  *  \ingroup bke
32  */
33
34 #include "BLI_kdopbvh.h"
35
36 /*
37  * This header encapsulates necessary code to buld a BVH
38  */
39
40 struct DerivedMesh;
41 struct MVert;
42 struct MFace;
43
44 /*
45  * struct that kepts basic information about a BVHTree build from a mesh
46  */
47 typedef struct BVHTreeFromMesh {
48         struct BVHTree *tree;
49
50         /* default callbacks to bvh nearest and raycast */
51         BVHTree_NearestPointCallback nearest_callback;
52         BVHTree_RayCastCallback raycast_callback;
53
54         /* Vertex array, so that callbacks have instante access to data */
55         struct MVert *vert;
56         struct MEdge *edge;     /* only used for BVHTreeFromMeshEdges */
57         struct MFace *face;
58
59         /* radius for raycast */
60         float sphere_radius;
61
62         /* Private data */
63         void *em_evil;  /* var only for snapping */
64         bool cached;
65
66 } BVHTreeFromMesh;
67
68 /*
69  * Builds a bvh tree where nodes are the vertexs of the given mesh.
70  * Configures BVHTreeFromMesh.
71  *
72  * The tree is build in mesh space coordinates, this means special care must be made on queries
73  * so that the coordinates and rays are first translated on the mesh local coordinates.
74  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becomes possible to reuse
75  * a BVHTree.
76  * 
77  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
78  */
79 BVHTree *bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
80
81 /*
82  * Builds a bvh tree where nodes are the faces of the given mesh.
83  * Configures BVHTreeFromMesh.
84  *
85  * The tree is build in mesh space coordinates, this means special care must be made on queries
86  * so that the coordinates and rays are first translated on the mesh local coordinates.
87  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becomes possible to reuse
88  * a BVHTree.
89  *
90  * The returned value is the same as in data->tree, its only returned to make it easier to test
91  * the success 
92  * 
93  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
94  */
95 BVHTree *bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
96
97 BVHTree *bvhtree_from_mesh_edges(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
98
99 /*
100  * Frees data allocated by a call to bvhtree_from_mesh_*.
101  */
102 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
103
104 /*
105  * Math functions used by callbacks
106  */
107 float bvhtree_ray_tri_intersection(const BVHTreeRay *ray, const float m_dist, const float v0[3], const float v1[3], const float v2[3]);
108 float nearest_point_in_tri_surface(const float v0[3], const float v1[3], const float v2[3], const float p[3], int *v, int *e, float nearest[3]);
109
110 /*
111  * BVHCache
112  */
113
114 //Using local coordinates
115 #define BVHTREE_FROM_FACES      0
116 #define BVHTREE_FROM_VERTICES   1
117 #define BVHTREE_FROM_EDGES      2
118
119 #define BVHTREE_FROM_FACES_EDITMESH  3
120
121 typedef struct LinkNode *BVHCache;
122
123
124 /*
125  * Queries a bvhcache for the cache bvhtree of the request type
126  */
127 BVHTree *bvhcache_find(BVHCache *cache, int type);
128
129 /*
130  * Inserts a BVHTree of the given type under the cache
131  * After that the caller no longer needs to worry when to free the BVHTree
132  * as that will be done when the cache is freed.
133  *
134  * A call to this assumes that there was no previous cached tree of the given type
135  */
136 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
137
138 /*
139  * inits and frees a bvhcache
140  */
141 void bvhcache_init(BVHCache *cache);
142 void bvhcache_free(BVHCache *cache);
143
144 #endif
145