Struct ami::Octree

pub struct Octree<T: Collider> { /* private fields */ }

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.

Implementations

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

pub fn new() -> Octree<T>

Create a new octree

pub fn clear(&mut self)

Clear the octree.

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

Add a point in the octree

pub fn remove(&mut self, id: Id) -> T

Remove a point from the octree

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Display for Octree<T> where
    T: Collider, 

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

Formats the value using the given formatter.

impl<T> Index<Id> for Octree<T> where
    T: Collider, 

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Id> for Octree<T> where
    T: Collider, 

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

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