Hans Goudey
16fbadde36
Implements #102359. Split the `MLoop` struct into two separate integer arrays called `corner_verts` and `corner_edges`, referring to the vertex each corner is attached to and the next edge around the face at each corner. These arrays can be sliced to give access to the edges or vertices in a face. Then they are often referred to as "poly_verts" or "poly_edges". The main benefits are halving the necessary memory bandwidth when only one array is used and simplifications from using regular integer indices instead of a special-purpose struct. The commit also starts a renaming from "loop" to "corner" in mesh code. Like the other mesh struct of array refactors, forward compatibility is kept by writing files with the older format. This will be done until 4.0 to ease the transition process. Looking at a small portion of the patch should give a good impression for the rest of the changes. I tried to make the changes as small as possible so it's easy to tell the correctness from the diff. Though I found Blender developers have been very inventive over the last decade when finding different ways to loop over the corners in a face. For performance, nearly every piece of code that deals with `Mesh` is slightly impacted. Any algorithm that is memory bottle-necked should see an improvement. For example, here is a comparison of interpolating a vertex float attribute to face corners (Ryzen 3700x): **Before** (Average: 3.7 ms, Min: 3.4 ms) ``` threading::parallel_for(loops.index_range(), 4096, [&](IndexRange range) { for (const int64_t i : range) { dst[i] = src[loops[i].v]; } }); ``` **After** (Average: 2.9 ms, Min: 2.6 ms) ``` array_utils::gather(src, corner_verts, dst); ``` That's an improvement of 28% to the average timings, and it's also a simplification, since an index-based routine can be used instead. For more examples using the new arrays, see the design task. Pull Request: blender/blender#104424
271 lines
9.0 KiB
C++
271 lines
9.0 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2006 NaN Holding BV. All rights reserved. */
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#include "BLI_kdopbvh.h"
|
|
#include "BLI_threads.h"
|
|
|
|
#ifdef __cplusplus
|
|
# include <mutex>
|
|
|
|
# include "BLI_bit_vector.hh"
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* This header encapsulates necessary code to build a BVH
|
|
*/
|
|
|
|
struct BMEditMesh;
|
|
struct MFace;
|
|
struct Mesh;
|
|
struct PointCloud;
|
|
|
|
struct BVHCache;
|
|
|
|
/**
|
|
* Struct that stores basic information about a BVHTree built from a edit-mesh.
|
|
*/
|
|
typedef struct BVHTreeFromEditMesh {
|
|
struct BVHTree *tree;
|
|
|
|
/** Default callbacks to BVH nearest and ray-cast. */
|
|
BVHTree_NearestPointCallback nearest_callback;
|
|
BVHTree_RayCastCallback raycast_callback;
|
|
|
|
struct BMEditMesh *em;
|
|
|
|
/* Private data */
|
|
bool cached;
|
|
|
|
} BVHTreeFromEditMesh;
|
|
|
|
/**
|
|
* Struct that stores basic information about a #BVHTree built from a mesh.
|
|
*/
|
|
typedef struct BVHTreeFromMesh {
|
|
struct BVHTree *tree;
|
|
|
|
/** Default callbacks to BVH nearest and ray-cast. */
|
|
BVHTree_NearestPointCallback nearest_callback;
|
|
BVHTree_RayCastCallback raycast_callback;
|
|
|
|
/* Vertex array, so that callbacks have instant access to data. */
|
|
const float (*vert_positions)[3];
|
|
const struct MEdge *edge;
|
|
const struct MFace *face;
|
|
const int *corner_verts;
|
|
const struct MLoopTri *looptri;
|
|
|
|
/* Private data */
|
|
bool cached;
|
|
|
|
} BVHTreeFromMesh;
|
|
|
|
typedef enum BVHCacheType {
|
|
BVHTREE_FROM_VERTS,
|
|
BVHTREE_FROM_EDGES,
|
|
BVHTREE_FROM_FACES,
|
|
BVHTREE_FROM_LOOPTRI,
|
|
BVHTREE_FROM_LOOPTRI_NO_HIDDEN,
|
|
|
|
BVHTREE_FROM_LOOSEVERTS,
|
|
BVHTREE_FROM_LOOSEEDGES,
|
|
|
|
BVHTREE_FROM_EM_VERTS,
|
|
BVHTREE_FROM_EM_EDGES,
|
|
BVHTREE_FROM_EM_LOOPTRI,
|
|
|
|
/* Keep `BVHTREE_MAX_ITEM` as last item. */
|
|
BVHTREE_MAX_ITEM,
|
|
} BVHCacheType;
|
|
|
|
/**
|
|
* Builds a BVH tree where nodes are the relevant elements of the given mesh.
|
|
* Configures #BVHTreeFromMesh.
|
|
*
|
|
* The tree is build in mesh space coordinates, this means special care must be made on queries
|
|
* so that the coordinates and rays are first translated on the mesh local coordinates.
|
|
* Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it
|
|
* becomes possible to reuse a #BVHTree.
|
|
*
|
|
* #free_bvhtree_from_mesh should be called when the tree is no longer needed.
|
|
*/
|
|
BVHTree *bvhtree_from_editmesh_verts(
|
|
BVHTreeFromEditMesh *data, struct BMEditMesh *em, float epsilon, int tree_type, int axis);
|
|
|
|
#ifdef __cplusplus
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the vertices of the given `em`.
|
|
*/
|
|
BVHTree *bvhtree_from_editmesh_verts_ex(BVHTreeFromEditMesh *data,
|
|
struct BMEditMesh *em,
|
|
blender::BitSpan mask,
|
|
int verts_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the given vertices (NOTE: does not copy given `vert`!).
|
|
* \param vert_allocated: if true, vert freeing will be done when freeing data.
|
|
* \param verts_mask: if not null, true elements give which vert to add to BVH-tree.
|
|
* \param verts_num_active: if >= 0, number of active verts to add to BVH-tree
|
|
* (else will be computed from mask).
|
|
*/
|
|
BVHTree *bvhtree_from_mesh_verts_ex(struct BVHTreeFromMesh *data,
|
|
const float (*vert_positions)[3],
|
|
int verts_num,
|
|
blender::BitSpan verts_mask,
|
|
int verts_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
BVHTree *bvhtree_from_editmesh_edges(
|
|
BVHTreeFromEditMesh *data, struct BMEditMesh *em, float epsilon, int tree_type, int axis);
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the edges of the given `em`.
|
|
*/
|
|
BVHTree *bvhtree_from_editmesh_edges_ex(BVHTreeFromEditMesh *data,
|
|
struct BMEditMesh *em,
|
|
blender::BitSpan edges_mask,
|
|
int edges_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the given edges.
|
|
* \param vert, vert_allocated: if true, elem freeing will be done when freeing data.
|
|
* \param edge, edge_allocated: if true, elem freeing will be done when freeing data.
|
|
* \param edges_mask: if not null, true elements give which vert to add to BVH-tree.
|
|
* \param edges_num_active: if >= 0, number of active edges to add to BVH-tree
|
|
* (else will be computed from mask).
|
|
*/
|
|
BVHTree *bvhtree_from_mesh_edges_ex(struct BVHTreeFromMesh *data,
|
|
const float (*vert_positions)[3],
|
|
const struct MEdge *edge,
|
|
int edges_num,
|
|
blender::BitSpan edges_mask,
|
|
int edges_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
BVHTree *bvhtree_from_editmesh_looptri(
|
|
BVHTreeFromEditMesh *data, struct BMEditMesh *em, float epsilon, int tree_type, int axis);
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the `looptri` faces of the given `bm`.
|
|
*/
|
|
BVHTree *bvhtree_from_editmesh_looptri_ex(BVHTreeFromEditMesh *data,
|
|
struct BMEditMesh *em,
|
|
blender::BitSpan mask,
|
|
int looptri_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
/**
|
|
* Builds a BVH-tree where nodes are the looptri faces of the given mesh.
|
|
*/
|
|
BVHTree *bvhtree_from_mesh_looptri_ex(struct BVHTreeFromMesh *data,
|
|
const float (*vert_positions)[3],
|
|
const int *corner_verts,
|
|
const struct MLoopTri *looptri,
|
|
int looptri_num,
|
|
blender::BitSpan mask,
|
|
int looptri_num_active,
|
|
float epsilon,
|
|
int tree_type,
|
|
int axis);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Builds or queries a BVH-cache for the cache BVH-tree of the request type.
|
|
*
|
|
* \note This function only fills a cache, and therefore the mesh argument can
|
|
* be considered logically const. Concurrent access is protected by a mutex.
|
|
*/
|
|
BVHTree *BKE_bvhtree_from_mesh_get(struct BVHTreeFromMesh *data,
|
|
const struct Mesh *mesh,
|
|
BVHCacheType bvh_cache_type,
|
|
int tree_type);
|
|
|
|
#ifdef __cplusplus
|
|
|
|
/**
|
|
* Builds or queries a BVH-cache for the cache BVH-tree of the request type.
|
|
*/
|
|
BVHTree *BKE_bvhtree_from_editmesh_get(BVHTreeFromEditMesh *data,
|
|
struct BMEditMesh *em,
|
|
int tree_type,
|
|
BVHCacheType bvh_cache_type,
|
|
struct BVHCache **bvh_cache_p,
|
|
std::mutex *mesh_eval_mutex);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Frees data allocated by a call to `bvhtree_from_editmesh_*`.
|
|
*/
|
|
void free_bvhtree_from_editmesh(struct BVHTreeFromEditMesh *data);
|
|
/**
|
|
* Frees data allocated by a call to `bvhtree_from_mesh_*`.
|
|
*/
|
|
void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
|
|
|
|
/**
|
|
* Math functions used by callbacks
|
|
*/
|
|
float bvhtree_ray_tri_intersection(
|
|
const BVHTreeRay *ray, float m_dist, const float v0[3], const float v1[3], const float v2[3]);
|
|
float bvhtree_sphereray_tri_intersection(const BVHTreeRay *ray,
|
|
float radius,
|
|
float m_dist,
|
|
const float v0[3],
|
|
const float v1[3],
|
|
const float v2[3]);
|
|
|
|
typedef struct BVHTreeFromPointCloud {
|
|
struct BVHTree *tree;
|
|
|
|
BVHTree_NearestPointCallback nearest_callback;
|
|
|
|
const float (*coords)[3];
|
|
} BVHTreeFromPointCloud;
|
|
|
|
BVHTree *BKE_bvhtree_from_pointcloud_get(struct BVHTreeFromPointCloud *data,
|
|
const struct PointCloud *pointcloud,
|
|
int tree_type);
|
|
|
|
void free_bvhtree_from_pointcloud(struct BVHTreeFromPointCloud *data);
|
|
|
|
/**
|
|
* BVHCache
|
|
*/
|
|
|
|
/* Using local coordinates */
|
|
|
|
bool bvhcache_has_tree(const struct BVHCache *bvh_cache, const BVHTree *tree);
|
|
struct BVHCache *bvhcache_init(void);
|
|
/**
|
|
* Frees a BVH-cache.
|
|
*/
|
|
void bvhcache_free(struct BVHCache *bvh_cache);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|