Struct vox_geometry_rust::point_hash_grid_searcher3::PointHashGridSearcher3

pub struct PointHashGridSearcher3 { /* fields omitted */ }

Hash grid-based 3-D point searcher.

This class implements 3-D point searcher by using hash grid for its internal acceleration data structure. Each point is recorded to its corresponding bucket where the hashing function is 3-D grid mapping.

Implementations

impl PointHashGridSearcher3

pub fn new_default() -> PointHashGridSearcher3

pub fn new_vec(resolution: USize3, grid_spacing: f64) -> PointHashGridSearcher3

Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 3x or greater than search radius.

• parameter: resolution The resolution.
• parameter: grid_spacing The grid spacing.

pub fn new(
    resolution_x: usize,
    resolution_y: usize,
    resolution_z: usize,
    grid_spacing: f64
) -> PointHashGridSearcher3

\brief Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 3x or greater than search radius.

• parameter: resolution_x The resolution x.
• parameter: resolution_y The resolution y.
• parameter: grid_spacing The grid spacing.

pub fn builder() -> Builder

Returns builder fox PointHashGridSearcher3.

pub fn clone(&self) -> PointHashGridSearcher3Ptr

\brief Creates a new instance of the object with same properties than original.

\return Copy of this object.

pub fn set(&mut self, other: &PointHashGridSearcher3)

Copy from the other instance.

impl PointHashGridSearcher3

pub fn add(&mut self, point: Vector3D)

Adds a single point to the hash grid.

This function adds a single point to the hash grid for future queries. It can be used for a hash grid that is already built by calling function PointHashGridSearcher3::build.

• parameter: point The point to be added.

pub fn buckets(&self) -> &Vec<Vec<usize>>

Returns the internal bucket.

A bucket is a list of point indices that has same hash value. This function returns the (immutable) internal bucket structure.

\return List of buckets.

pub fn get_hash_key_from_bucket_index(&self, bucket_index: &ISize3) -> usize

Returns the hash value for given 3-D bucket index.

• parameter: bucket_index The bucket index.

\return The hash key from bucket index.

pub fn get_bucket_index(&self, position: &Vector3D) -> ISize3

Gets the bucket index from a point.

• parameter: position The position of the point.

\return The bucket index.

Trait Implementations

impl PointNeighborSearcher3 for PointHashGridSearcher3

fn type_name() -> String

Returns the type name of the derived class.

fn build(&mut self, points: &Vec<Vector3D>)

Builds internal acceleration structure for given points list.

fn for_each_nearby_point<Callback>(
    &self,
    origin: &Vector3D,
    radius: f64,
    callback: &mut Callback
) where
    Callback: ForEachNearbyPointFunc, 

Invokes the callback function for each nearby point around the origin within given radius.

fn has_nearby_point(&self, origin: &Vector3D, radius: f64) -> bool

Returns true if there are any nearby points for given origin within radius.