Merged changes in the trunk up to revision 41225.
[blender.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
38 /*
39  * This header encapsulates necessary code to buld a BVH
40  */
41
42 struct DerivedMesh;
43 struct MVert;
44 struct MFace;
45
46 /*
47  * struct that kepts basic information about a BVHTree build from a mesh
48  */
49 typedef struct BVHTreeFromMesh
50 {
51         struct BVHTree *tree;
52
53         /* default callbacks to bvh nearest and raycast */
54         BVHTree_NearestPointCallback nearest_callback;
55         BVHTree_RayCastCallback      raycast_callback;
56
57         /* Mesh represented on this BVHTree */
58         struct DerivedMesh *mesh;
59
60         /* Vertex array, so that callbacks have instante access to data */
61         struct MVert *vert;
62         struct MEdge *edge;             /* only used for BVHTreeFromMeshEdges */
63         struct MFace *face;
64
65         /* radius for raycast */
66         float sphere_radius;
67
68         /* Private data */
69         int cached;
70         void *em_evil;  /* var only for snapping */
71
72 } BVHTreeFromMesh;
73
74 /*
75  * Builds a bvh tree where nodes are the vertexs of the given mesh.
76  * Configures BVHTreeFromMesh.
77  *
78  * The tree is build in mesh space coordinates, this means special care must be made on queries
79  * so that the coordinates and rays are first translated on the mesh local coordinates.
80  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
81  * a BVHTree.
82  * 
83  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
84  */
85 BVHTree* bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
86
87 /*
88  * Builds a bvh tree where nodes are the faces of the given mesh.
89  * Configures BVHTreeFromMesh.
90  *
91  * The tree is build in mesh space coordinates, this means special care must be made on queries
92  * so that the coordinates and rays are first translated on the mesh local coordinates.
93  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
94  * a BVHTree.
95  *
96  * The returned value is the same as in data->tree, its only returned to make it easier to test
97  * the success 
98  * 
99  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
100  */
101 BVHTree* bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
102
103 BVHTree* bvhtree_from_mesh_edges(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
104
105 /*
106  * Frees data allocated by a call to bvhtree_from_mesh_*.
107  */
108 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
109
110
111 /*
112  * BVHCache
113  */
114
115 //Using local coordinates
116 #define BVHTREE_FROM_FACES              0
117 #define BVHTREE_FROM_VERTICES   1
118 #define BVHTREE_FROM_EDGES              2
119
120 typedef struct LinkNode* BVHCache;
121
122
123 /*
124  * Queries a bvhcache for the chache bvhtree of the request type
125  */
126 BVHTree *bvhcache_find(BVHCache *cache, int type);
127
128 /*
129  * Inserts a BVHTree of the given type under the cache
130  * After that the caller no longer needs to worry when to free the BVHTree
131  * as that will be done when the cache is freed.
132  *
133  * A call to this assumes that there was no previous cached tree of the given type
134  */
135 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
136
137 /*
138  * inits and frees a bvhcache
139  */
140 void bvhcache_init(BVHCache *cache);
141 void bvhcache_free(BVHCache *cache);
142
143 #endif
144