doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_bvhutils.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2006 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_BVHUTILS_H__
20 #define __BKE_BVHUTILS_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 #include "BLI_bitmap.h"
27 #include "BLI_kdopbvh.h"
28
29 /**
30  * This header encapsulates necessary code to build a BVH
31  */
32
33 struct BMEditMesh;
34 struct DerivedMesh;
35 struct MFace;
36 struct MVert;
37 struct Mesh;
38
39 typedef struct LinkNode BVHCache;
40
41 /**
42  * Struct that stores basic information about a BVHTree built from a edit-mesh.
43  */
44 typedef struct BVHTreeFromEditMesh {
45         struct BVHTree *tree;
46
47         /* default callbacks to bvh nearest and raycast */
48         BVHTree_NearestPointCallback nearest_callback;
49         BVHTree_RayCastCallback raycast_callback;
50
51         struct BMEditMesh *em;
52
53         /* Private data */
54         bool cached;
55
56 } BVHTreeFromEditMesh;
57
58 /**
59  * Struct that stores basic information about a BVHTree built from a mesh.
60  */
61 typedef struct BVHTreeFromMesh {
62         struct BVHTree *tree;
63
64         /* default callbacks to bvh nearest and raycast */
65         BVHTree_NearestPointCallback nearest_callback;
66         BVHTree_RayCastCallback raycast_callback;
67
68         /* Vertex array, so that callbacks have instante access to data */
69         const struct MVert *vert;
70         const struct MEdge *edge;     /* only used for BVHTreeFromMeshEdges */
71         const struct MFace *face;
72         const struct MLoop *loop;
73         const struct MLoopTri *looptri;
74         bool vert_allocated;
75         bool edge_allocated;
76         bool face_allocated;
77         bool loop_allocated;
78         bool looptri_allocated;
79
80         /* Private data */
81         bool cached;
82
83 } BVHTreeFromMesh;
84
85 /**
86  * Builds a bvh tree where nodes are the relevant elements of the given mesh.
87  * Configures BVHTreeFromMesh.
88  *
89  * The tree is build in mesh space coordinates, this means special care must be made on queries
90  * so that the coordinates and rays are first translated on the mesh local coordinates.
91  * Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it becomes possible to reuse a BVHTree.
92  *
93  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
94  */
95 BVHTree *bvhtree_from_editmesh_verts(
96         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
97         float epsilon, int tree_type, int axis, BVHCache **bvh_cache);
98 BVHTree *bvhtree_from_editmesh_verts_ex(
99         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
100         const BLI_bitmap *mask, int verts_num_active,
101         float epsilon, int tree_type, int axis);
102
103 BVHTree *bvhtree_from_mesh_verts_ex(
104         struct BVHTreeFromMesh *data, const struct MVert *vert, const int numVerts,
105         const bool vert_allocated, const BLI_bitmap *mask, int verts_num_active,
106         float epsilon, int tree_type, int axis);
107
108 BVHTree *bvhtree_from_editmesh_edges(
109         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
110         float epsilon, int tree_type, int axis, BVHCache **bvh_cache);
111 BVHTree *bvhtree_from_editmesh_edges_ex(
112         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
113         const BLI_bitmap *edges_mask, int edges_num_active,
114         float epsilon, int tree_type, int axis);
115
116 BVHTree *bvhtree_from_mesh_edges_ex(
117         struct BVHTreeFromMesh *data,
118         const struct MVert *vert, const bool vert_allocated,
119         const struct MEdge *edge, const int edges_num, const bool edge_allocated,
120         const BLI_bitmap *edges_mask, int edges_num_active,
121         float epsilon, int tree_type, int axis);
122
123 BVHTree *bvhtree_from_mesh_faces_ex(
124         struct BVHTreeFromMesh *data,
125         const struct MVert *vert, const bool vert_allocated,
126         const struct MFace *face, const int numFaces, const bool face_allocated,
127         const BLI_bitmap *mask, int numFaces_active,
128         float epsilon, int tree_type, int axis);
129
130 BVHTree *bvhtree_from_editmesh_looptri(
131         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
132         float epsilon, int tree_type, int axis, BVHCache **bvhCache);
133 BVHTree *bvhtree_from_editmesh_looptri_ex(
134         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
135         const BLI_bitmap *mask, int looptri_num_active,
136         float epsilon, int tree_type, int axis, BVHCache **bvhCache);
137
138 BVHTree *bvhtree_from_mesh_looptri_ex(
139         struct BVHTreeFromMesh *data,
140         const struct MVert *vert, const bool vert_allocated,
141         const struct MLoop *mloop, const bool loop_allocated,
142         const struct MLoopTri *looptri, const int looptri_num, const bool looptri_allocated,
143         const BLI_bitmap *mask, int looptri_num_active,
144         float epsilon, int tree_type, int axis);
145
146 BVHTree *BKE_bvhtree_from_mesh_get(
147         struct BVHTreeFromMesh *data, struct Mesh *mesh,
148         const int type, const int tree_type);
149
150 /**
151  * Frees data allocated by a call to bvhtree_from_mesh_*.
152  */
153 void free_bvhtree_from_editmesh(struct BVHTreeFromEditMesh *data);
154 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
155
156 /**
157  * Math functions used by callbacks
158  */
159 float bvhtree_ray_tri_intersection(
160         const BVHTreeRay *ray, const float m_dist,
161         const float v0[3], const float v1[3], const float v2[3]);
162 float bvhtree_sphereray_tri_intersection(
163         const BVHTreeRay *ray, float radius, const float m_dist,
164         const float v0[3], const float v1[3], const float v2[3]);
165
166
167 /**
168  * BVHCache
169  */
170
171 /* Using local coordinates */
172 enum {
173         BVHTREE_FROM_VERTS           = 0,
174         BVHTREE_FROM_EDGES           = 1,
175         BVHTREE_FROM_FACES           = 2,
176         BVHTREE_FROM_LOOPTRI         = 3,
177
178         BVHTREE_FROM_LOOSEVERTS      = 4,
179         BVHTREE_FROM_LOOSEEDGES      = 5,
180
181         BVHTREE_FROM_EM_VERTS        = 6,
182         BVHTREE_FROM_EM_EDGES        = 7,
183         BVHTREE_FROM_EM_LOOPTRI      = 8,
184 };
185
186
187 bool     bvhcache_find(const BVHCache *cache, int type, BVHTree **r_tree);
188 bool     bvhcache_has_tree(const BVHCache *cache, const BVHTree *tree);
189 void     bvhcache_insert(BVHCache **cache_p, BVHTree *tree, int type);
190 void     bvhcache_free(BVHCache **cache_p);
191
192
193 #endif