Struct Bvh 

pub struct Bvh { /* private fields */ }

A bounding-volume hierarchy over a mesh’s triangles.

Built with a surface-area heuristic over binned centroids. Holds its own copy of the triangles’ corners, so the mesh it was built from may be dropped or changed; queries answer about the mesh as it was.

Implementations

impl Bvh

pub fn build(mesh: &Triangulation) -> OgeomResult<Self>

Build the hierarchy over a mesh’s triangles.

Degenerate triangles are kept: a nearest query can still land on one, and a ray through one finds it only where it is a proper triangle as the ray sees it.

Errors

OgeomError::Range if a triangle names a vertex the mesh does not have, and OgeomError::Numeric if a triangle’s corner is not finite.

pub fn of_shape( model: &Model, shape: &Shape, deflection: Deflection, tol: Tolerances, ) -> OgeomResult<Self>

Build the hierarchy over a shape’s triangulation at a deflection.

The triangle indices are those of triangulate for the same arguments, which is deterministic, and Bvh::triangle gives each triangle’s corners without it.

Errors

As triangulate and Bvh::build.

pub fn triangle_count(&self) -> usize

How many triangles the hierarchy holds.

pub fn is_empty(&self) -> bool

Whether the hierarchy holds no triangle.

pub fn triangle(&self, triangle: u32) -> Option<[Point; 3]>

A triangle’s three corners, or None past the last triangle.

pub fn bounds(&self) -> Aabb

The bounds of every triangle.

pub fn nearest(&self, p: Point, max: f64) -> Option<Hit>

The point on the mesh nearest p, no farther than max; the lowest triangle index among equally near ones. max may be infinite.

pub fn nearest_many(&self, points: &[Point], max: f64) -> Vec<Option<Hit>>

Bvh::nearest for each point, in parallel, answers in point order.

pub fn nearest_where( &self, p: Point, max: f64, keep: impl Fn(u32) -> bool, ) -> Option<Hit>

Bvh::nearest among the triangles keep accepts: the point on them nearest p, no farther than max, the lowest triangle index among equally near ones. The answer is brute force’s over the kept triangles alone, however the tree holds the others.

pub fn nearest_many_where( &self, points: &[Point], max: f64, keep: impl Fn(usize, u32) -> bool + Sync, ) -> Vec<Option<Hit>>

Bvh::nearest_where for each point, in parallel, answers in point order. keep is asked with the point’s index and a triangle.

pub fn within_ball(&self, centre: Point, radius: f64) -> Vec<u32>

Every triangle with a point within radius of centre, in index order.

pub fn triangles_where(&self, test: impl Fn(&Aabb) -> bool) -> Vec<u32>

Every triangle whose bounding box passes test, in index order.

test prunes the walk: a node’s box that fails it is not entered, so test must pass every box that contains a box it passes (a region overlap does, a containment test does not).

pub fn ray( &self, origin: Point, direction: Vector, max: f64, both_sides: bool, ) -> Option<Hit>

The first triangle along a ray, no farther than max along it, and the lowest triangle index among equally far ones.

direction need not be unit length; Hit::distance is measured along it in model units. A triangle faces the ray when the ray meets the side its counter-clockwise winding points out of; with both_sides false only those count. A hit at the origin itself counts, at distance zero. A ray in a triangle’s plane does not hit it, having no area to cross there; in a closed mesh the triangles across the edges it passes through are hit instead.

pub fn rays( &self, origins: &[Point], directions: &[Vector], max: f64, both_sides: bool, ) -> OgeomResult<Vec<Option<Hit>>>

Bvh::ray for each origin and direction, in parallel, answers in input order.

Errors

OgeomError::Dimension if there are not as many directions as origins.

pub fn hits_along( &self, origin: Point, direction: Vector, max: f64, both_sides: bool, ) -> Vec<Hit>

Every triangle along a ray within max, nearest first, ties in index order. Each is the hit Bvh::ray reports when it is first.

Trait Implementations

impl Clone for Bvh

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bvh

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

Formats the value using the given formatter.