Crate mesh_to_sdf

Source
Expand description

⚠️ This crate is still in its early stages. Expect the API to change.

This crate provides two entry points:

  • generate_sdf: computes the signed distance field for the mesh defined by vertices and indices at the points query_points.
  • generate_grid_sdf: computes the signed distance field for the mesh defined by vertices and indices on a Grid.
use mesh_to_sdf::{generate_sdf, generate_grid_sdf, SignMethod, AccelerationMethod, Topology, Grid};
// vertices are [f32; 3], but can be cgmath::Vector3<f32>, glam::Vec3, etc.
let vertices: Vec<[f32; 3]> = vec![[0.5, 1.5, 0.5], [1., 2., 3.], [1., 3., 7.]];
let indices: Vec<u32> = vec![0, 1, 2];

// query points must be of the same type as vertices
let query_points: Vec<[f32; 3]> = vec![[0.5, 0.5, 0.5]];

// Query points are expected to be in the same space as the mesh.
let sdf: Vec<f32> = generate_sdf(
    &vertices,
    Topology::TriangleList(Some(&indices)), // TriangleList as opposed to TriangleStrip
    &query_points,
    AccelerationMethod::RtreeBvh, // Use an r-tree and a bvh to accelerate queries.
);

for point in query_points.iter().zip(sdf.iter()) {
    // distance is positive outside the mesh and negative inside.
    println!("Distance to {:?}: {}", point.0, point.1);
}

// if you can, use generate_grid_sdf instead of generate_sdf as it's optimized and much faster.
let bounding_box_min = [0., 0., 0.];
let bounding_box_max = [10., 10., 10.];
let cell_count = [10, 10, 10];

let grid = Grid::from_bounding_box(&bounding_box_min, &bounding_box_max, cell_count);

let sdf: Vec<f32> = generate_grid_sdf(
    &vertices,
    Topology::TriangleList(Some(&indices)),
    &grid,
    SignMethod::Raycast, // How the sign is computed.
                         // Raycast is robust but requires the mesh to be watertight.
                         // and is more expensive.
                         // Normal might leak negative distances outside the mesh
);                       // but works for all meshes, even surfaces.

for x in 0..cell_count[0] {
    for y in 0..cell_count[1] {
        for z in 0..cell_count[2] {
            let index = grid.get_cell_idx(&[x, y, z]);
            log::info!("Distance to cell [{}, {}, {}]: {}", x, y, z, sdf[index as usize]);
        }
    }
}
§Mesh Topology

Indices can be of any type that implements Into<u32>, e.g. u16 and u32. Topology can be list or strip. If the indices are not provided, they are supposed to be 0..vertices.len().

For vertices, this library aims to be as generic as possible by providing a trait Point that can be implemented for any type. Implementations for most common math libraries are gated behind feature flags. By default, [f32; 3] and nalgebra::[Point3, Vector3] are provided. If you do not find your favorite library, feel free to implement the trait for it and submit a PR or open an issue.

§Computing sign

This crate provides two methods to compute the sign of the distance:

  • SignMethod::Raycast (default): a robust method to compute the sign of the distance. It counts the number of intersections between a ray starting from the query point and the triangles of the mesh. It only works for watertight meshes, but guarantees the sign is correct.
  • SignMethod::Normal: uses the normals of the triangles to estimate the sign by doing a dot product with the direction of the query point. It works for non-watertight meshes but might leak negative distances outside the mesh.

Using Raycast is slower than Normal but gives better results. Performances depends on the triangle count and method used. On big dataset, Raycast is 5-10% slower for grid generation and rtree based methods. On smaller dataset, the difference can be worse depending on whether the query is triangle intensive or query point intensive. For bvh the difference is negligible between the two methods.

§Acceleration structures

For generic queries, you can use acceleration structures to speed up the computation.

If your mesh is watertight and you have more than a thousand queries/triangles, you should use AccelerationMethod::RtreeBvh for best performances. If it’s not watertight, you can use AccelerationMethod::Rtree instead.

Rtree methods are 3-4x faster than Bvh methods for big enough data. On small meshes, the difference is negligible. AccelerationMethod::None scales really poorly and should be avoided unless for small datasets or if you’re really tight on memory.

§Using your favorite library

To use your favorite math library with mesh_to_sdf, you need to add it to mesh_to_sdf dependency. For example, to use glam:

[dependencies]
mesh_to_sdf = { version = "0.2.1", features = ["glam"] }

Currently, the following libraries are supported:

nalgebra is always available as it’s used internally in the bvh tree.

§Serialization

If you want to serialize and deserialize signed distance fields, you need to enable the serde feature. This features also provides helpers to save and load signed distance fields to and from files via save_to_file and read_from_file.

Modules§

serde
Serialization and deserialization of signed distance fields.

Structs§

Grid
Helper struct to represent a grid for grid sdf. A grid is defined by three parameters:

Enums§

AccelerationMethod
Acceleration structure to speed up the computation.
SignMethod
Method to compute the sign of the distance.
SnapResult
Result of snapping a point to the grid. If the point is inside the grid, the cell it is within is returned. If the point is outside the grid, the cell index is the nearest cell.
Topology
Mesh Topology: how indices are stored.

Traits§

Point
Point is the trait that represents a point in 3D space. It is an abstraction over the type of point used in the client math library.

Functions§

generate_grid_sdf
Generate a signed distance field from a mesh for a grid. See Grid for more details on how to create and use a grid.
generate_sdf
Generate a signed distance field from a mesh. Query points are expected to be in the same space as the mesh.