Struct static_aabb2d_index::StaticAABB2DIndexBuilder

pub struct StaticAABB2DIndexBuilder<T = f64> where
    T: IndexableNum,  { /* fields omitted */ }

Used to build a StaticAABB2DIndex.

Implementations

impl<T> StaticAABB2DIndexBuilder<T> where
    T: IndexableNum, 

pub fn new(count: usize) -> Self

Construct a new StaticAABB2DIndexBuilder to fit exactly the specified count number of items.

pub fn new_with_node_size(count: usize, node_size: usize) -> Self

Construct a new StaticAABB2DIndexBuilder to fit exactly the specified count number of items and use node_size for the index tree shape.

Each node in the index tree has a maximum size which may be adjusted by node_size for performance reasons, however the default value of 16 when calling StaticAABB2DIndexBuilder::new is tested to be optimal in most cases.

If node_size is less than 2 then 2 is used, if node_size is greater than 65535 then 65535 is used.

pub fn add(&mut self, min_x: T, min_y: T, max_x: T, max_y: T) -> &mut Self

Add an axis aligned bounding box with the extent points (min_x, min_y), (max_x, max_y) to the index.

For performance reasons the sanity checks of min_x <= max_x and min_y <= max_y are only debug asserted. If an invalid box is added it may lead to a panic or unexpected behavior from the constructed StaticAABB2DIndex.

pub fn build(self) -> Result<StaticAABB2DIndex<T>, StaticAABB2DIndexBuildError>

Build the StaticAABB2DIndex with the boxes that have been added.

If the number of added items does not match the count given at the time the builder was created then a StaticAABB2DIndexBuildError::ItemCountError will be returned.

If the numeric type T fails to cast to/from a u16 for any reason then a StaticAABB2DIndexBuildError::NumericCastError will be returned.

Trait Implementations

impl<T: Clone> Clone for StaticAABB2DIndexBuilder<T> where
    T: IndexableNum, 

fn clone(&self) -> StaticAABB2DIndexBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StaticAABB2DIndexBuilder<T> where
    T: IndexableNum, 

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

Formats the value using the given formatter.