Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / blenkernel / BKE_bvhutils.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): AndrĂ© Pinto
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_BVHUTILS_H__
28 #define __BKE_BVHUTILS_H__
29
30 /** \file BKE_bvhutils.h
31  *  \ingroup bke
32  */
33
34 #include "BLI_kdopbvh.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         struct BVHTree *tree;
49
50         /* default callbacks to bvh nearest and raycast */
51         BVHTree_NearestPointCallback nearest_callback;
52         BVHTree_RayCastCallback raycast_callback;
53
54         /* Vertex array, so that callbacks have instante access to data */
55         struct MVert *vert;
56         struct MEdge *edge;     /* only used for BVHTreeFromMeshEdges */
57         struct MFace *face;
58         bool vert_allocated;
59         bool face_allocated;
60         bool edge_allocated;
61
62         /* radius for raycast */
63         float sphere_radius;
64
65         /* Private data */
66         void *em_evil;  /* var only for snapping */
67         bool cached;
68
69 } BVHTreeFromMesh;
70
71 /*
72  * Builds a bvh tree where nodes are the vertexs of the given mesh.
73  * Configures BVHTreeFromMesh.
74  *
75  * The tree is build in mesh space coordinates, this means special care must be made on queries
76  * so that the coordinates and rays are first translated on the mesh local coordinates.
77  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becomes possible to reuse
78  * a BVHTree.
79  * 
80  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
81  */
82 BVHTree *bvhtree_from_mesh_verts(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
83
84 /*
85  * Builds a bvh tree where nodes are the faces of the given mesh.
86  * Configures BVHTreeFromMesh.
87  *
88  * The tree is build in mesh space coordinates, this means special care must be made on queries
89  * so that the coordinates and rays are first translated on the mesh local coordinates.
90  * Reason for this is that later bvh_from_mesh_* might use a cache system and so it becomes possible to reuse
91  * a BVHTree.
92  *
93  * The returned value is the same as in data->tree, its only returned to make it easier to test
94  * the success 
95  * 
96  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
97  */
98 BVHTree *bvhtree_from_mesh_faces(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
99
100 BVHTree *bvhtree_from_mesh_edges(struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
101
102 /*
103  * Frees data allocated by a call to bvhtree_from_mesh_*.
104  */
105 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
106
107 /*
108  * Math functions used by callbacks
109  */
110 float bvhtree_ray_tri_intersection(const BVHTreeRay *ray, const float m_dist, const float v0[3], const float v1[3], const float v2[3]);
111 float nearest_point_in_tri_surface_squared(const float v0[3], const float v1[3], const float v2[3], const float p[3], int *v, int *e, float nearest[3]);
112
113 /*
114  * BVHCache
115  */
116
117 //Using local coordinates
118 #define BVHTREE_FROM_FACES      0
119 #define BVHTREE_FROM_VERTICES   1
120 #define BVHTREE_FROM_EDGES      2
121
122 #define BVHTREE_FROM_FACES_EDITMESH  3
123
124 typedef struct LinkNode *BVHCache;
125
126
127 /*
128  * Queries a bvhcache for the cache bvhtree of the request type
129  */
130 BVHTree *bvhcache_find(BVHCache *cache, int type);
131
132 /*
133  * Inserts a BVHTree of the given type under the cache
134  * After that the caller no longer needs to worry when to free the BVHTree
135  * as that will be done when the cache is freed.
136  *
137  * A call to this assumes that there was no previous cached tree of the given type
138  */
139 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
140
141 /*
142  * inits and frees a bvhcache
143  */
144 void bvhcache_init(BVHCache *cache);
145 void bvhcache_free(BVHCache *cache);
146
147 #endif
148