Struct MeshSurface

pub struct MeshSurface { /* private fields */ }

A distribution for sampling points uniformly on the surface of a 3d model

Samples the surface of a model by first randomly picking a triangle with probability proportional to its area, and then uniformly samples a point within that triangle.

Example

use mesh_rand::MeshSurface;
use rand::distributions::Distribution;

let verticies = [
    [1.0, 0.0, 0.0],
    [0.0, 1.0, 0.0],
    [0.0, 0.0, 1.0],
    [1.0, 2.0, 0.0],
];
let faces = [[0, 1, 2], [0, 1, 3]];
let mesh_dist = MeshSurface::new(&verticies, &faces)?;
let mut rng = rand::thread_rng();
let sample = mesh_dist.sample(&mut rng);
println!(
    "generated point on mesh at {:?} located on face with index {:?} with normal {:?}",
    sample.position, sample.face_index, sample.normal
);

Implementations

impl MeshSurface

pub fn new(verts: &[[f32; 3]], faces: &[[usize; 3]]) -> Result<Self, MError>

Initializes a new mesh surface distribution given verticies and faces (triangles)

Result

Returns an error if:

• An index defining a face is out of range of the verticies collection
• The area of one of the triangles provided is very close to 0 (f32::is_normal(area) == false)
• The collection of faces is empty

Trait Implementations

impl Clone for MeshSurface

fn clone(&self) -> MeshSurface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeshSurface

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

Formats the value using the given formatter.

impl Distribution<SurfSample> for MeshSurface

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> SurfSample

Samples the model surface uniformly, returning an instance of the SurfSample struct

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F