Enum arctk::geom::dom::tree::Tree

pub enum Tree<'a, T> {
    Branch {
        boundary: Cube,
        children: Box<[Tree<'a, T>; 8]>,
    },
    Leaf {
        boundary: Cube,
        tris: Vec<(&'a SmoothTriangle, &'a T)>,
    },
}

Tree cell enumeration.

Variants

Branch

Branching cell.

Fields of Branch

boundary: Cube

Boundary.

children: Box<[Tree<'a, T>; 8]>

Children.

Leaf

Terminal populated cell.

Fields of Leaf

boundary: Cube

Boundary.

tris: Vec<(&'a SmoothTriangle, &'a T)>

Intersecting triangles and their corresponding mesh index.

Implementations

impl<'a, T> Tree<'a, T>

#[must_use]pub fn new(sett: &TreeSettings, surfs: &'a Set<Surface<'_, T>>) -> Self

Construct a new instance.

#[must_use]pub fn boundary(&self) -> &Cube

Reference the cell's boundary.

#[must_use]pub fn num_cells(&self) -> usize

Determine the total number of cells used by this cell. This cell is included in the count.

#[must_use]pub fn num_leaves(&self) -> usize

Determine the number leaf of cells contained used by this cell. This cell is potentially included in the count.

#[must_use]pub fn num_tris(&self) -> usize

Determine the number of triangle collision references used by this cell.

#[must_use]pub fn depth(&self) -> usize

Determine the maximum depth from this cell to a terminal cell.

#[must_use]pub fn try_find_leaf(&self, pos: &Pos3) -> Option<&Self>

If a given position is contained within the cell to being with, determine the terminal leaf cell containing the given position.

#[must_use]pub fn find_leaf(&self, pos: &Pos3) -> &Self

Determine the terminal leaf cell containing the given position.

#[must_use]pub fn scan(
    &self,
    ray: Ray,
    bump_dist: f64,
    max_dist: f64
) -> Option<Hit<'_, T>>

Determine what a given Ray would observe. The maximum distance provided does not guarantee that any hit retrieved is less than the given distance.