Hans Goudey
1af62cb3bf
**Changes**
As described in T93602, this patch removes all use of the `MVert`
struct, replacing it with a generic named attribute with the name
`"position"`, consistent with other geometry types.
Variable names have been changed from `verts` to `positions`, to align
with the attribute name and the more generic design (positions are not
vertices, they are just an attribute stored on the point domain).
This change is made possible by previous commits that moved all other
data out of `MVert` to runtime data or other generic attributes. What
remains is mostly a simple type change. Though, the type still shows up
859 times, so the patch is quite large.
One compromise is that now `CD_MASK_BAREMESH` now contains
`CD_PROP_FLOAT3`. With the general move towards generic attributes
over custom data types, we are removing use of these type masks anyway.
**Benefits**
The most obvious benefit is reduced memory usage and the benefits
that brings in memory-bound situations. `float3` is only 3 bytes, in
comparison to `MVert` which was 4. When there are millions of vertices
this starts to matter more.
The other benefits come from using a more generic type. Instead of
writing algorithms specifically for `MVert`, code can just use arrays
of vectors. This will allow eliminating many temporary arrays or
wrappers used to extract positions.
Many possible improvements aren't implemented in this patch, though
I did switch simplify or remove the process of creating temporary
position arrays in a few places.
The design clarity that "positions are just another attribute" brings
allows removing explicit copying of vertices in some procedural
operations-- they are just processed like most other attributes.
**Performance**
This touches so many areas that it's hard to benchmark exhaustively,
but I observed some areas as examples.
* The mesh line node with 4 million count was 1.5x (8ms to 12ms) faster.
* The Spring splash screen went from ~4.3 to ~4.5 fps.
* The subdivision surface modifier/node was slightly faster
RNA access through Python may be slightly slower, since now we need
a name lookup instead of just a custom data type lookup for each index.
**Future Improvements**
* Remove uses of "vert_coords" functions:
* `BKE_mesh_vert_coords_alloc`
* `BKE_mesh_vert_coords_get`
* `BKE_mesh_vert_coords_apply{_with_mat4}`
* Remove more hidden copying of positions
* General simplification now possible in many areas
* Convert more code to C++ to use `float3` instead of `float[3]`
* Currently `reinterpret_cast` is used for those C-API functions
Differential Revision: https://developer.blender.org/D15982
271 lines
9.1 KiB
C++
271 lines
9.1 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 struct MLoop *loop;
|
|
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,
|
|
const blender::BitVector<> &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,
|
|
const blender::BitVector<> &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,
|
|
const blender::BitVector<> &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,
|
|
const blender::BitVector<> &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,
|
|
const blender::BitVector<> &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 struct MLoop *mloop,
|
|
const struct MLoopTri *looptri,
|
|
int looptri_num,
|
|
const blender::BitVector<> &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
|