synched with trunk at revision 36569
[blender-staging.git] / source / blender / blenkernel / BKE_bvhutils.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): AndrĂ© Pinto
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_BVHUTILS_H
30 #define BKE_BVHUTILS_H
31
32 /** \file BKE_bvhutils.h
33  *  \ingroup bke
34  */
35
36 #include "BLI_kdopbvh.h"
37 #include "BLI_linklist.h"
38
39 /*
40  * This header encapsulates necessary code to buld a BVH
41  */
42
43 struct DerivedMesh;
44 struct MVert;
45 struct MFace;
46
47 /*
48  * struct that kepts basic information about a BVHTree build from a mesh
49  */
50 typedef struct BVHTreeFromMesh
51 {
52         struct BVHTree *tree;
53
54         /* default callbacks to bvh nearest and raycast */
55         BVHTree_NearestPointCallback nearest_callback;
56         BVHTree_RayCastCallback      raycast_callback;
57
58         /* Mesh represented on this BVHTree */
59         struct DerivedMesh *mesh;
60
61         /* Vertex array, so that callbacks have instante access to data */
62         struct MVert *vert;
63         struct MEdge *edge;             /* only used for BVHTreeFromMeshEdges */
64         struct MFace *face;
65
66         /* radius for raycast */
67         float sphere_radius;
68
69         /* Private data */
70         int cached;
71         void *em_evil;  /* var only for snapping */
72
73 } BVHTreeFromMesh;
74
75 /*
76  * Builds a bvh tree where nodes are the vertexs of the given mesh.
77  * Configures BVHTreeFromMesh.
78  *
79  * The tree is build in mesh space coordinates, this means special care must be made on queries
80  * so that the coordinates and rays are first translated on the mesh local coordinates.
81  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
82  * a BVHTree.
83  * 
84  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
85  */
86 BVHTree* bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
87
88 /*
89  * Builds a bvh tree where nodes are the faces of the given mesh.
90  * Configures BVHTreeFromMesh.
91  *
92  * The tree is build in mesh space coordinates, this means special care must be made on queries
93  * so that the coordinates and rays are first translated on the mesh local coordinates.
94  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
95  * a BVHTree.
96  *
97  * The returned value is the same as in data->tree, its only returned to make it easier to test
98  * the success 
99  * 
100  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
101  */
102 BVHTree* bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
103
104 BVHTree* bvhtree_from_mesh_edges(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
105
106 /*
107  * Frees data allocated by a call to bvhtree_from_mesh_*.
108  */
109 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
110
111
112 /*
113  * BVHCache
114  */
115
116 //Using local coordinates
117 #define BVHTREE_FROM_FACES              0
118 #define BVHTREE_FROM_VERTICES   1
119 #define BVHTREE_FROM_EDGES              2
120
121 typedef LinkNode* BVHCache;
122
123
124 /*
125  * Queries a bvhcache for the chache 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