2nd try to merge sim_physics with trunk rev 19825
[blender-staging.git] / source / blender / blenkernel / BKE_bvhutils.h
1 /**
2  *
3  * $Id: BKE_bvhutils.h 19805 2009-04-20 00:19:16Z genscher $
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): 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 MFace *face;
61
62         /* radius for raycast */
63         float sphere_radius;
64
65         /* Private data */
66         int cached;
67
68 } BVHTreeFromMesh;
69
70 /*
71  * Builds a bvh tree where nodes are the vertexs of the given mesh.
72  * Configures BVHTreeFromMesh.
73  *
74  * The tree is build in mesh space coordinates, this means special care must be made on queries
75  * so that the coordinates and rays are first translated on the mesh local coordinates.
76  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
77  * a BVHTree.
78  * 
79  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
80  */
81 BVHTree* bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
82
83 /*
84  * Builds a bvh tree where nodes are the faces of the given mesh.
85  * Configures BVHTreeFromMesh.
86  *
87  * The tree is build in mesh space coordinates, this means special care must be made on queries
88  * so that the coordinates and rays are first translated on the mesh local coordinates.
89  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
90  * a BVHTree.
91  *
92  * The returned value is the same as in data->tree, its only returned to make it easier to test
93  * the success 
94  * 
95  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
96  */
97 BVHTree* bvhtree_from_mesh_faces(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 /*
106  * BVHCache
107  */
108
109 //Using local coordinates
110 #define BVHTREE_FROM_FACES              0
111 #define BVHTREE_FROM_VERTICES   1
112
113 typedef LinkNode* BVHCache;
114
115
116 /*
117  * Queries a bvhcache for the chache bvhtree of the request type
118  */
119 BVHTree *bvhcache_find(BVHCache *cache, int type);
120
121 /*
122  * Inserts a BVHTree of the given type under the cache
123  * After that the caller no longer needs to worry when to free the BVHTree
124  * as that will be done when the cache is freed.
125  *
126  * A call to this assumes that there was no previous cached tree of the given type
127  */
128 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
129
130 /*
131  * inits and frees a bvhcache
132  */
133 void bvhcache_init(BVHCache *cache);
134 void bvhcache_free(BVHCache *cache);
135
136 #endif