Enum bvh::bvh::BVHNode

pub enum BVHNode {
    Leaf {
        parent_index: usize,
        depth: u32,
        shape_index: usize,
    },
    Node {
        parent_index: usize,
        depth: u32,
        child_l_index: usize,
        child_l_aabb: AABB,
        child_r_index: usize,
        child_r_aabb: AABB,
    },
}

The BVHNode enum that describes a node in a BVH. It’s either a leaf node and references a shape (by holding its index) or a regular node that has two child nodes. The non-leaf node stores the AABBs of its children.

Variants

Leaf

Leaf node.

Fields of Leaf

parent_index: usize

The node’s parent.

depth: u32

The node’s depth.

shape_index: usize

The shape contained in this leaf.

Node

Inner node.

Fields of Node

parent_index: usize

The node’s parent.

depth: u32

The node’s depth.

child_l_index: usize

Index of the left subtree’s root node.

child_l_aabb: AABB

The convex hull of the shapes’ AABBs in child_l.

child_r_index: usize

Index of the right subtree’s root node.

child_r_aabb: AABB

The convex hull of the shapes’ AABBs in child_r.

Implementations

impl BVHNode

pub fn parent(&self) -> usize

Returns the index of the parent node.

pub fn parent_mut(&mut self) -> &mut usize

Returns a mutable reference to the parent node index.

pub fn child_l(&self) -> usize

Returns the index of the left child node.

pub fn child_l_aabb(&self) -> AABB

Returns the AABB of the right child node.

pub fn child_l_aabb_mut(&mut self) -> &mut AABB

Returns a mutable reference to the AABB of the left child node.

pub fn child_r(&self) -> usize

Returns the index of the right child node.

pub fn child_r_aabb(&self) -> AABB

Returns the AABB of the right child node.

pub fn child_r_aabb_mut(&mut self) -> &mut AABB

Returns a mutable reference to the AABB of the right child node.

pub fn depth(&self) -> u32

Returns the depth of the node. The root node has depth 0.

pub fn get_node_aabb<Shape: BHShape>(&self, shapes: &[Shape]) -> AABB

Gets the AABB for a BVHNode. Returns the shape’s AABB for leaves, and the joined AABB of the two children’s AABBs for non-leaves.

pub fn shape_index(&self) -> Option<usize>

Returns the index of the shape contained within the node if is a leaf, or None if it is an interior node.

pub fn build<T: BHShape>(
    shapes: &mut [T],
    indices: &[usize],
    nodes: &mut Vec<BVHNode>,
    parent_index: usize,
    depth: u32
) -> usize

Builds a BVHNode recursively using SAH partitioning. Returns the index of the new node in the nodes vector.

pub fn traverse_recursive(
    nodes: &[BVHNode],
    node_index: usize,
    ray: &Ray,
    indices: &mut Vec<usize>
)

Traverses the BVH recursively and returns all shapes whose AABB is intersected by the given Ray.

impl BVHNode

pub fn flatten_custom<F, FNodeType>(
    &self,
    nodes: &[BVHNode],
    vec: &mut Vec<FNodeType>,
    next_free: usize,
    constructor: &F
) -> usize where
    F: Fn(&AABB, u32, u32, u32) -> FNodeType, 

Flattens the BVH, so that it can be traversed in an iterative manner. This method constructs custom flat nodes using the constructor.

Trait Implementations

impl Clone for BVHNode

fn clone(&self) -> BVHNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BVHNode

impl Debug for BVHNode

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

Formats the value using the given formatter.

impl PartialEq<BVHNode> for BVHNode

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.