ParticleArray Interface Reference

Partition particles and performs range and nearest-neighbor searches. More...

#include <openvdb/tools/ParticleAtlas.h>

Detailed Description

Partition particles and performs range and nearest-neighbor searches.

Expected interface for the ParticleArray container:

template<typename VectorType>
struct ParticleArray
{
    // The type used to represent world-space positions
    using PosType = VectorType;
    using ScalarType = typename PosType::value_type;

    // Return the number of particles in the array
    size_t size() const;

    // Return the world-space position for the nth particle.
    void getPos(size_t n, PosType& xyz) const;

    // Return the world-space radius for the nth particle.
    void getRadius(size_t n, ScalarType& radius) const;
};

Constructs a collection of PointIndexGrids of different resolutions to accelerate spatial searches for particles with varying radius.