Physically based defaults for Eevee Bloom and Shutter
[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_bitmap.h"
35 #include "BLI_kdopbvh.h"
36
37 /**
38  * This header encapsulates necessary code to build a BVH
39  */
40
41 struct DerivedMesh;
42 struct BMEditMesh;
43 struct Mesh;
44 struct MVert;
45 struct MFace;
46
47 typedef struct LinkNode BVHCache;
48
49 /**
50  * Struct that stores basic information about a BVHTree built from a edit-mesh.
51  */
52 typedef struct BVHTreeFromEditMesh {
53         struct BVHTree *tree;
54
55         /* default callbacks to bvh nearest and raycast */
56         BVHTree_NearestPointCallback nearest_callback;
57         BVHTree_RayCastCallback raycast_callback;
58
59         struct BMEditMesh *em;
60
61         /* Private data */
62         bool cached;
63
64 } BVHTreeFromEditMesh;
65
66 /**
67  * Struct that stores basic information about a BVHTree built from a mesh.
68  */
69 typedef struct BVHTreeFromMesh {
70         struct BVHTree *tree;
71
72         /* default callbacks to bvh nearest and raycast */
73         BVHTree_NearestPointCallback nearest_callback;
74         BVHTree_RayCastCallback raycast_callback;
75
76         /* Vertex array, so that callbacks have instante access to data */
77         const struct MVert *vert;
78         const struct MEdge *edge;     /* only used for BVHTreeFromMeshEdges */
79         const struct MFace *face;
80         const struct MLoop *loop;
81         const struct MLoopTri *looptri;
82         bool vert_allocated;
83         bool edge_allocated;
84         bool face_allocated;
85         bool loop_allocated;
86         bool looptri_allocated;
87
88         /* Private data */
89         bool cached;
90
91 } BVHTreeFromMesh;
92
93 /**
94  * Builds a bvh tree where nodes are the relevant elements of the given mesh.
95  * Configures BVHTreeFromMesh.
96  *
97  * The tree is build in mesh space coordinates, this means special care must be made on queries
98  * so that the coordinates and rays are first translated on the mesh local coordinates.
99  * Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it becomes possible to reuse a BVHTree.
100  *
101  * free_bvhtree_from_mesh should be called when the tree is no longer needed.
102  */
103 BVHTree *bvhtree_from_editmesh_verts(
104         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
105         float epsilon, int tree_type, int axis, BVHCache **bvh_cache);
106 BVHTree *bvhtree_from_editmesh_verts_ex(
107         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
108         const BLI_bitmap *mask, int verts_num_active,
109         float epsilon, int tree_type, int axis);
110
111 BVHTree *bvhtree_from_mesh_verts_ex(
112         struct BVHTreeFromMesh *data, const struct MVert *vert, const int numVerts,
113         const bool vert_allocated, const BLI_bitmap *mask, int verts_num_active,
114         float epsilon, int tree_type, int axis);
115
116 BVHTree *bvhtree_from_editmesh_edges(
117         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
118         float epsilon, int tree_type, int axis, BVHCache **bvh_cache);
119 BVHTree *bvhtree_from_editmesh_edges_ex(
120         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
121         const BLI_bitmap *edges_mask, int edges_num_active,
122         float epsilon, int tree_type, int axis);
123
124 BVHTree *bvhtree_from_mesh_edges_ex(
125         struct BVHTreeFromMesh *data,
126         const struct MVert *vert, const bool vert_allocated,
127         const struct MEdge *edge, const int edges_num, const bool edge_allocated,
128         const BLI_bitmap *edges_mask, int edges_num_active,
129         float epsilon, int tree_type, int axis);
130
131 BVHTree *bvhtree_from_mesh_faces_ex(
132         struct BVHTreeFromMesh *data,
133         const struct MVert *vert, const bool vert_allocated,
134         const struct MFace *face, const int numFaces, const bool face_allocated,
135         const BLI_bitmap *mask, int numFaces_active,
136         float epsilon, int tree_type, int axis);
137
138 BVHTree *bvhtree_from_editmesh_looptri(
139         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
140         float epsilon, int tree_type, int axis, BVHCache **bvhCache);
141 BVHTree *bvhtree_from_editmesh_looptri_ex(
142         BVHTreeFromEditMesh *data, struct BMEditMesh *em,
143         const BLI_bitmap *mask, int looptri_num_active,
144         float epsilon, int tree_type, int axis, BVHCache **bvhCache);
145
146 BVHTree *bvhtree_from_mesh_looptri_ex(
147         struct BVHTreeFromMesh *data,
148         const struct MVert *vert, const bool vert_allocated,
149         const struct MLoop *mloop, const bool loop_allocated,
150         const struct MLoopTri *looptri, const int looptri_num, const bool looptri_allocated,
151         const BLI_bitmap *mask, int looptri_num_active,
152         float epsilon, int tree_type, int axis);
153
154 BVHTree *BKE_bvhtree_from_mesh_get(
155         struct BVHTreeFromMesh *data, struct Mesh *mesh,
156         const int type, const int tree_type);
157
158 /**
159  * Frees data allocated by a call to bvhtree_from_mesh_*.
160  */
161 void free_bvhtree_from_editmesh(struct BVHTreeFromEditMesh *data);
162 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
163
164 /**
165  * Math functions used by callbacks
166  */
167 float bvhtree_ray_tri_intersection(
168         const BVHTreeRay *ray, const float m_dist,
169         const float v0[3], const float v1[3], const float v2[3]);
170 float bvhtree_sphereray_tri_intersection(
171         const BVHTreeRay *ray, float radius, const float m_dist,
172         const float v0[3], const float v1[3], const float v2[3]);
173
174
175 /**
176  * BVHCache
177  */
178
179 /* Using local coordinates */
180 enum {
181         BVHTREE_FROM_VERTS           = 0,
182         BVHTREE_FROM_EDGES           = 1,
183         BVHTREE_FROM_FACES           = 2,
184         BVHTREE_FROM_LOOPTRI         = 3,
185
186         BVHTREE_FROM_LOOSEVERTS      = 4,
187         BVHTREE_FROM_LOOSEEDGES      = 5,
188
189         BVHTREE_FROM_EM_VERTS        = 6,
190         BVHTREE_FROM_EM_EDGES        = 7,
191         BVHTREE_FROM_EM_LOOPTRI      = 8,
192 };
193
194
195 bool     bvhcache_find(const BVHCache *cache, int type, BVHTree **r_tree);
196 bool     bvhcache_has_tree(const BVHCache *cache, const BVHTree *tree);
197 void     bvhcache_insert(BVHCache **cache_p, BVHTree *tree, int type);
198 void     bvhcache_free(BVHCache **cache_p);
199
200
201 #endif