HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType > Struct Template Reference

#include <ParticleAtlas.h>

Classes

struct  Iterator
 Provides accelerated range and nearest-neighbor searches for particles that are partitioned using the ParticleAtlas. More...
 

Public Types

using Ptr = SharedPtr< ParticleAtlas >
 
using ConstPtr = SharedPtr< const ParticleAtlas >
 
using PointIndexGridPtr = typename PointIndexGridType::Ptr
 
using IndexType = typename PointIndexGridType::ValueType
 

Public Member Functions

 ParticleAtlas ()
 
template<typename ParticleArrayType >
void construct (const ParticleArrayType &particles, double minVoxelSize, size_t maxLevels=50)
 Partitions particle indices. More...
 
size_t levels () const
 Returns the number of resolution levels. More...
 
bool empty () const
 true if the container size is 0, false otherwise. More...
 
double minRadius (size_t n) const
 Returns minimum particle radius for level n. More...
 
double maxRadius (size_t n) const
 Returns maximum particle radius for level n. More...
 
PointIndexGridType & pointIndexGrid (size_t n)
 Returns the PointIndexGrid that represents the given level n. More...
 
const PointIndexGridType & pointIndexGrid (size_t n) const
 Returns the PointIndexGrid that represents the given level n. More...
 
template<typename ParticleArrayType >
ParticleAtlas
< PointIndexGridType >::Ptr 
create (const ParticleArrayType &particles, double minVoxelSize, size_t maxLevels)
 

Static Public Member Functions

template<typename ParticleArrayType >
static Ptr create (const ParticleArrayType &particles, double minVoxelSize, size_t maxLevels=50)
 Create a new ParticleAtlas from the given particles. More...
 

Detailed Description

template<typename PointIndexGridType = PointIndexGrid>
struct openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >

Definition at line 111 of file ParticleAtlas.h.

Member Typedef Documentation

template<typename PointIndexGridType = PointIndexGrid>
using openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::ConstPtr = SharedPtr<const ParticleAtlas>

Definition at line 114 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
using openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::IndexType = typename PointIndexGridType::ValueType

Definition at line 117 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
using openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::PointIndexGridPtr = typename PointIndexGridType::Ptr

Definition at line 116 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
using openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::Ptr = SharedPtr<ParticleAtlas>

Definition at line 113 of file ParticleAtlas.h.

Constructor & Destructor Documentation

template<typename PointIndexGridType = PointIndexGrid>
openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::ParticleAtlas ( )
inline

Definition at line 123 of file ParticleAtlas.h.

Member Function Documentation

template<typename PointIndexGridType >
template<typename ParticleArrayType >
void openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::construct ( const ParticleArrayType &  particles,
double  minVoxelSize,
size_t  maxLevels = 50 
)
inline

Partitions particle indices.

Parameters
particlescontainer conforming to the ParticleArray interface
minVoxelSizeminimum voxel size limit
maxLevelsmaximum number of resolution levels

Definition at line 716 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
template<typename ParticleArrayType >
static Ptr openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::create ( const ParticleArrayType &  particles,
double  minVoxelSize,
size_t  maxLevels = 50 
)
static

Create a new ParticleAtlas from the given particles.

Parameters
particlescontainer conforming to the ParticleArray interface
minVoxelSizeminimum voxel size limit
maxLevelsmaximum number of resolution levels
template<typename PointIndexGridType = PointIndexGrid>
template<typename ParticleArrayType >
ParticleAtlas<PointIndexGridType>::Ptr openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::create ( const ParticleArrayType &  particles,
double  minVoxelSize,
size_t  maxLevels 
)
inline

Definition at line 796 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
bool openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::empty ( void  ) const
inline

true if the container size is 0, false otherwise.

Definition at line 145 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
size_t openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::levels ( ) const
inline

Returns the number of resolution levels.

Definition at line 143 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
double openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::maxRadius ( size_t  n) const
inline

Returns maximum particle radius for level n.

Definition at line 150 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
double openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::minRadius ( size_t  n) const
inline

Returns minimum particle radius for level n.

Definition at line 148 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
PointIndexGridType& openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::pointIndexGrid ( size_t  n)
inline

Returns the PointIndexGrid that represents the given level n.

Definition at line 153 of file ParticleAtlas.h.

template<typename PointIndexGridType = PointIndexGrid>
const PointIndexGridType& openvdb::OPENVDB_VERSION_NAME::tools::ParticleAtlas< PointIndexGridType >::pointIndexGrid ( size_t  n) const
inline

Returns the PointIndexGrid that represents the given level n.

Definition at line 155 of file ParticleAtlas.h.


The documentation for this struct was generated from the following file: