Struct BSPTree

pub struct BSPTree { /* private fields */ }

Defines the tree used for navigation

Implementations

impl BSPTree

pub fn new(faces: impl Iterator<Item = Face>) -> Option<Self>

Constructs a new tree. Returns None if there are not faces, and root construction was not possible

pub fn new_shuffle( faces: impl Iterator<Item = Face>, rng: &mut impl Rng, ) -> Option<Self>

pub fn node(&self, index: NodeIndex) -> Option<&BSPNode>

pub fn root(&self) -> NodeIndex

Returns the root index

pub fn root_node(&self) -> &BSPNode

Returns a reference to the root node

pub fn descendants(&self) -> Descendants<'_>

pub fn locate(&self, point: Vec2) -> NodePayload<'_>

Returns the containing node and if the point is covered

pub fn root_mut(&mut self) -> &mut NodeIndex

Get a mutable reference to the bsptree’s root.

pub fn nodes(&self) -> &SlotMap<NodeIndex, BSPNode>

Get a reference to the bsptree’s nodes.

pub fn clipping_planes(&self) -> [Face; 4]

Returns clipping planes which contain the scene

pub fn generate_portals(&self) -> Vec<ClippedFace>

Trait Implementations

impl Index<NodeIndex> for BSPTree

type Output = BSPNode

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &Self::Output

Performs the indexing (container[index]) operation.