Struct zvxryb_broadphase::LayerBuilder

pub struct LayerBuilder { /* fields omitted */ }

A builder for Layers

Methods

impl LayerBuilder

pub fn new() -> Self

pub fn with_min_depth(&mut self, depth: u32) -> &mut Self

Set a minimum depth for index generation.

This parameter is important for parallel processing. A higher value improves the partitioning of data and improves workload balancing. However, it can also create many more indices/object than is necessary. A setting which is too high may result in an excessive number of dynamic allocations and duplication of intermediate collision pairs, ultimately hurting worst-case performance.

A value of zero is the safest performance-wise for single-threaded operations.

When using multi-threaded methods, try a value that between log₄ number_of_processors (2D) or log₈ number_of_processors (3D) and −log₂(max_object_size/system_bounds_size)

It is generally better to set this too low than too high

pub fn with_index_capacity(&mut self, capacity: usize) -> &mut Self

Set an initial capacity for the index list.

pub fn with_collision_capacity(&mut self, capacity: usize) -> &mut Self

Set an initial capacity for the collision results list, used by Layer::scan.

pub fn with_test_capacity(&mut self, capacity: usize) -> &mut Self

Set an initial capacity for the test results list, used by Layer::test and Layer::pick.

pub fn build<Index, ID>(&self) -> Layer<Index, ID> where
    Index: SpatialIndex,
    ID: ObjectID,
    Bounds<Index::Point>: IndexGenerator<Index>, 

Trait Implementations

impl Default for LayerBuilder

fn default() -> LayerBuilder

Returns the "default value" for a type.