bugfix [#20768] Project Snap Broken
[blender.git] / source / blender / blenkernel / BKE_bvhutils.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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): AndrĂ© Pinto
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30 #ifndef BKE_BVHUTILS_H
31 #define BKE_BVHUTILS_H
32
33 #include "BLI_kdopbvh.h"
34 #include "BLI_linklist.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 {
49         struct BVHTree *tree;
50
51         /* default callbacks to bvh nearest and raycast */
52         BVHTree_NearestPointCallback nearest_callback;
53         BVHTree_RayCastCallback      raycast_callback;
54
55         /* Mesh represented on this BVHTree */
56         struct DerivedMesh *mesh;
57
58         /* Vertex array, so that callbacks have instante access to data */
59         struct MVert *vert;
60         struct MEdge *edge;             /* only used for BVHTreeFromMeshEdges */
61         struct MFace *face;
62
63         /* radius for raycast */
64         float sphere_radius;
65
66         /* Private data */
67         int cached;
68         void *em_evil;  /* var only for snapping */
69
70 } BVHTreeFromMesh;
71
72 /*
73  * Builds a bvh tree where nodes are the vertexs of the given mesh.
74  * Configures BVHTreeFromMesh.
75  *
76  * The tree is build in mesh space coordinates, this means special care must be made on queries
77  * so that the coordinates and rays are first translated on the mesh local coordinates.
78  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
79  * a BVHTree.
80  * 
81  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
82  */
83 BVHTree* bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
84
85 /*
86  * Builds a bvh tree where nodes are the faces of the given mesh.
87  * Configures BVHTreeFromMesh.
88  *
89  * The tree is build in mesh space coordinates, this means special care must be made on queries
90  * so that the coordinates and rays are first translated on the mesh local coordinates.
91  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
92  * a BVHTree.
93  *
94  * The returned value is the same as in data->tree, its only returned to make it easier to test
95  * the success 
96  * 
97  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
98  */
99 BVHTree* bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
100
101 BVHTree* bvhtree_from_mesh_edges(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
102
103 /*
104  * Frees data allocated by a call to bvhtree_from_mesh_*.
105  */
106 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
107
108
109 /*
110  * BVHCache
111  */
112
113 //Using local coordinates
114 #define BVHTREE_FROM_FACES              0
115 #define BVHTREE_FROM_VERTICES   1
116 #define BVHTREE_FROM_EDGES              2
117
118 typedef LinkNode* BVHCache;
119
120
121 /*
122  * Queries a bvhcache for the chache bvhtree of the request type
123  */
124 BVHTree *bvhcache_find(BVHCache *cache, int type);
125
126 /*
127  * Inserts a BVHTree of the given type under the cache
128  * After that the caller no longer needs to worry when to free the BVHTree
129  * as that will be done when the cache is freed.
130  *
131  * A call to this assumes that there was no previous cached tree of the given type
132  */
133 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
134
135 /*
136  * inits and frees a bvhcache
137  */
138 void bvhcache_init(BVHCache *cache);
139 void bvhcache_free(BVHCache *cache);
140
141 #endif
142