Merge from trunk 16031:16122
[blender-staging.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., 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
35 /*
36  * This header encapsulates necessary code to buld a BVH
37  */
38
39 struct DerivedMesh;
40 struct MVert;
41 struct MFace;
42
43 /*
44  * struct that kepts basic information about a BVHTree build from a mesh
45  */
46 typedef struct BVHTreeFromMesh
47 {
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         /* Mesh represented on this BVHTree */
55         struct DerivedMesh *mesh; 
56
57         /* Vertex array, so that callbacks have instante access to data */
58         struct MVert *vert;
59         struct MFace *face;
60
61         /* radius for raycast */
62         float sphere_radius;
63
64 } BVHTreeFromMesh;
65
66 /*
67  * Builds a bvh tree where nodes are the vertexs of the given mesh.
68  * Configures BVHTreeFromMesh.
69  *
70  * The tree is build in mesh space coordinates, this means special care must be made on queries
71  * so that the coordinates and rays are first translated on the mesh local coordinates.
72  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
73  * a BVHTree.
74  * 
75  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
76  */
77 void bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
78
79 /*
80  * Builds a bvh tree where nodes are the faces of the given mesh.
81  * Configures BVHTreeFromMesh.
82  *
83  * The tree is build in mesh space coordinates, this means special care must be made on queries
84  * so that the coordinates and rays are first translated on the mesh local coordinates.
85  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becames possible to reuse
86  * a BVHTree.
87  * 
88  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
89  */
90 void bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
91
92 /*
93  * Frees data allocated by a call to bvhtree_from_mesh_*.
94  */
95 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
96
97 #endif
98