Armature drawing: custom shape scale options
[blender-staging.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_bitmap.h"
35 #include "BLI_kdopbvh.h"
36
37 /**
38  * This header encapsulates necessary code to buld a BVH
39  */
40
41 struct DerivedMesh;
42 struct MVert;
43 struct MFace;
44
45 /**
46  * struct that kepts basic information about a BVHTree build from a mesh
47  */
48 typedef struct BVHTreeFromMesh {
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         /* Vertex array, so that callbacks have instante access to data */
56         const struct MVert *vert;
57         const struct MEdge *edge;     /* only used for BVHTreeFromMeshEdges */
58         const struct MFace *face;
59         const struct MLoop *loop;
60         const struct MLoopTri *looptri;
61         bool vert_allocated;
62         bool edge_allocated;
63         bool face_allocated;
64         bool loop_allocated;
65         bool looptri_allocated;
66
67         /* radius for raycast */
68         float sphere_radius;
69
70         /* Private data */
71         void *em_evil;  /* var only for snapping */
72         bool cached;
73
74 } BVHTreeFromMesh;
75
76 /**
77  * Builds a bvh tree where nodes are the relevant elements of the given mesh.
78  * Configures BVHTreeFromMesh.
79  *
80  * The tree is build in mesh space coordinates, this means special care must be made on queries
81  * so that the coordinates and rays are first translated on the mesh local coordinates.
82  * Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it becomes possible to reuse a BVHTree.
83  * 
84  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
85  */
86 BVHTree *bvhtree_from_mesh_verts(
87         struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
88 BVHTree *bvhtree_from_mesh_verts_ex(
89         struct BVHTreeFromMesh *data, struct MVert *vert, const int numVerts,
90         const bool vert_allocated, BLI_bitmap *mask, int numVerts_active,
91         float epsilon, int tree_type, int axis);
92
93 BVHTree *bvhtree_from_mesh_edges(
94         struct BVHTreeFromMesh *data, struct DerivedMesh *mesh,
95         float epsilon, int tree_type, int axis);
96
97 BVHTree *bvhtree_from_mesh_faces(
98         struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon,
99         int tree_type, int axis);
100 BVHTree *bvhtree_from_mesh_faces_ex(
101         struct BVHTreeFromMesh *data,
102         struct MVert *vert, const bool vert_allocated,
103         struct MFace *face, const int numFaces, const bool face_allocated,
104         BLI_bitmap *mask, int numFaces_active,
105         float epsilon, int tree_type, int axis);
106
107 BVHTree *bvhtree_from_mesh_looptri(
108         struct BVHTreeFromMesh *data, struct DerivedMesh *mesh, float epsilon, int tree_type, int axis);
109 BVHTree *bvhtree_from_mesh_looptri_ex(
110         struct BVHTreeFromMesh *data,
111         const struct MVert *vert, const bool vert_allocated,
112         const struct MLoop *mloop, const bool loop_allocated,
113         const struct MLoopTri *looptri, const int looptri_num, const bool looptri_allocated,
114         BLI_bitmap *mask, int looptri_num_active,
115         float epsilon, int tree_type, int axis);
116
117 /**
118  * Frees data allocated by a call to bvhtree_from_mesh_*.
119  */
120 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
121
122 /**
123  * Math functions used by callbacks
124  */
125 float bvhtree_ray_tri_intersection(
126         const BVHTreeRay *ray, const float m_dist,
127         const float v0[3], const float v1[3], const float v2[3]);
128 float bvhtree_sphereray_tri_intersection(
129         const BVHTreeRay *ray, float radius, const float m_dist,
130         const float v0[3], const float v1[3], const float v2[3]);
131 float nearest_point_in_tri_surface_squared(
132         const float v0[3], const float v1[3], const float v2[3],
133         const float p[3], int *v, int *e, float nearest[3]);
134
135 /**
136  * BVHCache
137  */
138
139 /* Using local coordinates */
140 enum {
141         BVHTREE_FROM_VERTS           = 0,
142         BVHTREE_FROM_EDGES           = 1,
143         BVHTREE_FROM_FACES           = 2,
144         BVHTREE_FROM_FACES_EDITMESH  = 3,
145         BVHTREE_FROM_LOOPTRI         = 4,
146 };
147
148 typedef struct LinkNode *BVHCache;
149
150
151 /**
152  * Queries a bvhcache for the cache bvhtree of the request type
153  */
154 BVHTree *bvhcache_find(BVHCache *cache, int type);
155
156 /**
157  * Inserts a BVHTree of the given type under the cache
158  * After that the caller no longer needs to worry when to free the BVHTree
159  * as that will be done when the cache is freed.
160  *
161  * A call to this assumes that there was no previous cached tree of the given type
162  */
163 void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
164
165 /**
166  * inits and frees a bvhcache
167  */
168 void bvhcache_init(BVHCache *cache);
169 void bvhcache_free(BVHCache *cache);
170
171 #endif
172