Struct BrainMesh 

pub struct BrainMesh {
    pub vertices: Vec<f32>,
    pub faces: Vec<i32>,
}

A brain mesh, or any other triangular mesh. Vertices are stored as a vector of x,y,z coordinates, where triplets of coordinates represent a vertex. The triangular faces are stored in the same way as a vector of vertex indices.

Fields

vertices: Vec<f32>

faces: Vec<i32>

Implementations

impl BrainMesh

pub fn to_obj(&self) -> String

Export a brain mesh to a Wavefront Object (OBJ) format string.

Examples

let surf = neuroformats::read_surf("/path/to/subjects_dir/subject1/surf/lh.white").unwrap();
let obj_repr = surf.mesh.to_obj();
std::fs::write("/tmp/lhwhite.obj", obj_repr).expect("Unable to write OBJ mesh file");

pub fn to_ply(&self, vertex_colors: Option<&[u8]>) -> String

Export a brain mesh to PLY (Polygon File Format) format string.

Arguments

• vertex_colors - Optional vertex colors as RGB values in [r,g,b, r,g,b, …] format. Must be exactly 3 times the number of vertices if provided.

Examples

let surf = neuroformats::read_surf("/path/to/subject/surf/lh.white").unwrap();
let colors = vec![255; surf.mesh.vertices.len()]; // White colors for all vertices
let ply_repr = surf.mesh.to_ply(Some(&colors));
std::fs::write("/tmp/lhwhite.ply", ply_repr).expect("Unable to write PLY mesh file");

pub fn to_gltf(&self, vertex_colors: Option<&[u8]>) -> String

pub fn num_vertices(&self) -> usize

Get the number of vertices for this mesh.

pub fn num_faces(&self) -> usize

Get the number of faces (or polygons) for this mesh.

pub fn from_obj_file<P: AsRef<Path>>(path: P) -> Result<BrainMesh>

Read a brain mesh from a Wavefront object format (.obj) mesh file.

Examples

let mesh = neuroformats::BrainMesh::from_obj_file("resources/mesh/cube.obj").unwrap();
assert_eq!(24, mesh.vertices.len());

pub fn axes_min_max_coords(&self) -> Result<(f32, f32, f32, f32, f32, f32)>

Compute the min and max coordinates for the x, y, and z axes of the mesh.

Panics

If the min and max coordinates for the axes cannot be computed. E.g., when the mesh contains no vertices or invalid vertex coordinates like NAN values.

Return value

The 6 values in the returned tuple are, in the following order: (min_x, max_x, min_y, max_y, min_z, max_z).

pub fn center(&self) -> Result<(f32, f32, f32)>

Compute the center of the mesh.

The center is simply the mean of the min and max values for the x, y and z axes. So this is NOT the center of mass.

Panics

If the mean of the min and max coordinates cannot be computed. E.g., when the mesh contains no vertices or invalid vertex coordinates like NAN values.

Return value

The 3 values in the returned tuple are the x, y and z coordinates of the center, in that order.

pub fn merge(&self, other: &BrainMesh) -> BrainMesh

Merge two meshes into one.

Creates a new mesh that contains all vertices and faces from both meshes. Does not modify the original meshes.

Arguments

• other - The other mesh to merge with.

Returns

A new BrainMesh instance containing the merged data.

pub fn move_to(&mut self, offset: (f32, f32, f32))

Move the mesh to a new location by adding the given offset to each vertex.

Arguments

• offset - A tuple containing the x, y, and z offsets to apply to each vertex.

Returns

Nothing, changes the mesh in place.

Examples

// This example uses the center() function to move the mesh to the origin.
let mut mesh = neuroformats::BrainMesh::from_obj_file("resources/mesh/cube.obj").unwrap();
let (cx, cy, cz) = mesh.center().unwrap();
mesh.move_to((cx, cy, cz));

Trait Implementations

impl Clone for BrainMesh

fn clone(&self) -> BrainMesh

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BrainMesh

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BrainMesh

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BrainMesh

fn eq(&self, other: &BrainMesh) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BrainMesh