Struct ami::Octree

pub struct Octree<T: Pos> { /* fields omitted */ }

An octree is a DAG that can quickly search for points in 3D space.

The bounding box of the root node contains all points in the octree. If a point outside the bounding box is added, a new root node is created which contains the old root as one of its octants. This process is repeated until the point is contained.

The nodes are stored in a vector, and are indexed using a 32-bit node ID. This saves memory over using pointers on 64-bit systems. Node ID 1 is the first node in the vector.

Methods

impl<T> Octree<T> where
    T: Pos, 

fn new() -> Octree<T>

Create a new octree

fn add(&mut self, point: T) -> u32

Add a point in the octree

fn remove(&mut self, hnd: u32)

Remove a point from the octree

fn modify(&mut self, hnd: &mut u32, p: T)

Modify a point in the octree.

fn nearest(&mut self, sorted: &mut Vec<u32>, frustum: Frustum)

Sort the octree nearest to farthest, while culling all outside of view frustum.

fn farthest(&mut self, sorted: &mut Vec<u32>, frustum: Frustum)

Sort the octree farthest to nearest, while culling all outside of view frustum.

fn print(&self)

Print the octree

fn len(&self) -> usize

Get the number of points in the octree.

fn check_corrupt(&self)

Abort program on error if the octree is corrupt!

Trait Implementations

impl<T> Index<u32> for Octree<T> where
    T: Pos, 

type Output = T

The returned type after indexing.

fn index<'a>(&'a self, index: u32) -> &'a T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<u32> for Octree<T> where
    T: Pos, 

fn index_mut<'a>(&'a mut self, index: u32) -> &'a mut T

Performs the mutable indexing (container[index]) operation.

impl<T> Debug for Octree<T> where
    T: Pos, 

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

Formats the value using the given formatter.