Struct bsp_pathfinding::NavigationContext

pub struct NavigationContext { /* private fields */ }

Contains the graph and edges necessary for path finding

Implementations

impl NavigationContext

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

Creates a new navigation context

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

Creates a new navigation context. Shuffles the input which usually reduces the depth of the final tree.

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

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

Locate a position in the tree. Return None if there are no faces in the scene

pub fn tree(&self) -> Option<&BSPTree>

Get a reference to the navigation context’s tree.

pub fn portals(&self) -> &Portals

Get a reference to the navigation context’s portals.

pub fn get(&self, index: NodeIndex) -> PortalIter<'_>

Get the portals associated to a node

pub fn find_path(
    &self,
    start: Vec2,
    end: Vec2,
    heuristic: impl Fn(Vec2, Vec2) -> f32,
    info: SearchInfo
) -> Option<Path>

Find a path from start to end Returns None if no path was found. If there are no faces in the scene, a straight path will be returned.

pub fn find_path_inc<'a>(
    &self,
    start: Vec2,
    end: Vec2,
    heuristic: impl Fn(Vec2, Vec2) -> f32,
    info: SearchInfo,
    path: &'a mut Option<Path>
) -> Option<&'a mut Path>

Find a path from start to end Returns None if no path was found. If there are no faces in the scene, a straight path will be returned. Uses an already allocated path to fill and will attempt to only update parts of the path

Trait Implementations

impl Default for NavigationContext

fn default() -> NavigationContext

Returns the “default value” for a type.