rs-read-trimesh

rs-read-trimesh is a Rust library for loading 3D triangular meshes from files in various 3D formats. The main motivation behind this library is that existing readers do not directly output the format we work with (Parry's TriMesh) and require additional boilerplate code, which would be better implemented as a separate dependency.)

Features

The library provides a single function that reads a file into a TriMesh given its file path. It supports .ply, .stl, and .obj formats, with built-in robustness to handle the diverse data structures found in .ply files, which may use different data types.

Installation

To use this library, add the following to your Cargo.toml:

[dependencies]
rs-read-trimesh = "0.1.0"

Usage

Here’s an example using the load_trimesh function to load a 3D model and apply a scaling factor:

use rs_read_trimesh::load_trimesh;

fn main() {
    let file_path = "example.ply"; 
    let scale = 0.001; // Suppose the mesh is in mm; we want it in meters.

    match load_trimesh(file_path, scale) {
        Ok(mesh) => {
            println!("Successfully loaded and scaled mesh with {} vertices.", mesh.vertices.len());
        }
        Err(e) => {
            eprintln!("Error loading mesh: {}", e);
        }
    }
}

Scaling

The scale parameter allows you to scale all the vertices of the mesh. Setting scale = 1.0 will result in no scaling. Scaling ply files seems quite a frequent case as they are unit-agnostic.

Dependencies

The following crates are used to power the functionality of this library:

• nalgebra: A linear algebra library for vector and matrix operations.
• ply-rs-bw: A library for reading and writing PLY files.
• stl_io: A library for reading and writing STL files.
• tobj: A library for loading OBJ files.
• parry3d: Provides 3D geometry processing for physical simulations.

Parry is only used as much here as its mesh data structure is involved.

You do not need to add these dependencies manually to your Cargo.toml. They are automatically resolved by Cargo when you include rs-read-trimesh or any of the mentioned libraries.

License

This project is licensed under the MIT License. See the LICENSE file for details.